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.

​
givenName
string
required

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
required

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
​
email
null | string<email>
required

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
​
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.

​
employeeNumber
null | string
Required string length: 1 - 50
​
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.

Example:

"+3356565656"