Skip to main content
GET
list-connections

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer

Maximum number of items to return (1-1000)

Required range: 1 <= x <= 1000
cursor
string

Pagination cursor from a previous response

Text search query to filter results

includeArchived
boolean
tenantId
string
connectorId
string

Filter by connector ID

externalAppId
string
status
enum<string>

Filter by lifecycle status. broken needs attention; disconnected covers both never-connected and user-disconnected connections.

Available options:
connected,
broken,
disconnecting,
disconnected
connected
boolean
connectorVersion
string
integrationKey
string
buildingAgentSessionId
string

Find the connection bound to this agent session as the session building it.

Response

200 - application/json

List the workspace’s connections — each is a live link to a tenant’s account in an external app (the source of records you can visualize). Filter by integrationId or connectorId.

items
object[]
required
cursor
string