Custom Fields

List all custom fields defined in your account via the API.

Custom Fields API

Read custom field definitions. Requires an API token with the custom_fields.view ability.

List Custom Fields

GET /api/v1/custom-fields — Permission: custom_fields.view

Query Parameters

Parameter	Type	Required	Description
`entity_type`	string	No	Filter by entity type (e.g., `contacts`)
`per_page`	integer	No	Results per page, 1–100 (default: 25)

Example Request

curl -X GET "https://your-domain.com/api/v1/custom-fields?entity_type=contacts" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Accept: application/json"

const response = await fetch("https://your-domain.com/api/v1/custom-fields?entity_type=contacts", {
  headers: {
    "Authorization": "Bearer YOUR_API_TOKEN",
    "Accept": "application/json"
  }
});
const data = await response.json();

$ch = curl_init("https://your-domain.com/api/v1/custom-fields?entity_type=contacts");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer YOUR_API_TOKEN",
        "Accept: application/json",
    ],
]);
$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);

import requests

response = requests.get(
    "https://your-domain.com/api/v1/custom-fields?entity_type=contacts",
    headers={
        "Authorization": "Bearer YOUR_API_TOKEN",
        "Accept": "application/json"
    }
)
data = response.json()

Example Response

{
  "data": [
    {
      "id": 1,
      "name": "Company",
      "key": "company",
      "type": "text",
      "entity_type": "contacts",
      "is_required": false,
      "position": 0,
      "options": null
    },
    {
      "id": 2,
      "name": "Industry",
      "key": "industry",
      "type": "select",
      "entity_type": "contacts",
      "is_required": false,
      "position": 1,
      "options": ["Technology", "Finance", "Healthcare", "Education"]
    }
  ],
  "meta": { "current_page": 1, "last_page": 1, "per_page": 25, "total": 2 },
  "links": { "first": "...", "last": "...", "prev": null, "next": null }
}

Field Types

Type	Description
`text`	Single-line text input
`textarea`	Multi-line text input
`number`	Numeric value
`date`	Date picker
`select`	Dropdown with predefined options
`multiselect`	Multiple selections from options
`checkbox`	Boolean toggle
`email`	Email address
`phone`	Phone number
`url`	URL
`relationship`	Link to another entity record

Was this article helpful?