Sign in

v1

latestOpenAPI 3.1.02026-07-261770816.7 KB
Departments

List departments

Departments are the organizational units jobs are assigned to (e.g. Engineering, Marketing). Each organization maintains its own department tree, with parent_id linking a department to its immediate parent and null marking top-level departments. Use this endpoint to discover department ids and external_id mappings before referencing them on jobs, candidate filters, or custom field scoping.

get/v3/departments

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 departments whose immediate parent is this department id. Omit to list every department regardless of position in the tree.

external_idstring

Return only the department whose external_id matches this value exactly. Useful for reconciling departments against an HRIS or other external system without an extra name lookup.

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.