Contact fields
The contact fields available for columns, CSV export and CSV import.
Headers
The endpoints on this page take these headers. Each endpoint's curl shows the ones it sends.
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Ken-Version | header | string, one of: 2026-11-02, 1.1 | optional | 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 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-Id | header | integer (int64) | optional | 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. |
List contact fields
/v1/contact-fieldscontact-fields.list- Permission
- Campaigns view
- Rate limit
- 12,000 requests a minute per API key
Lists every contact field in a fixed order, with its key, label, value type and usages. A field's usages says where it works: list (a column of the contact list), export (a column of a contact export) and import (a target for a CSV column in a contact import).
A few fields appear only when the workspace has a feature. securityGateway and mailboxProvider need the security_gateways feature on the workspace. customImage needs the campaign_images feature, and customVideo needs both the campaign_videos and campaign_images features.
Errors:
400 validation_failed:limitis not from 1 to 200, orcursoris invalid or points past the last page.
Requires Campaigns view.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
limit | query | integer (int32) | optional | Fields per page, from 1 to 200. Default 50. |
cursor | query | string | optional | The nextCursor of the previous page. Omitted starts at the first page. |
curl -X GET "https://api.ken.so/v1/contact-fields?limit=50" \
-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 ContactField. Each item has these fields. The response also carries pagination.
Show the 6 response fields and an example
The fields and an example are also on this endpoint's Markdown page.
More in Contacts and companies:ContactsContact importsContact exportsTagsBlocklistBlocklist rulesCompaniesCompany dataContact behaviorAll resources