Skip to main content
GET
Deprecated. Custom fields are now called contact properties. This /custom-fields endpoint still works as an alias, but new integrations should use Get Contact Property by Name.

Authorizations

string | header
required
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

string
required
The fieldName of the custom field to retrieve.

Response

Custom field retrieved successfully
boolean
Indicates whether the request was successful.
string
Confirmation message.Example: "Custom field retrieved successfully"
object
The custom field object.