List leaves
Retrieve a list of approved leaves for one or several users on a given period.
You MUST filter out results both on a date-range through the ?date
query parameter, as well as a set of employees through the ?leavePeriod.owner
query parameter.
In regards to employees filtering, you may:
- retrieve Leaves of a set of specific employees:
?leavePeriod.ownerId=5,6,7
- retrieve Leaves of employees working in a set of specific departments:
?leavePeriod.owner.departmentId=3,4,5
- retrieve Leaves of employees working in a set of specific establishments:
?leavePeriod.owner.legalEntityId=1,2,3
The date
query parameter can operate comparisons with a given date value:
?date=2021-01-01
: strict equality.?date=since,2021-01-01
: greater than or equal.?date=until,2021-01-01
: lower than or equal.?date=between,2021-01-01,2021-01-31
: comprised between two dates.
Headers
API key. Value must be formatted like so: lucca application={api_key}
.
Query Parameters
{offset},{limit}. Defaults to 0,1000.
"2000,500"
ID of the leave-account the leave must have been taken on.
{comparator},{date-time}
"2021-01-01"
"since,2021-01-01"
"until,2021-01-01"
"between,2021-01-01,2021-01-31"
Employee's identifier
Employees department identifier
Employees establishment (i.e. legal-entity) identifier
Response
OK
The response is of type object
.