List employments
Returns a paginated list of employments.
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
Filter out employments on their IDs.
100
["123", "456"]
Filter out employments on their remoteId.
100
["E500944", "E500945"]
Filter out employments on their employee IDs.
100
["123", "456"]
Filter out employments on the legal-entity IDs.
100
["1", "3"]
Filter out employments on their employment-template IDs.
100
["4", "6"]
Filter out employments on their startsOn date (strict equality).
Filter out employments on their startsOn date (range). ISO 8601 formatted date-range string.
"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Filter out employments on their endsOn date (strict equality).
Filter out employments on their endsOn date (range). ISO 8601 formatted date-range string.
"2024-01-01--2024-12-31"
"..--2024-12-31"
"2024-01-01--.."
Order results by instruction. Read more about sorting. Default: id
.
Response
OK
A collection of employment objects. Embedded resources on a employment(s) response. Links on a collection. A collection of employment resources.