Skip to the documentation
API

List and read connectors

The connectors the caller can reach, or one connector by its id.

GET/connectors

Runs any of 2 calls on your workspace.

GET /connectors

The connectors the caller can reach, or one connector by its id.

Example

Needs connectors:read. scope narrows the list to account or workspace, status to one state and app to one app by its slug. The list is not paged.

curl
curl "$OE/connectors?scope=workspace&status=active" -H "$AUTH"curl "$OE/connectors/cnr_5c1e9a7b3d2f48e6a0b4c7d1" -H "$AUTH"
Response
{  "object": "list",  "data": [{      "object": "connector",      "id": "cnr_5c1e9a7b3d2f48e6a0b4c7d1",      "scope": "workspace",      "app": "slack",      "appName": "Slack",      "appLogo": "https://logos.example.com/slack.png",      "label": "Sales Slack",      "status": "active",      "failure": null,      "pausedReason": null,      "access": "full",      "connectedAt": "2026-10-13T09:14:22.000Z",      "lastUsedAt": "2026-10-13T11:02:07.410Z",      "createdAt": "2026-10-13T09:12:44.000Z",      "updatedAt": "2026-10-13T09:20:05.000Z"    }]}

An API key lists workspace connectors only. An app a person connected also lists the connectors of that person, when it holds account:read.

Reading one connector reads it fresh. While it is pending this also checks whether the sign-in was finished, so it is the call to make after sending somebody to connectUrl.

failure says why an expired connector stopped working, and pausedReason why a paused one is held back.

A connector that does not exist, or that the caller cannot reach, answers 404 connector_not_found.

Reference