Use this endpoint to retrieve custom field definitions and the options related to each custom field definition by company.
Returns Custom Field Definitions for types "contact" and "job" with only active status.
Includes field options with active status by default.
Custom Field Definitions are returned by grouped by field type.
This endpoint will return a paginated response starting from the given page start index. pageStartIndex starts at 0. Default pageSize is 25. Pagination parameters are optional.
A 416 Range Not Satisfiable error is returned when pageStartIndex is greater than or equal to the total number of custom field definitions (after filtering). The error message includes the total result count.
When there are no custom field definitions (after filtering), a 200 OK is returned with an empty items array, echoing back the requested pageSize and pageStartIndex.
You can filter by type 'jobs' or 'contacts'. By default both filters are included. e.g. ?filter=jobs.
Supported includes: user.