Custom Fields

List custom fields

List all of the authenticated user's custom field definitions (name, field_type, categories, ranking), ordered by ranking then name. `entity_type` picks contact fields (`contact`, the default), compan

GET /v2/custom-fields/

Parameters

Query parameters

select

object

entity_type

string enum required

Possible values: "contact", "company", "all"

Responses

200 — Successful response

Content-Type: application/json

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

data.custom_fields[].workspace_id

string (uuid) | null

data.custom_fields[].entity_type

string enum

Possible values: "contact", "company"

data.pagination

object

data.pagination.nextCursor

string | null

data.pagination.count

integer

Example

{
  "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/v2/custom-fields/?entity_type=contact' \
  --header 'Authorization: Bearer YOUR_API_KEY'

fetch('https://api.prod.getdex.com/v2/custom-fields/?entity_type=contact', {
  headers: {
    Authorization: 'Bearer YOUR_API_KEY'
  }
})

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

Add a reminder to many contacts

Create one reminder per contact for up to 500 contacts (`contact_ids`; duplicates are dropped), each linked to its one contact and sharing `reminder`'s `text`, `due_at_date`, `due_at_time` and `assign

Create a custom field

Create ONE custom field definition. Accepts `name`, `field_type` (`input` | `autocomplete` | `datepicker`; in a workspace also `teammate`, `multiselect`, `number`, `boolean`, `contact` and `company`,