Skip to Content
Integrations

CRM fields

The fields your CRM exposes.

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.

List CRM fields

GET/v1/crm-connections/{connectionId}/fieldscrm-fields.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

Lists the fields of one CRM object, to build field mappings. Kenso caches the list for 10 minutes. The fields Kenso creates in the CRM when sync turns on are listed with exists false until they exist.

Errors:

  • 400 validation_failed: objectType is missing, or is not company, contact or deal.
  • 403 forbidden: the CRM refused this read. Check that the CRM user Kenso connected as can read it.
  • 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 right now. Try again later.

Requires Accounts view.

Parameters

NameInTypeRequiredDescription
connectionIdpathinteger (int64)requiredThe CRM connection's id.
objectTypequerystringoptionalRequired. The CRM object: company, contact or deal.
limitqueryinteger (int32)optionalItems per page, from 1 to 200. Omit limit and cursor to get every item in one response, as before; with only cursor, 50 per page.
cursorquerystringoptionalThe nextCursor of the previous page. Omit it for the first page.
Request
curl -X GET "https://api.ken.so/v1/crm-connections/812/fields?limit=1" \
  -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 list of CrmField. Each item has these fields. The response also carries pagination.

Show the 9 response fields and an example

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


On this page