Sign in

v2

latestOpenAPI 3.0.02026-07-26365590.3 KB
Custom Fields

List custom fields

Returns a paginated list of custom fields scoped to the workspaces accessible by the API key. Each custom field has a stable slug (immutable) and a human-readable name (editable). Use the slug as the key when setting custom field values on contacts. Use the workspaceIds query parameter to narrow results to a subset of those workspaces.

get/v1/custom-fields

Query parameters

workspaceIdsstring
Example:550e8400-e29b-41d4-a716-446655440000,6ba7b810-9dad-11d1-80b4-00c04fd430c8

Workspace IDs to narrow down results. Must be a subset of the workspaces accessible by the API key. Omit to return data from every workspace in scope. Accepts either a comma-separated string (?workspaceIds=uuid1,uuid2) — the documented format — or repeated array params (?workspaceIds[]=uuid1&workspaceIds[]=uuid2).

pagenumber
Example:1

Page number (1-indexed)

limitnumber
Example:10

Number of items per page

searchstring
Example:job

Search query to filter custom fields by name

Response

Paginated list of custom fields

totalnumber required
pagenumber required
limitnumber required
totalPagesnumber required

Example response

{
  "data": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "name": "Job Title",
      "slug": "job_title"
    }
  ],
  "total": 100,
  "page": 1,
  "limit": 10,
  "totalPages": 10
}