Skip to main content
GET
/
v1
/
connector-instances
List connector instances
curl --request GET \
  --url https://api.openworklabs.com/v1/connector-instances
{
  "items": [
    {
      "id": "<string>",
      "organizationId": "<string>",
      "connectorAccountId": "<string>",
      "connectorType": "github",
      "remoteId": "<string>",
      "name": "<string>",
      "status": "active",
      "instanceConfigJson": {},
      "lastSyncedAt": "2023-11-07T05:31:56Z",
      "lastSyncStatus": "pending",
      "lastSyncCursor": "<string>",
      "createdByOrgMembershipId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "nextCursor": "<string>"
}

Query Parameters

cursor
string
Required string length: 1 - 255
limit
integer
Required range: 1 <= x <= 100
connectorAccountId
string<typeid>

Den TypeID with 'cac_' prefix and a 26-character base32 suffix.

Required string length: 30
Pattern: ^cac_.*
connectorType
enum<string>
Available options:
github
pluginId
string<typeid>

Den TypeID with 'plg_' prefix and a 26-character base32 suffix.

Required string length: 30
Pattern: ^plg_.*
status
enum<string>
Available options:
active,
disabled,
archived,
error
q
string
Required string length: 1 - 255

Response

Connector instances returned successfully.

items
object[]
required
nextCursor
string | null
required
Required string length: 1 - 255