List workspace integrations

Updated:

GET/unified/workspaceintegration

Parameters

limitnumber
offsetnumber
updated_gtestring
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
sort enum
order enum
envstring default=Production
integration_typestring
Filter the results to just this integration
categoriesstring array
Filter the results on these categories
include_credentialsboolean default=false
Return the stored credentials in clear instead of masked. Requires a workspace admin.

Returns

idstring
created_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atdate-time
(ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
workspace_idstring
(reference to KmsSpace)
integration_typestring required
is_activeboolean required
api_urlstring
authorize_urlstring
token_urlstring
refresh_urlstring
base_urlstring
prompt_regionboolean
use_unified_redirectboolean
auth_type enum
Valid values:
"oauth2"
"other"
"token"
the authentication method to use for this workspace integration; when set, it overrides the default auth-method selection (e.g. force 'token' even when Unified OAUTH credentials exist)
environmentstring
authentication environment
categories enum array
Valid values:
"passthrough"
"hris"
"ats"
"auth"
"saml"
derived from permissions (plus the auth, passthrough and saml categories, which have no permissions)
permissions enum array
Valid values:
"accounting_account_read"
"accounting_account_write"
"accounting_transaction_read"
"accounting_transaction_write"
"accounting_journal_read"
the unified permission scopes enabled for this integration; requested when an authorization URL omits scopes
overriden_scopesobject
success_redirectstring
Post-OAuth success URL for marketplace installs (e.g. HighLevel). Used by /oauth/code/{workspace}/{env}/{integration}.
failure_redirectstring
Post-OAuth failure URL for marketplace installs. Used by /oauth/code/{workspace}/{env}/{integration}.
authobject
secretsmanager_idstring
the ID of the SecretsManager object
secretsmanager_keystring
the key/path/name of the secret within the vault

Errors

Errors return the HTTP status code and a JSON body with statusCode, error (the short label) and message (a human-readable detail).

{
  "statusCode": 429,
  "error": "Too Many Requests",
  "message": "Too many requests to unified.to API; max requests per minute: N"
}
StatusErrorMeaning
400Bad RequestThe request was malformed or failed validation.
401UnauthorizedThe connection is likely broken; re-authorize it.
403ForbiddenThe connection is missing permissions or scopes.
404Not FoundThe requested resource does not exist.
429Too Many RequestsRate limit exceeded (see the two sources below).
500Internal Server ErrorAn unexpected error occurred.
501Not ImplementedNot supported by this integration.

Errors from the underlying integration pass through: the integration's status comes back as ours (429, 401, 403, 404 or 5xx), usually with its message. When the integration's error body is unclear, Unified extracts what it can and returns a clearer message.

429 Too Many Requests

A 429 has two possible sources:

  • The integration's own rate limit, passed through.
  • Unified's workspace limit: a rolling 60 seconds, set by plan, with the message Too many requests to unified.to API; max requests per minute: N.
const options = {
  method: 'GET',
  url: 'https://api.unified.to/unified/workspaceintegration',
  headers: {
    authorization: 'bearer .....'
  },
  params: {
    limit: 50,
    offset: 0,
    updated_gte: '2026-01-01T00:00:00.000Z',
    sort: 'updated_at',
    order: 'asc',
    env: 'Production',
    integration_type: '',
    categories: ['crm'],
    include_credentials: false,
  }
};

const results = await axios.request(options);
Are we missing anything? Let us know
Was this page helpful?