Skip to main content

The employee represents the public face of an employee in the system. Note that an employee can also represent a trainee, an intern, a contractor, etc...

The applicableEmployment property references the employee's employment that is:

  • currently in effect if the employee is "active".
  • will first be in effect if the employee has an employment starting in the future (either the first or a new one).
  • was last in effect if the employee is no longer employed and is not expected to be re-remployed in the future.

The applicableJobPosition property references the employee's job-position that matches the same logic.

​
id
string
Minimum string length: 1
​
type
string
Allowed value: "employee"
​
url
string<uri>
​
remoteId
null | string

Must be unique.

Required string length: 1 - 100
​
portrait
portrait-reference · object

Reference to the employee's portrait, which is a file (picture) representing them.

​
givenName
string

Name given at birth. In the U.S.A., the first name of a person. In French: "prénom". Leading and trailing spaces are automatically removed.

Required string length: 1 - 255
​
familyName
string

Name inherited from the person's family. In the U.S.A., the last name of a person. In French: "nom (de famille)". Leading and trailing spaces are automatically removed.

Required string length: 1 - 255
​
employeeNumber
null | string
Required string length: 1 - 50
​
status
enum<string>

Read-only. The employee status is calculated from the employee's employments.

  • active: employee has an employment as of today.
  • upcoming: employee currently has no employment but will have one in the future.
  • deactivated: employee used to have an employment but no longer does.
Available options:
active,
upcoming,
deactivated
Example:

"active"

​
email
null | string<email>

Professional email of this employee. "<" and ">" characters are forbidden. Some domains are blacklisted and may thus result in 400 errors.

Required string length: 3 - 255
​
birthDay
object

Year-less date of birth.

Read-only, as it is infered from the employee-personal-record birthDate. Take note that month starts at "1" and not zero, i.e. "1" is for January, "2" for February, etc...

​
phoneNumber
string<phone> | null

Professional phone number of this employee.

Pattern: ^[\+]?[(]?[0-9]{3}[)]?[-\s\.]?[0-9]{3}[-\s\.]?[0-9]{4,6}$
Example:

"+3356565656"

​
applicableEmployment
employment-reference · object

Read-only. Reference to the applicable employment of this employee. If the employee status is "deactivated", then references their last employment. If the employee status is "upcoming", then references their closest next employment.

​
applicableJobPosition
job-position-reference · object

Read-only. Reference to the active job-position of this employee. Matches the same logic as the "applicableEmployment".

​
createdAt
string<date-time-offset>

Read-only. UTC timestamp of the moment this object was created.

Example:

"2023-01-23T12:45:23.1234Z"

​
lastUpdatedAt
string<date-time>

Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.

Example:

"2023-01-23T12:45:23.1234Z"

​
links
object