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

List all custom fields' values

Returns all set (non-empty) custom field values. It can be filtered by

  • type - returns all custom fields values of given types. Multiple types can be specified.
  • hierarchyEntity.id - returns all custom fields values for the hierarchy entity (row).
  • customField.id - returns all custom fields values for the custom field (column).

The filters can be combined. Either customField.id or type has to be specified to not break existing API consumers when adding a new custom field type.

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

Custom field types to include in the response. Mandatory if customField.id is not specified.

type
Allowed:
string

Show only custom field values for given custom field. Mandatory if type is not specified.

string

Show only custom field values for given hierarchy entity.

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