Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Custom Field Options

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.

get/v3/custom_field_options

Query parameters

cursorstring

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

per_pageinteger

Number of results per page

idsinteger[]

Comma separated list

gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
gtestring date-time
ltestring date-time
gtstring date-time
ltstring date-time
custom_field_idsinteger[]

Comma separated list

fieldsstring[]

Comma separated list of fields to return

activeboolean

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

custom_field_keystring

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

Successful

idinteger
created_atstring date-time
updated_atstring date-time
custom_field_idinteger

Id of the parent custom field this option belongs to. Only fields with value_type of single_select or multi_select carry options.

namestring

Display label shown to recruiters and hiring managers in dropdowns (e.g. Engineering, Bachelor's, Stanford University). Unique among active options on the same parent custom field.

external_idstring nullable

Caller-supplied identifier from the partner's source system (typically an HRIS row id or legacy ATS id). Persisted verbatim as the column offsite_hris_id and not interpreted by Greenhouse.

sort_orderinteger

Display position within the parent custom field's dropdown. Lower values render first; ties fall back to insertion order. Alias of priority in V1/V2.

activeboolean

true while the option is selectable. Set to false after deletion — historical selections on candidates, jobs, and offers are preserved so the value still resolves on existing records.