Custom fields.

GET/api/v1/contacts/fields

Browse API endpoints

Contacts / CRM REST API

Scope: contacts:read

Returns the list of custom field definitions configured for the sub-account.

Response:

Code example

{
  "data": [
    {
      "name": "preferred_language",
      "label": "Preferred Language",
      "type": "select",
      "options": ["English", "Spanish", "French"],
      "isRequired": false
    },
    {
      "name": "company_size",
      "label": "Company Size",
      "type": "number",
      "options": null,
      "isRequired": true
    }
  ]
}

Each field definition includes:

Field	Type	Description
`name`	string	Field key (used in `customFields` object on contacts)
`label`	string	Human-readable label
`type`	string	`text`, `number`, `select`, `date`, `boolean`, `url`, `email`, `phone`
`options`	string[]?	Available options (for `select` type only)
`isRequired`	boolean	Whether the field is required when creating/updating contacts

Loading endpoint details...

Build a request

Request example

Documented defaults and example values are ready. Change only the parameters you need.

Connection

Your CRM deployment URL

Replace the Bearer API key placeholder in the copied server-side code. No API key is entered or sent here.

Sub-account ID Agency keys onlyAgency-scoped keys require the X-Sub-Account-Id header.

cURL

curl --request GET \
  --url 'https://your-crm.example.com/api/v1/contacts/fields' \
  --header 'Authorization: Bearer <YOUR_API_KEY>'

This shows a static response from the documentation. It does not send a request to your CRM or use an API key.