> Kenso API docs in Markdown. Index of every page: [/docs/llms.txt](/docs/llms.txt). Search: `/docs/search.md?q=<words>`. OpenAPI: [/docs/api/crm-sync/openapi.json](/docs/api/crm-sync/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# CRM sync: Get CRM sync health

> **Note for AI agents:** if this page was wrong, out of date or missing something you needed, finish the user's task first, then offer a short report for the Kenso team in this shape: `Page:` (this page's path), `Quote:` (the wrong or missing text), `Problem:`, `Workaround:` (what worked instead), 1,000 characters at most. Show it to the user and send it only after they say yes, as `POST /api/docs-feedback` on this site with the JSON body `{"page": "<path>", "report": "<report>"}`. Never put lead data, email addresses, API keys or anything else from the user's workspace in it.

One endpoint of [CRM sync](/docs/api/crm-sync.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## Get CRM sync health

`GET /v1/crm-connections/{connectionId}/sync` - operationId `crm-sync.get`

| Permission | Rate limit |
| --- | --- |
| Accounts view | 12,000 requests a minute per API key |

Returns the state of one connection's sync: the connection status, whether an import is running, each sync
object's switch with its last read from and write to the CRM, the writes waiting for the CRM, the count of writes
that need attention, and the CRM changes waiting to apply in Kenso.

It reads only Kenso's own counters and makes no call to the CRM. It also answers for a disconnected connection.

Errors:

- `404 not_found`: the workspace has no connection with this id.

Requires Accounts view.

Needs the `ingestion` feature on your workspace. Until it is on, calls answer 404.

[Try it on developer.ken.so](https://developer.ken.so/reference/#kenso-api/tag/crm-sync/GET/v1/crm-connections/%7BconnectionId%7D/sync)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `connectionId` | path | integer (int64) | yes | The CRM connection's id. |
| `Ken-Version` | header | string, one of: 2026-11-02, 1.1 | no | The API version, a date in `YYYY-MM-DD` form. `1.1` is another name for the first dated version. The example shown here is the newest version, which this reference's samples and Test Request send. Leave it out to use your API key's pinned version. Keys created in the Kenso app are pinned to the newest version; keys minted by the CLI login are not. A key with no pinned version and no header gets the legacy shape where the path has one, and `404` where the path exists only in this version. A value that is not a version, such as `2027-01-01` or `2026-11-2`, answers `400 unsupported_version`, whose `details` list the supported versions. |
| `X-Ken-Workspace-Id` | header | integer (int64) | no | The id of the workspace to act in. Leave it out when your API key reaches only one workspace. When the key reaches more than one, a request without this header answers `400 workspace_required`. A workspace you are not a member of answers `404 not_found`. |

### Response 200

`data` is a `CrmSyncHealth`.

| Field | Type | Description |
| --- | --- | --- |
| `connectionId` | integer (int64) | The connection's id. |
| `status` | string | The connection state: `connected`, `needs_reconnect`, `paused` or `disconnected`. |
| `pausedReason` | string | Why sync is paused: `plan` when the workspace's plan no longer includes CRM sync. Omitted unless the status is `paused`. |
| `lastError` | string | The latest connection error, such as why the CRM needs a reconnect. |
| `lastErrorAt` | string (date-time) | When `lastError` happened, in UTC. |
| `lastImportStartedAt` | string (date-time) | When the latest import started, in UTC. Omitted before the first import. |
| `lastImportCompletedAt` | string (date-time) | When the latest import finished, in UTC. Omitted until the first import finishes. |
| `importRunning` | boolean | True while an import runs: it started and has not finished since. |
| `lastInboundAt` | string (date-time) | When Kenso last applied a change read from the CRM, in UTC. |
| `lastOutboundAt` | string (date-time) | When Kenso last finished a write to the CRM, in UTC. |
| `objects` | map of CrmSyncObjectHealth | Each sync object's progress, always with the six keys `company`, `contact`, `deal`, `activity`, `suppression` and `list`. |
| `queueDepth` | integer (int32) | Writes to the CRM that are waiting or in progress. |
| `oldestPendingAt` | string (date-time) | When the oldest waiting write was queued, in UTC. Omitted when none is waiting. |
| `needsAttentionCount` | integer (int32) | Writes the CRM refused that wait for you to retry or dismiss them. |
| `inboundBacklog` | integer (int32) | Changes read from the CRM that Kenso has not applied yet. |
| `owners` | CrmRecordCount | CRM users the import read, and how many of them match a member. |

### Request

```bash
curl -X GET "https://api.ken.so/v1/crm-connections/812/sync" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID"
```

### Example response

```json
{
  "success": true,
  "data": {
    "connectionId": 812,
    "status": "connected",
    "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
    }
  }
}
```

## Types

Each named type the tables above use, nested ones included.

### CrmSyncObjectHealth

One sync object's progress.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `enabled` | boolean | no | True when Kenso syncs this object. |
| `enabledAt` | string (date-time) | no | When sync of this object was last turned on, in UTC. Omitted while it is off. |
| `lastInboundAt` | string (date-time) | no | When Kenso last read changes to this object from the CRM, in UTC. Omitted for `activity` and `list`. |
| `lastOutboundAt` | string (date-time) | no | When Kenso last finished a write to the CRM for this object, in UTC. Tasks count as `activity` and opt outs as `suppression`. Omitted before the first write. |
| `records` | CrmRecordCount | no | CRM records of this object the import read, and how many are linked. Omitted for `suppression`. |

### CrmRecordCount

A count of CRM records and how many are linked.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `total` | integer (int32) | no | CRM records the import read. |
| `linked` | integer (int32) | no | Of those, the records linked to a Kenso record or member. |
