Custom field details

Custom Field attributes

• handle (string) - The key for a contact resource, e.g. custom_1, custom_2, custom_3
• title (string) - The title of the custom field
• type (string) - The type of the custom field
• required (boolean) - Whether the custom field is required
• archived (boolean) - Whether the custom field is archived

Sparse Fields

Use the fields[custom_fields] parameter to include only specific attributes:

Include only handle and title fields

• GET /v1/custom_fields/123?fields[custom_fields]=handle,title

Response will include only the specified fields

{
  "data": {
    "id": "123",
    "type": "custom_fields",
    "attributes": {
      "handle": "custom_1",
      "title": "Favorite Song"
    }
  }
}