Skip to main content

A department represents a subdivision of the employee workforce, most often erected around the type of activity they do.

Departments are a tree-like structure, as any department may be child to another.

Note: contrary to most resources, departments are not attached to business-establishments. This means:

  • business-establishments listed in access rights management do not affect departments.
  • employees may work in different business-establishments (or even legal-entities) and yet still belong to the same department.
id
string
Minimum string length: 1
type
string
Allowed value: "department"
url
string<uri>
remoteId
null | string

Identifier of this object in a third-party software.

Maximum string length: 255
isArchived
boolean

If this department is archived. Only possible if there are no more employees attached.

name
string
Required string length: 1 - 255
description
null | string
parent
department-reference · object

Reference to the department this department is a child of.

level
integer<int32>

Read-only. Depth level of this department in the department tree. At level "1", the department has no parent.

Required range: x >= 1
manager
employee-reference · object

Reference to the employee that acts as the Head of this department.

sortOrder
integer<int32>

Index (0-based) of the department among its siblings.

Required range: x >= 0
owningApplication
null | string

Can only be set by an authenticated Lucca application. When not null, indicates that this department is read-only, given that it is managed by another application (designated by its ID) that is charged with its synchronization. Any write request attempt made from anyone other than the application will be rejected with a 403 Forbidden error.

Minimum string length: 1