> 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-fields/openapi.json](/docs/api/crm-fields/openapi.json). CLI docs offline: `kenso docs <topic>`.
> Last updated: 2026-11-22.

# CRM fields: List CRM fields

> **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 fields](/docs/api/crm-fields.md). Authentication, workspaces and errors: [/docs.md](/docs.md).

## List CRM fields

`GET /v1/crm-connections/{connectionId}/fields` - operationId `crm-fields.list`

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

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.

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/fields)

### Parameters

| Name | In | Type | Required | Description |
| --- | --- | --- | --- | --- |
| `connectionId` | path | integer (int64) | yes | The CRM connection's id. |
| `objectType` | query | string | no | Required. The CRM object: `company`, `contact` or `deal`. |
| `limit` | query | integer (int32) | no | Items 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. |
| `cursor` | query | string | no | The `nextCursor` of the previous page. Omit it for the first page. |
| `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 list of `CrmField`. Each item has these fields. The response also carries `pagination`.

| Field | Type | Description |
| --- | --- | --- |
| `apiName` | string | The field's API name in the CRM. |
| `label` | string | The field's label in the CRM. |
| `dataType` | string | The value type: `string`, `number`, `date`, `datetime`, `boolean`, `enum`, `reference`, `email`, `phone` or `url`. |
| `isCustom` | boolean | True for a custom field rather than one the CRM ships with. |
| `isReadOnly` | boolean | True when the CRM does not let Kenso write the field. |
| `isRequiredOnCreate` | boolean | True when the CRM needs a value for the field to create a record. |
| `options` | array of CrmPicklistOption | The allowed values of a picklist field. Omitted for other fields. |
| `isKenField` | boolean | True for one of Kenso's own custom fields. |
| `exists` | boolean | False for a Kenso field the CRM does not have yet. Kenso creates it when sync turns on. |

### Request

```bash
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"
```

### Example response

```json
{
  "success": true,
  "data": [
    {
      "apiName": "string",
      "label": "string",
      "dataType": "string",
      "isCustom": true,
      "isReadOnly": true,
      "isRequiredOnCreate": true,
      "options": [
        {
          "value": "string",
          "label": "string"
        }
      ],
      "isKenField": true,
      "exists": true
    }
  ],
  "pagination": {
    "nextCursor": "eyJpZCI6ODE1fQ",
    "hasMore": true,
    "total": 1,
    "totalCount": 1,
    "isTotalCapped": true
  }
}
```

## Types

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

### CrmPicklistOption

One allowed value of a picklist field.

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `value` | string | no | The value the CRM stores. |
| `label` | string | no | The value's label in the CRM. |
