List custom field options

Custom field options are the selectable values on a single_select or multi_select custom field — each row belongs to exactly one custom field via custom_field_id. Filter to a specific dictionary with custom_field_ids (preferred when the id is known) or custom_field_key (e.g. school_name, degree, discipline, cost_center). The V1 endpoints /v1/schools, /v1/degrees, and /v1/disciplines are all served here in V3 — pass the matching custom_field_key. Archived options remain in results by default; pass active=true to restrict to currently selectable options.

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
custom_field_ids
array of integers
length ≤ 50

Comma separated list

custom_field_ids
fields
array of strings
length ≤ 50

Comma separated list of fields to return

fields
boolean

Filter by selectability. true returns options currently usable in the UI; false returns archived (soft-deleted) options. Omit to return both.

string

Filter options to a single custom field by its name_key (e.g. school_name, degree, discipline, cost_center). Use this when you know the field's stable key but not its id — these are the V3 replacement for V1's /schools, /degrees, and /disciplines endpoints.

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