Skip to main content
GET
/
custom-fields
/
{id}
Get a custom field
curl --request GET \
  --url https://api.reply.io/v3/custom-fields/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": 123,
  "title": "<string>",
  "fieldType": "<string>",
  "metadata": "<string>",
  "orgWide": true
}

Authorizations

X-API-Key
string
header
required

API key passed in the X-API-Key header

Path Parameters

id
integer
required

Custom field ID

Response

Custom field details retrieved successfully

id
integer
required

Custom field ID

title
string
required

Custom field name

fieldType
string
required

Custom field type

metadata
string | null

Optional metadata for the field (e.g., dropdown options)

orgWide
boolean

Whether the field is shared across the organization