Sign in

v2

latestOpenAPI 3.0.02026-07-26365590.3 KB
Custom Fields

Get a custom field

Returns a single custom field by ID. Returns 404 if the custom field is in a workspace outside the API key scope.

get/v1/custom-fields/{id}

Path parameters

idstring required

Response

The custom field

idstring required
namestring required

Human-readable label. Can be renamed without breaking integrations.

slugstring required

Stable, immutable identifier derived from the name at creation time. Use this as the key when setting custom field values on a contact via POST/PATCH /contacts.

createdAtstring date-time required
updatedAtstring date-time required

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "name": "Job Title",
  "slug": "job_title"
}