List Connector Types

List knowledge-base connector types with opaque cursors, defaulting to 25 summaries per page: identifier, name, description, and auth mode. detail=full adds accepted source configuration fields. Fields with multi: true accept string[] instead of string. A canonicalParamId pairs a picker with manual entry for the same configuration key: send exactly one value, keyed by canonicalParamId rather than the field’s id.

OAuth scope: api:read.

GET/api/v2/connector-types

Authorization

X-API-Key<token>

Your Sim API key, personal or workspace-scoped. Generate one under Settings, then API Keys. Operations that reject workspace keys say so in their own description.

In: header

Query Parameters

workspaceId*string

Workspace whose integration allowlist, revealed preview blocks, and deployed custom blocks decide what this catalog contains.

Length1 <= length <= 128
search?string

Case-insensitive substring match against the connector name.

Length1 <= length <= 200
detail?string

Projection of each item. summary (the default) carries the identifier, name, description, and auth mode; full adds the version, the complete auth settings, the sourceConfig field schema, incremental-sync support, and tag definitions.

Default"summary"
Value in"summary" | "full"
limit?integer

Maximum connector types to return per page. Must be a whole number from 1 to 100. Defaults to 25.

Default25
Range1 <= value <= 100
cursor?string

Opaque cursor from the previous page. Send it back with the same sort and filters; only limit may change. Change anything else and pagination must restart without a cursor.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://www.sim.ai/api/v2/connector-types?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": [
    {
      "connectorType": "google_drive",
      "name": "Google Drive",
      "description": "Sync documents from a Google Drive folder.",
      "auth": {
        "mode": "oauth"
      }
    }
  ],
  "nextCursor": null
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication required"
  }
}
{
  "error": {
    "code": "FORBIDDEN",
    "message": "Insufficient workspace permissions",
    "details": {
      "code": "INSUFFICIENT_WORKSPACE_ROLE"
    }
  }
}
{
  "error": {
    "code": "NOT_FOUND",
    "message": "Not found"
  }
}
{
  "error": {
    "code": "RATE_LIMITED",
    "message": "API rate limit exceeded",
    "details": {
      "retryAfter": "2026-01-01T00:00:30.000Z"
    }
  }
}
{
  "error": {
    "code": "INTERNAL_ERROR",
    "message": "Internal server error"
  }
}
{
  "error": {
    "code": "SERVICE_UNAVAILABLE",
    "message": "Service temporarily unavailable"
  }
}
GETList BlocksGETList Tools