GRgreenhouse
Departments

Create department

Create a department in the caller's organization. Supply parent_id (or external_parent_id) to nest the new record under an existing department; omit both to create a top-level department. Set external_id to keep the new Greenhouse department mapped to the matching record in your HRIS or other external system.

post/v3/departments

Request

  • Base URL
    https://harvest.greenhouse.io
  • URL
    https://harvest.greenhouse.io/v3/departments
  • Auth
    • OAuth 2
      Authorization code: https://auth.greenhouse.io/authorize
      Client credentials
      Token URL: https://auth.greenhouse.io/token scopes: harvest:departments:create
    • or HTTP bearer

Request body

namestring required

Display name of the department. Required.

parent_idinteger

Id of an existing department to nest the new department under. Omit to create a top-level department. Use parent_id when you already have the Greenhouse id; use external_parent_id to reference the parent by its external id instead.

external_idstring

Partner-supplied identifier for the new department, typically the matching id from an HRIS or other external system. Use this to keep Greenhouse departments mapped to your source of truth without maintaining a separate id table.

external_parent_idstring

external_id of an existing parent department to nest the new department under. Useful when you only have external ids on hand; ignored if parent_id is also supplied.

Response

Successful

idinteger
created_atstring date-time
updated_atstring date-time
namestring

Display name of the department (e.g. Engineering, Marketing).

parent_idinteger nullable

Id of the parent department in the organization's department tree. null for top-level departments. References another /v3/departments row.

external_idstring nullable

Partner-supplied identifier for the department, typically the matching id from an HRIS or other external system. Free-form string and null when no external id has been set.

external_parent_idstring nullable

external_id of the parent department, for partners that key the department hierarchy by external id rather than Greenhouse id. Mirrors the external_parent_id accepted on create and update. null for top-level departments and when the parent has no external id set.

Changes

No recorded changes to this operation across all 1 revision of this API.