Leave bookings report
list_leaveRetrieve leave bookings within a date range, optionally filtered by status, employee, employee group, or modification date, to review holidays and absences.
Instructions
Leave bookings (holidays and other absences) in a date range (POST /leavebookings/reports/bookings, "Get leave bookings report"; a POST that changes nothing). Columns: EmployeeReference, EmployeeName, LeaveCategory, LeaveStatus, LeaveStartDate, LeaveEndDate, LeaveTotalWorkingDays, LeaveUnits, LeaveRequestDate, LeaveReviewedDate; LeaveComments only with include_contact_details. Filters sent as documented: statusFilters (omitted for every status), employeeFilter, employeeGroupFilter, modifiedAfterDate. The endpoint documents no paging; whether it counts against the report limits is not documented.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| end_date | Yes | Last date, YYYY-MM-DD (at most 366 days after start_date) | |
| statuses | No | Leave statuses to include (statusFilters); every status when omitted | |
| start_date | Yes | First date, YYYY-MM-DD | |
| max_results | No | Most bookings to return in this call (default 100); the answer says how many were left out | |
| employee_code | No | Sent as employeeFilter | |
| modified_after | No | Only bookings modified after this date/time (modifiedAfterDate) | |
| employee_group_code | No | Sent as employeeGroupFilter | |
| include_contact_details | No | Include the leave comments (LeaveComments, free text that can hold the reason for an absence), and stop redacting email addresses, phone numbers, national insurance numbers and UK postcodes typed into names and other text (bank and card numbers are always removed) |