Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Job Board Custom Locations

List job board custom locations

Job board custom locations are the curated list of location strings a site admin maintains for posting jobs to a given job board. Each row belongs to exactly one greenhouse_job_board and backs the custom_list mode of /v3/job_post_locations — when a post references a custom location via custom_location_id, its displayable text is resolved from the matching row's value. Boards configured to use organization offices or free-text strings do not produce rows here; filter by greenhouse_job_board_ids to scope to a specific board.

get/v3/job_board_custom_locations

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
greenhouse_job_board_idsinteger[]

Return only custom locations scoped to one of these Greenhouse job board ids. A GreenhouseJobBoard is the organization's internally configured job board (see GET /v3/job_boards), distinct from generic external job boards; custom locations are reusable, admin-defined location labels configured per board.

fieldsstring[]

Comma separated list of fields to return

activeboolean

Filter by whether the location is currently selectable on job posts. Pass true to return only locations admins have left enabled on their boards; pass false to return only locations that have been removed but are still referenced by historical job posts.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
valuestring

Location string shown to job post creators in the per-board dropdown (e.g. New York, NY, Remote (US)). Site admins curate one row per line in the job board's location settings; the same value is used verbatim on job_post_locations rows whose type is custom_list.

activeboolean

true while the location is selectable on new and edited job posts. Set to false after removal — historical job_post_locations rows that already reference this id are preserved so existing posts still resolve their displayable location.

greenhouse_job_board_idinteger

Id of the job board this location is scoped to. Custom locations are board-scoped — a given location belongs to exactly one board, and a post may only reference a custom location whose greenhouse_job_board_id matches its own.