Security: OAuth 2.0
Security: OAuth 2.0
employees.readonly
employees.readwrite
Authorizations
The Lucca API implements the oAuth 2 protocol with the client-credentials-flow. Refer to RFC8725.
Headers
Only execute the request if current cached version of the resource does not match the one given here.
"W/q5sd4w2x1c1gfdg"
Only execute the request if current cached version of the resource matches the one given here. Useful to avoid concurrency conflicts.
"W/q5sd4w2x1c1gfdg"
List of compression algorithms you support.
Path Parameters
Identifier of the employee to retrieve.
1
Query Parameters
Include metadata:
embedded
: the partial or complete representations of related resources (e.g. the employee the resource belongs to).links
: links to related resources or actions (e.g. approving a leave-request). May benull
when you do not have access to the resource (or action).totalCount
: only applicable on collections (i.e. lists of resources), gives the total number of items across all pages.
Read more about expanding responses.
Response
OK
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.
Embedded resources on a employee(s) response.
An employee resource.
1
"employee"
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.
1 - 100
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.
1 - 100
Professional email of this employee. "<" and ">" characters are forbidden. Some domains are blacklisted and may thus result in 400 errors.
3 - 255
Must be unique.
1 - 100
1
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.
active
, upcoming
, deactivated
"active"
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...
Professional phone number of this employee. Phone number.
"+3356565656"
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.
Read-only. Reference to the active job-position of this employee. Matches the same logic than the "applicableEmployment".
Read-only. UTC timestamp of the moment this object was created.
"2023-01-23T12:45:23.1234Z"
Read-only. UTC timestamp of the moment this object was last updated. Set upon creation, update or deletion of the object.
"2023-01-23T12:45:23.1234Z"