Skip to Content
Integrations

CRM field mappings

How Kenso fields map to your CRM's fields.

Integrations2 endpointsKen-Version: 2026-11-02AuthenticationWorkspacesErrors
MarkdownOpenAPI

Path parameters

The endpoints whose path names one of these take it as described here. An endpoint's own table lists a path parameter only when it describes it differently.

NameInTypeRequiredDescription
connectionIdpathinteger (int64)requiredThe CRM connection's id.

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.

List field mappings

GET/v1/crm-connections/{connectionId}/field-mappingscrm-field-mappings.list
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 which Kenso field syncs to which CRM field, and in which direction. It also lists the Kenso fields a mapping can use. It also answers for a disconnected connection.

Errors:

  • 400 validation_failed: objectType is not company, contact or deal.
  • 404 not_found: the workspace has no connection with this id.

Requires Accounts view.

Parameters

NameInTypeRequiredDescription
objectTypequerystringoptionalThe CRM object: company, contact or deal. Omit it for all three.
Request
curl -X GET "https://api.ken.so/v1/crm-connections/812/field-mappings" \
  -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 CrmFieldMap.

Show the 2 response fields and an example

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

Replace field mappings

PUT/v1/crm-connections/{connectionId}/field-mappingscrm-field-mappings.replace
Permission
Accounts view and the integrations permission
Rate limit
4,800 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

Replaces every mapping of one CRM object with the list you send. Send an empty mappings list to remove them all. Each object takes at most 100 mappings.

Kenso checks each mapping against the CRM's fields and the Kenso fields from GET /v1/crm-connections/{connectionId}/field-mappings. Each Kenso field and each CRM field appears once. A read-only CRM field takes only direction crm. A Kenso field with a fixedDirection takes only that direction. Kenso creates its own fields in the CRM: those take only the Kenso fields whose keys start with ken., and those Kenso fields map only to them.

Errors:

  • 400 validation_failed: a mapping breaks one of these rules, or the CRM cannot sync this object. error.details names each mapping by its index.
  • 403 forbidden: the CRM refused to list its fields. Check that the CRM user Kenso connected as can read them.
  • 404 not_found: the workspace has no connection with this id.
  • 409 needs_reconnect: the CRM refused Kenso's access. Reconnect the CRM first.
  • 409 invalid_state: the connection is disconnected.
  • 429 rate_limited: the CRM's rate limit is reached. Retry after Retry-After.
  • 503 crm_unavailable: the CRM cannot be reached to read its fields. Try again later.

Requires Accounts view and the integrations permission.

Request body

application/json, optional.

FieldTypeRequiredDescription
objectTypestringrequiredRequired. The CRM object: company, contact or deal.
mappingsarray of CrmFieldMappingBodyoptionalReplaces every mapping of the object, at most 100. An empty list removes them all.
Request
curl -X PUT "https://api.ken.so/v1/crm-connections/812/field-mappings" \
  -H "Authorization: Bearer $KENSO_API_KEY" \
  -H "Ken-Version: 2026-11-02" \
  -H "X-Ken-Workspace-Id: $KENSO_WORKSPACE_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "objectType": "company",
  "mappings": [
    {
      "kenField": "string",
      "crmField": "string",
      "direction": "ken",
      "isEnabled": true
    }
  ]
}'

Response 200

data is a CrmFieldMap.

Show the 2 response fields and an example

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


On this page