List Connector Types

List every knowledge-base connector type and the source configuration each accepts. Two properties of a config field decide how its value is sent and are not inferable from the rest: a field with multi: true stores a string[] rather than a string, and a canonicalParamId links a picker field to a manual-entry field that write the SAME configuration key — send exactly one of the pair, keyed by canonicalParamId rather than by the field's own id. The bounded set is returned in one page; nextCursor is always null.

GET/api/v2/connector-types

Authorization

apiKey
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

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.",
      "version": "1.0.0",
      "auth": {
        "mode": "oauth",
        "provider": "google-drive",
        "requiredScopes": [
          "https://www.googleapis.com/auth/drive.readonly"
        ]
      },
      "configFields": [
        {
          "id": "folderSelector",
          "title": "Folder",
          "type": "selector",
          "selectorKey": "google-drive-folder",
          "mimeType": "application/vnd.google-apps.folder",
          "mode": "basic",
          "canonicalParamId": "folderId",
          "required": true
        },
        {
          "id": "manualFolderId",
          "title": "Folder ID",
          "type": "short-input",
          "placeholder": "Enter the folder ID",
          "mode": "advanced",
          "canonicalParamId": "folderId"
        }
      ],
      "supportsIncrementalSync": true,
      "tagDefinitions": [
        {
          "id": "owner",
          "displayName": "Owner",
          "fieldType": "text"
        }
      ]
    }
  ],
  "nextCursor": null
}
{
  "error": {
    "code": "BAD_REQUEST",
    "message": "Invalid request"
  }
}
{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "API key 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