Get department

Returns a single department by its ID. Returns 403 when the organization does not exist or the authenticated user is not an administrator of it. Returns 404 when the department does not exist or belongs to a different organization.

Path Params
string
required

String. The organization's internal ID (32-character hex string) or its externalSourceId. When the value matches the format of an internal ID, the internal ID takes precedence.

string
required

String. The ID of the department to retrieve (32-character hex string), as returned in the id field of the response. Lookup by externalSourceId is not supported for departments, unlike organizationId. The literal value root is reserved: GET .../departments/root always resolves to the organization's root department (see the Get departments root endpoint), so a department whose own id happens to be root cannot be retrieved through this endpoint.

Responses

Language
Credentials
Bearer
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json