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

Authorizations

​
Authorization
string
header
required

Authenticate every request with a Bearer token. Pass your Reply API key in the Authorization header:

Authorization: Bearer <your-api-key>

Get your API key from the Reply dashboard: Settings → API Key.

Path Parameters

​
id
integer
required

Custom field ID

Response

Custom field details retrieved successfully

​
id
integer
read-only

Custom field ID

​
title
string

Custom field name

​
fieldType
enum<string>

Custom field type

Available options:
text,
number
​
metadata
string | null

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

​
orgWide
boolean

Whether the field is shared across the organization