Read a connection with its per-object sync state
Returns the connection together with the state of each provider object type it can mirror — whether the object is enabled and how its fields map onto native fields. Requires the `integrations:read` workspace permission; credentials are not included.
Authorization
apiKey Workspace API key created in Workspace settings → API keys. Scopes on the key bound what it can read and write.
In: header
Path Parameters
Response Body
application/json
application/json
application/json
curl -X GET "https://example.com/v1/workspaces/string/integrations/connections/string/detail"{ "data": { "connection": { "id": "string", "workspaceId": "string", "provider": "string", "key": "string", "label": "string", "enabled": true, "authKind": "api_key", "hasSecret": true, "externalAccountId": "string", "health": "unknown", "consecutiveFailures": 0, "lastSuccessfulSyncAt": "string", "lastFailureAt": "string", "lastError": "string", "nextSyncAt": "string", "manifest": {}, "createdByUserId": "string", "createdAt": "string", "updatedAt": "string" }, "provider": { "provider": "string", "label": "string", "category": "string", "authKinds": [ "api_key" ], "capabilities": [ "string" ], "installKind": "github_app", "enabled": true, "configured": true, "installFields": [ { "key": "string", "label": "string", "required": true, "placeholder": "string" } ], "docsUrl": "string", "experience": "deep" }, "objects": [ { "objectKey": "string", "label": "string", "enabled": true, "databaseId": "string", "fields": [ { "key": "string", "label": "string", "kind": "text", "excluded": true } ], "lastSnapshotAt": "string", "lastRunAt": "string", "nextRunAt": "string", "failureCount": 0, "fieldMappings": [ { "key": "string", "label": "string", "kind": "text", "excluded": true, "options": [ { "key": "string", "name": "string", "color": "string" } ] } ] } ], "recentRuns": [ { "id": "string", "workspaceId": "string", "connectionId": "string", "dataSourceId": "string", "provider": "string", "status": "running", "trigger": "string", "cursorBefore": "string", "cursorAfter": "string", "stats": {}, "error": "string", "startedAt": "string", "completedAt": "string" } ], "grantedScopes": [ "string" ] }}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}{ "_tag": "ApiNotFound", "error": "not_found", "message": "That item does not exist, or this key cannot see it.", "status": 404}Delete an integration connection
Removes the connection and its stored credentials, returning the deleted id. Requires the `integrations:write` workspace permission; use the disconnect preview first to see what depends on it. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.
Update the sync state of one provider object type
Enables or disables a single provider object type on a connection and replaces its field mappings, returning the refreshed connection detail. Requires the `integrations:write` workspace permission. Send an `Idempotency-Key` header to make retries safe; a replay within the window returns the original response.