These docs are for v1.0.0. Click to read the latest docs for v2.0.0.

List all custom fields

Returns detail of all custom field definitions. This API only returns the data regarding the custom field definition, not the values for hierarchy entities. Values are managed by Custom Fields Values endpoints.

When listing, the type filter has to be specified to allow us to add new types without breaking existing clients. It's possible to specify multiple types in the filter.

This API is paginated, only the first 100 items are returned by default. The client should then recursively follow links.next link in the response to fetch the next page.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
type
array of strings
required
length ≥ 1

Custom field types to include in the response. Mandatory to allow the addition of more types in the future without breaking existing clients.

type*
Allowed:
Headers
integer
enum
required

API version.

Allowed:
Responses

Language
Credentials
Bearer
JWT
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json