CRM sync
The health of the CRM sync.
Sync health
GET
/v1/crm-connections/{connectionId}/synccrm-sync.getNeeds the ingestion feature on your workspace. Until it is on, calls answer 404.
Per object switch state and last inbound change, the outbound queue, Needs attention count and inbound backlog.
Parameters
Name
In
Type
Required
Description
connectionId
In: path
integer (int64)
required
Ken-Version
In: header
string, one of: 2026-11-02, 1.1
required
The API version: a dated version (YYYY-MM-DD), or 1.1, another name for the first dated version. Without it the request uses your API key's pinned version; an unpinned key reaches the legacy shape of the same path. 1.0 selects the legacy shape explicitly.
X-Ken-Workspace-Id
In: header
integer (int64)
optional
Workspace to act in. Required when your credential can reach more than one workspace (otherwise
400 workspace_required).Response 200
data is a CrmSyncHealthModel.
Field
Type
Description
connectionId
integer (int64)
status
string
pausedReason
string
lastError
string
lastErrorAt
string (date-time)
lastImportStartedAt
string (date-time)
lastImportCompletedAt
string (date-time)
importRunning
boolean
lastInboundAt
string (date-time)
lastOutboundAt
string (date-time)
objects
map of CrmSyncObjectHealthModel
queueDepth
integer (int32)
oldestPendingAt
string (date-time)
needsAttentionCount
integer (int32)
inboundBacklog
integer (int32)
owners
CrmRecordCountModel
Request
curl -X GET "https://api.ken.so/v1/crm-connections/812/sync" \ -H "Authorization: Bearer $KEN_API_KEY" \ -H "Ken-Version: 2026-11-02" \ -H "X-Ken-Workspace-Id: $KEN_WORKSPACE_ID"
Response 200
{
"success": true,
"data": {
"connectionId": 812,
"status": "string",
"pausedReason": "string",
"lastError": "string",
"lastErrorAt": "2026-09-23T15:02:11Z",
"lastImportStartedAt": "2026-09-23T15:02:11Z",
"lastImportCompletedAt": "2026-09-23T15:02:11Z",
"importRunning": true,
"lastInboundAt": "2026-09-23T15:02:11Z",
"lastOutboundAt": "2026-09-23T15:02:11Z",
"objects": {
"key": {
"enabled": true,
"enabledAt": "2026-09-23T15:02:11Z",
"lastInboundAt": "2026-09-23T15:02:11Z",
"lastOutboundAt": "2026-09-23T15:02:11Z",
"records": {
"total": 1,
"linked": 1
}
}
},
"queueDepth": 1,
"oldestPendingAt": "2026-09-23T15:02:11Z",
"needsAttentionCount": 1,
"inboundBacklog": 1,
"owners": {
"total": 1,
"linked": 1
}
}
}