Connections

List connections

With an API key: every connection across the tenant's applications (optional ?app_id= and ?status= filters). With an app-scoped widget JWT or a delegated agent token: the calling application's connections (app_id is ignored; the scope is fixed to that application). A connect-scoped widget JWT (an end user's) is refused with 403.

The response is paginated and always bounded. limit defaults to 500 and is clamped to 1000; next_cursor is present only when more rows remain. To read every connection, follow next_cursor until it is absent. Counting rows client-side is not required; see GET /connections:count.

A status outside the enum is rejected with 400 (it used to reach the database and surface as a 500).

A delegated agent token needs domains:read.

get/connections

Request

  • Base URL: https://api.customdomain.ai/v1
  • URL: https://api.customdomain.ai/v1/connections
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.customdomain.ai/oauth/agent/authorize, token URL https://api.customdomain.ai/oauth/agent/token, scopes: domains:read)

Query parameters

app_idstring
status'pending' | 'propagating' | 'live' | 'failed'
limitinteger

Rows per page. Defaults to 500; values above 1000 are clamped to 1000.

cursorstring

Opaque keyset cursor taken verbatim from a previous response's next_cursor. Omit for the first page.

Response

Connections

countinteger required

Rows in THIS page, not the tenant total.

next_cursorstring

Present only when further rows remain. Pass it back as ?cursor= to fetch the next page.

Changes

No recorded changes to this operation across all 1 revision of this API.