Shipeasy
Flags experimentsApiOperations

List connectors

Returns every connector in the project as a bare array (no pagination envelope).

Returns every connector in the project as a bare array (no pagination envelope).

The encrypted credentials backing each connector are never serialised — only the connector's non-secret config, accountLabel, and last-attempt health (lastError, lastAttemptAt, lastSuccessAt) are returned.

Use case

Render the integrations/triggers settings page, or drive a CI check that asserts every github connector is enabled and last dispatched without error.

GET
/api/admin/connectors

Authorization

bearerSdkKey
AuthorizationBearer <token>

Pass an admin SDK key as Authorization: Bearer sdk_admin_…. Mint via POST /api/admin/keys with type: "admin".

In: header

Query Parameters

q?string

Case-insensitive substring filter across the resource's human-readable text columns (e.g. name, title, description). OR-matched across those columns; omit to return everything.

Lengthlength <= 100

Header Parameters

X-Project-Id?string

Project the request operates on. Optional — defaults to the project the SDK key belongs to; pass it only to scope a multi-project key (the generated client sets it once from its configuration, so per-call callers never thread it).

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://shipeasy.ai/api/admin/connectors"
[
  {
    "id": "9b0e7c2a-1f3d-4a8e-bf21-0c6a2e5d7f10",
    "projectId": "prj_01j7w7m9q4hxbf6npe6s9zr3vc",
    "provider": "github",
    "name": "Bugs → acme/app issues",
    "enabled": true,
    "events": [
      "bug.created"
    ],
    "config": {
      "owner": "acme",
      "repo": "app"
    },
    "accountLabel": "acme/app",
    "lastError": null,
    "lastAttemptAt": "2026-06-27T18:04:11.000Z",
    "lastSuccessAt": "2026-06-27T18:04:11.000Z",
    "createdAt": "2026-06-01T09:12:00.000Z",
    "updatedAt": "2026-06-27T18:04:11.000Z"
  },
  {
    "id": "2d44f0aa-9c81-4e6b-8a17-7b3e0f9c1a22",
    "projectId": "prj_01j7w7m9q4hxbf6npe6s9zr3vc",
    "provider": "claude_trigger",
    "name": "Nightly ops sweep",
    "enabled": true,
    "events": [],
    "config": {
      "routineId": "rtn_8fk20"
    },
    "accountLabel": "rtn_8fk20",
    "lastError": null,
    "lastAttemptAt": null,
    "lastSuccessAt": null,
    "createdAt": "2026-06-20T22:00:00.000Z",
    "updatedAt": "2026-06-20T22:00:00.000Z"
  }
]
{
  "error": "Malformed request (bad JSON, missing project scope).",
  "code": "BAD_REQUEST"
}
{
  "error": "Missing or invalid admin SDK key.",
  "code": "UNAUTHORIZED"
}

{
  "error": "Key is valid but not allowed to act on this project.",
  "code": "FORBIDDEN"
}

{
  "error": "The resource does not exist or is not visible to the caller.",
  "code": "NOT_FOUND"
}

{
  "error": "A resource with this name already exists in the project.",
  "code": "ALREADY_EXISTS"
}

{
  "error": "The request body failed structural (schema) validation.",
  "code": "VALIDATION"
}

Was this page helpful?
✎ Edit this page