Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Offices

Create office

Create a new office for the organization. Provide a name and, optionally, a location, an external_id, a primary_in_house_contact_user_id, and a parent reference (either parent_id or external_parent_id, not both). Tiered offices require the tiered_offices_and_departments product flag; external_id requires the org_structure_external_id product flag.

post/v3/offices

Request body

namestring required

Display name of the new office. Must be unique among active offices in the organization.

parent_idinteger

Id of the office to use as the parent in the office hierarchy. Omit (or set with external_parent_id instead) when creating a top-level office. Mutually exclusive with external_parent_id.

external_idstring

Customer- or HRIS-supplied identifier for cross-system reconciliation. Requires the org_structure_external_id product flag.

locationstring

Free-form physical location string for the office (e.g. New York, NY, USA). Optional; omit for remote-only offices.

primary_in_house_contact_user_idinteger

Id of the Greenhouse user to set as the office's primary internal contact. References a /v3/users row.

external_parent_idstring

external_id of the office to use as the parent, for partners that key the hierarchy by external id rather than Greenhouse id. Mutually exclusive with parent_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.