Retrieve an employee
Retrieve a single employee.
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
An employee resource. Embedded resources on a employee(s) response. 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.