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. Returns `{ data: { custom_fields: [...] } }` — no pagination (users
GET /v2/custom-fields/
Parameters
Query parameters
select
object
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.pagination
object
data.pagination.nextCursor
string | null
data.pagination.count
integer
Example
{
"data": {
"custom_fields": [
{
"id": "00000000-0000-0000-0000-000000000000"
}
]
}
}
400
No response body.
401
No response body.
403
No response body.
404
No response body.
409
No response body.
429
No response body.
500
No response body.
Code samples
curl https://api.prod.getdex.com/v2/custom-fields/ \
--header 'Authorization: Bearer YOUR_API_KEY'
fetch('https://api.prod.getdex.com/v2/custom-fields/', {
headers: {
Authorization: 'Bearer YOUR_API_KEY'
}
})
requests.get(
"https://api.prod.getdex.com/v2/custom-fields/",
headers={
"Authorization": "Bearer YOUR_API_KEY"
}
)
Assign tags to contacts
Assign a set of existing tags to a set of contacts (the cartesian product). Body: `{ contactIds: [...], tagIds: [...] }`. **Requires `Idempotency-Key`.** Returns the bulk envelope `{ data: { affected
Create a custom field
Create ONE custom field definition. Accepts `name`, `field_type` (`input` | `autocomplete` | `datepicker`), and `categories` (autocomplete only, as `[{ category }]`). Ranking is assigned automatically