List employees
Returns a paginated list of employees.
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.
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.
Cursor of the page to retrieve. Read more about pagination.
Number of items per page. Defaults to 25. Maximum is 100. Read more about pagination.
0 <= x <= 100
Find an employee by their name. The employee given or family names must start with the given words. Each word can be delimited with any of these delimiters: [' ', '-', '_', ',', '.']
.
1
Filter out employees on their ID.
100
["123", "456"]
Filter out employees on their status.
100
["active"]
Filter out employees on their active employment legal-entity IDs.
100
["12", "13"]
Filter out employees on their active employment remoteId.
100
["E001", "E023"]
Filter out employees on their active employment startsOn date (strict equality).
Filter out employees on their active employment startsOn date. ISO 8601 formatted date-range string.
"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Filter out employees on their applicable employment endsOn date (strict equality).
Filter out employees on their applicable employment endsOn date. ISO 8601 formatted date-range string.
"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Filter out employees on their applicable employment template IDs.
100
["1", "2", "5"]
Filter out employees on their applicable employment template term.
100
["permanent"]
Filter out employees on their applicable job-position remoteId.
100
["null", "JP001", "JP002"]
Filter out employees on their active job-position business-establishment IDs.
100
["12", "13"]
Filter out employees on their applicable job-position department IDs.
100
["123", "452"]
Filter out employees on their manager's IDs.
100
["416", "521"]
Filter out employees on their applicable job-position job-qualification IDs.
100
["25", "28"]
Filter out employees on their active job-position job-qualification remoteId.
100
["null", "JQ001", "JQ002"]
Filter out employees on their active job-position occupation-category IDs.
100
["5", "12"]
Filter out employees on their active job-position occupation-category remoteId.
100
["null", "OC001", "OC002"]
Response
OK
A collection of employee resources. Links on a collection. Embedded resources on a employee(s) response. A collection of employee objects.