Skip to main content
GET
Returns all connectors belonging to the organization associated with the API key.

Authorizations

Authorization
string
header
required

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

Query Parameters

provider
string

Filter by provider

Example:

"slack"

Response

OK

connector_limit
object

ConnectorLimit is present when the org has used its plan's connector allowance (Free: 3) and the caps mode enforces it: creating another connector is refused with 402. Connectors already past the allowance keep syncing; the limit applies to creating one. Absent otherwise, and sent with the health rollups only.

Example:
connectors
object[]
Example:
health
object

Health maps connector_id to its rollup (healthy | degraded | failed | checking | capped), present only when the caller asks for ?include=health. A connector missing from the map has an unknown rollup — its resources could not be read — which clients must not render as a failure. capped is not a rollup of the connector: it is overlaid on a healthy, degraded or checking one when the org is at a plan cap, and PlanCap says which.

plan_cap
object

PlanCap is present when the org is at a plan cap the caps mode enforces; every sync is skipped until the month resets or the plan changes.

Example: