Get Custom Field Definitions

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 . StartIndex starts at 0. Default PageSize is 25. Pagination parameters are optional. You can filter by type 'jobs' or 'contacts'. By default both filters are included. e.g. ?filter=jobs. Valid includes are 'user'. e.g. ?includes=user

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Filter custom field definitions by type. When not specified, returns both job and contact custom field definitions.

Allowed:
integer

How many items to be returned at a time.

integer
Defaults to 0

The index of the first element to return

string

Optional fields to include in full with the response.

Responses

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