Skip to main content
GET
List Contact Custom Fields
Retrieves all custom field definitions registered for contacts in your workspace.
Custom-field metadata endpoints do not paginate; they always return the full list of defined fields for this resource type.

Required permissions

Requires an API key with the crm:read scope.

Authorizations

x-api-key
string
header
required

Workspace API key header. The key implicitly determines your workspace isolation. Scopes: crm:read for GET/HEAD/OPTIONS, crm:write for POST/PATCH/PUT/DELETE.

Response

Contact custom fields retrieved successfully

Standard envelope returned by all GET (read) endpoints

status
string
required
Example:

"success"

code
integer
required
Example:

200

message
string
required
Example:

"Integrations public retrieved successfully"

data
object[]
required

The returned entity, collection, or payload

timestamp
string<date-time>
required
Example:

"2026-10-26T10:00:00.000Z"