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 List Contact Properties.

Authorizations

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

Query Parameters

boolean
Whether to include built-in reserved fields (email, firstName, lastName, createdAt, userId) in the response. Defaults to true.

Response

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