Get Department

GET /departments/{id}

Group: People Management › Departments · Operation ID: getDepartment

Returns the department with the given identifier. Use the department's id, not its departmentNumber.

Open in the interactive reference

Parameters

Name In Type Required Description
Api-Version header "v1" yes The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1.
id path string yes The unique identifier for the department to return.

Response

200 Success

Under data (getDepartmentOutput):

Field Type Required Description
id string yes The unique identifier for the department.
departmentNumber string no The system-generated department number, for example '100010'. Absent while none has been assigned.
name string yes The display name of the department.
departmentCode string no The short code for the department, for example 'IT', 'HR' or 'FIN'.
description string no A free-form description of the department's purpose and responsibilities.
managerId string no The identifier of the managing employee. Absent when no manager is assigned. See id on GET people/:id.
managerName string no The full name of the managing employee. Absent when no manager is assigned.
parentId string no The identifier of the parent department. Absent for a top-level department. See id on GET departments/:id.
parentName string no The display name of the parent department. Absent for a top-level department.
status string no The timeline status of the department. Possible values: 'planned', 'inactive', 'active', 'canceled'.
startDate string no The date the department becomes active. Format YYYY-MM-DD.
endDate string no The date the department becomes inactive. Format YYYY-MM-DD. Absent for an open-ended department.
employeeCount number no The number of employees in the department.
lastModifiedDate string (date-time) yes The date and time the department record last changed, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ.
externalIdentifiers array of object no The department's identifiers in other systems, one per configured field name. An empty array or absent when the department has none.
externalIdentifiers[].fieldName string yes The configured field name of the identifier, for example 'netsuiteDepartmentId'.
externalIdentifiers[].value string yes The identifier in the other system.
externalIdentifiers[].externalUrl string no A link to the record in the other system. Absent when none is stored.

Errors

Code Status
NOT_FOUND 400

Statuses