Custom Fields

List custom fields

Retrieve all custom field definitions for the authenticated user. Custom fields allow you to add structured data to contacts beyond the built-in fields.

GET /v1/custom-fields/

Parameters

Query parameters

select

object

Responses

200 — Successful response

Content-Type: application/json

error

boolean required

data

object required

data.custom_fields

array<object> required

data.custom_fields[].id

string (uuid) required

data.custom_fields[].user_id

string

data.custom_fields[].name

string

data.custom_fields[].field_type

string

data.custom_fields[].categories

array<string>

data.custom_fields[].ranking

integer | null

Example

{
  "error": false,
  "data": {
    "custom_fields": [
      {
        "id": "00000000-0000-0000-0000-000000000000"
      }
    ]
  }
}

400 — Request body failed validation.

Content-Type: application/json

(body)

any

401 — Missing or invalid API key.

Content-Type: application/json

(body)

any

403 — Valid key, insufficient permission.

Content-Type: application/json

(body)

any

404 — Resource does not exist.

Content-Type: application/json

(body)

any

409 — Request conflicts with the current state of the resource.

Content-Type: application/json

(body)

any

429 — Rate limit exceeded.

Content-Type: application/json

(body)

any

500 — Unexpected server error.

Content-Type: application/json

(body)

any

Code samples

curl https://api.prod.getdex.com/v1/custom-fields/ \
  --header 'Authorization: Bearer YOUR_API_KEY'

fetch('https://api.prod.getdex.com/v1/custom-fields/', {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

requests.get(
    "https://api.prod.getdex.com/v1/custom-fields/",
    headers={
      "Authorization": "Bearer YOUR_API_KEY"
    }
)

Count contacts

Return the total number of contacts for the authenticated user. Useful for displaying counts in dashboards without fetching full contact records.

Create a custom field

Create a new custom field definition. Once created, the field can be set on any contact to store additional structured data.