v58

latestOpenAPI 3.0.0raw.githubusercontent.com2026-08-073053701.0 MB
Reach: Contact Fields

List contact fields

Get the custom contact fields defined in a profile.

Custom fields let you store your own attributes on contacts. The returned uuids are what you pass to the contact update endpoint to set values, and choice fields also list the options available to pick from.

get/api/reach/v1/profiles/{profileUuid}/contacts/fields

Path parameters

profileUuidstring required
Example:550e8400-e09b-41d4-a716-400055000000

Profile uuid parameter

Response

Success response

uuidstring
type'text' | 'number' | 'date' | 'single_choice' | 'multi_choice'
labelstring
slugstring

Derived from the label on creation and immutable afterwards

created_atstring date-time

Example response

[
  {
    "uuid": "550e8400-e29b-41d4-a716-446655440000",
    "type": "text",
    "label": "Job title",
    "slug": "job_title",
    "options": [
      {
        "uuid": "550e8400-e29b-41d4-a716-446655440000",
        "label": "Gold"
      }
    ],
    "created_at": "2025-02-27T11:54:22Z"
  }
]