List job board custom locations

get

https://harvest.greenhouse.io/v3/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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Query Params

cursor

string

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

per_page

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

greenhouse_job_board_ids

array of integers

length ≤ 50

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.

greenhouse_job_board_ids

fields

array of strings

length ≤ 50

Comma separated list of fields to return

fields

Allowed:

active

boolean

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

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful