Leaves
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 as well as a set of employees through the following query parameters.
In regards to employees filtering, you may:
- either retrieve Leaves of a set of specific employees: ?leavePeriod.ownerId=5,6,7
- or retrieve Leaves of employees working in a set of specific departments: ?leavePeriod.owner.departmentId=3,4,5
- or 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.
get/api/v3/leaves
Query parameters
pagingstring required
Example:2000,500
{offset},{limit}. Defaults to 0,1000.
leaveAccountIdinteger[]
ID of the leave-account the leave must have been taken on.
datestring required
Example:2021-01-01
{comparator},{date-time}
leavePeriod.ownerIdinteger[]
Employee's identifier
leavePeriod.owner.departmentIdinteger[]
Employees department identifier
leavePeriod.owner.legalEntityIdinteger[]
Employees establishment (i.e. legal-entity) identifier
Response
OK