Skip to main content
GET
Asks the provider which resources the connector’s stored credentials can reach: channels, repositories, databases, tables, folders and so on. Call it before Configure Connector to decide what to sync. Pass an entry’s id as resource_id, together with its resource_type and name, to Configure. Providers that sync a whole account rather than individual resources return a single entry with id all and resource_type workspace. Configure that one entry to sync everything. For providers with many resources, page through the list with limit (1 to 100) and cursor, and keep going while has_more is true.

Errors

  • 404: no connector with this id in your workspace.
  • 422: the stored credentials are no longer valid. Replace them with Update Connector.
  • 400 or 502: the provider rejected the request or could not be reached. The message carries the provider’s explanation.

Authorizations

Authorization
string
header
required

API key sent as a Bearer token: "Bearer prefix.secret"

Path Parameters

id
string
required

Connector ID

Example:

"HydraDoc1234"

Query Parameters

cursor
string

Opaque pagination cursor from a previous response's next_cursor

limit
integer

Max resources per page, 1-100 (values above 100 are clamped)

Response

OK

has_more
boolean

Present and true when more pages remain. Only on paginated requests (limit or cursor); fetch the next page with next_cursor.

Example:

true

next_cursor
string

Opaque pagination cursor for the next page; null or absent when no more pages.

Example:

"eyJvZmZzZXQiOjUwfQ=="

provider
string

External provider being synced (e.g. slack, github, linear, notion, gmail).

Example:

"slack"

resources
object[]

Resources available to the connector's credentials. Pass an entry's id (as resource_id) and resource_type to Configure.

Example: