Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Offices

List offices

Offices are the organization's recruiting locations (e.g. San Francisco, New York, Remote (US)) and the foundational scoping unit for jobs, candidates, custom-field visibility, and pay-range display. Each organization defines its own office set, optionally organized as a hierarchy via parent_id. Use this endpoint to enumerate the office tree for filtering, lookup, or downstream resource scoping.

get/v3/offices

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

Comma separated list of fields to return

parent_idinteger

Return only offices whose parent is this office id. Use to traverse the office tree one level at a time.

external_idstring

Return only the office whose external_id matches this value. Useful for HRIS-driven reconciliation where partners track offices by their external identifier rather than by Greenhouse id.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
namestring

Display name of the office (e.g. San Francisco, Remote (US)). Unique among active offices in the same organization.

parent_idinteger nullable

Id of the parent office when offices are organized hierarchically. null for top-level offices. References another /v3/offices row in the same organization.

external_idstring nullable

Stable identifier supplied by the customer or HRIS for cross-system reconciliation. null when no external id has been set. Available when the org_structure_external_id product flag is enabled.

locationstring nullable

Free-form physical location string for the office (e.g. New York, NY, USA). null for offices that have no location set, including most remote offices.

primary_in_house_contact_user_idinteger nullable

Id of the Greenhouse user designated as the office's primary internal contact, typically the local recruiting lead. References a /v3/users row. null when no contact has been assigned.