Skip to Content
Integrations

CRM sync

The health of the CRM sync.

Integrations1 endpointKen-Version: 2026-11-02AuthenticationWorkspacesErrors
MarkdownOpenAPI

Headers

The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.

NameInTypeRequiredDescription
Ken-Versionheaderstring, one of: 2026-11-02, 1.1optionalThe 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 date that is not a version answers 400 unsupported_version; any other value that is not a version is treated as legacy.
X-Ken-Workspace-Idheaderinteger (int64)optionalThe 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.

Get CRM sync health

GET/v1/crm-connections/{connectionId}/synccrm-sync.get
Permission
Accounts view
Rate limit
12,000 requests a minute per API key
Needs the ingestion feature on your workspace. Until it is on, calls answer 404.

Try it on developer.ken.so

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.

Parameters

NameInTypeRequiredDescription
connectionIdpathinteger (int64)requiredThe CRM connection's id.
Request
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"

Response 200

data is a CrmSyncHealth.

Show the 16 response fields and an example

The fields and an example are also on this endpoint's Markdown page.


On this page