List custom fields

Custom fields are the org-defined dictionary of structured data your organization layers onto core resources — jobs, offers, openings, candidates, applications, and users. Each row defines one field: its field_type selects the parent resource it attaches to, and its value_type selects the data type and editor (text, number, currency, single/multi-select, date, user, attachment, etc.). Replaces the V1 path-scoped endpoints /v1/custom_fields/{field_type} — filter by field_type as a query parameter instead. For select-type fields, options live on the sibling resource /v3/custom_field_options; office/department visibility lives on /v3/custom_field_offices and /v3/custom_field_departments.

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

Cursor link for pagination from previous page response header. Do not use any other parameters when using this.

integer
1 to 500
Defaults to 100

Number of results per page

ids
array of integers
length ≤ 50

Comma separated list

ids
created_at
object
updated_at
object
fields
array of strings
length ≤ 50

Comma separated list of fields to return

fields
string
enum

Filter by the resource the field attaches to (e.g. job, offer, candidate, application, opening, user_attribute). Replaces the V1 path segment /v1/custom_fields/{field_type}.

boolean

Filter by archival status. Defaults to returning both active and archived; set true for live fields only, false for archived only.

string

Filter to fields whose human-readable name exactly matches this value (case-insensitive).

string

Filter to the field with this name_key (the stable lowercase identifier used when setting values on parent resources). Prefer this over name for integrations — name_key is stable across rename.

Response

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