Get Knowledge Connector

Retrieve one connector and its ten most recent synchronization attempts. Stored API keys and encrypted secret material are never returned. A workspace API key is rejected with 403; use a personal API key.

GET/api/v2/knowledge/{id}/connectors/{connectorId}

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

Path Parameters

id*string

Knowledge base that owns the connector.

Length1 <= length
connectorId*string

Connector selected for the operation.

Length1 <= length

Query Parameters

workspaceId*string

Workspace that owns the knowledge base.

Length1 <= length <= 128

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/knowledge/string/connectors/string?workspaceId=string" \  -H "X-API-Key: YOUR_API_KEY"
{
  "data": {
    "id": "kc-9f8e7d6c",
    "knowledgeBaseId": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "connectorType": "notion",
    "credentialId": "cred-4b3a2c1d",
    "sourceConfig": {
      "pageIds": [
        "page-123"
      ]
    },
    "syncMode": "full",
    "syncIntervalMinutes": 1440,
    "status": "active",
    "lastSyncAt": "2026-06-20T14:02:11.000Z",
    "lastSyncError": null,
    "lastSyncDocCount": 42,
    "nextSyncAt": "2026-06-21T14:02:11.000Z",
    "consecutiveFailures": 0,
    "createdAt": "2026-06-01T09:14:00.000Z",
    "updatedAt": "2026-06-20T14:02:11.000Z",
    "syncLogs": []
  }
}
{
  "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"
  }
}
GETGet Knowledge BaseGETGet Document