List employee-personal-records
Retrieve a paginated list of employee-personal-records.
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 personal-records on the employee IDs.
100
["123", "456"]
Filter out personal-records on the employee legal gender.
100
["male", "female"]
Only return employees who have at least one of the passed country codes nationalities.
100
["FRA", "DEU"]
Response
OK
A collection of employee-personal-record objects. Embedded resources on a employee-personal-record(s) response. Links on a collection. An collection of employee-personal-record resources.