Sign in
Sync

Every integration kind this workspace could connect, joined against existing connections

Changed on
get/workspaces/{workspaceSlug}/connections/catalog

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /workspaces/{workspaceSlug}/connections/catalog
  • Auth: HTTP bearer

Path parameters

workspaceSlugstring required

Workspace slug

Response

OK

connectedboolean required

Whether this workspace has a (non-UNINSTALLED) connection for this kind

connectionIdinteger

Connection id, if connected

connectionState'PENDING' | 'ACTIVE' | 'SUSPENDED' | 'UNINSTALLED'

Connection state, if connected

credentialsUnreadableSincestring date-time

When the stored credential was first found unreadable with the server's keys; absent while it reads

displayNamestring required

Human-readable display name

kind'GITHUB' | 'GITLAB' | 'SLACK' | 'OUTLINE' required

Integration kind

Changes

  • 9662502b2cc4Revision changes
    • breaking

      for the path request parameter workspaceSlug, the minLength was increased from 0 to 3

    • warning

      for the path request parameter workspaceSlug, the maxLength was set to 51

    • warning

      changed the pattern of the path request parameter workspaceSlug from ^[a-z0-9][a-z0-9-]{2,50}$ to ^(?!.*--)[a-z0-9][a-z0-9-]{1,49}[a-z0-9]$