List absences
list_absencesRetrieve absence records across the organization or for one user, filtered by date range, record type, absence type, group, or user, to review holiday and sickness data.
Instructions
Absence records (holiday, sickness and other absence types) across the system or for one user, with status, start and end, duration and the absence_type_id (name it with list_absence_types). Filters are sent to the API as documented: date_from/date_to (datestart/dateend), record_type (1 planned, 2 unplanned), absence_type_id, and on the system-wide endpoint also user_id (Edays GUID), group_id, created_since and modified_since. With partner_user_id the per-user endpoint GET /api/v2/users/{id}/absences is used instead, which documents only the first three filters. Whole API pages of min(100, max_results) records are returned; the note says how to continue. Payroll and employee numbers only with include_contact_details.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | 1-based page to start from (for continuing a previous call) | |
| date_to | No | End of the date range, YYYY-MM-DD (sent as dateend=YYYYMMDD) | |
| user_id | No | Only records for this Edays user GUID (the userId filter; not with partner_user_id) | |
| group_id | No | Only records whose user is in this group (the groupId filter, e.g. a location; not with partner_user_id). The documentation does not say whether this is the group's GUID or partner ID; the value is sent as given | |
| date_from | No | Start of the date range, YYYY-MM-DD (sent as datestart=YYYYMMDD) | |
| max_results | No | Maximum number of records to return; also sets the API page size (up to 100) | |
| record_type | No | 1 for planned absences (holiday), 2 for unplanned (sickness); omitted returns all | |
| created_since | No | The dateCreated filter: 'filter out records created before' this value. Its format is not documented; the value is sent as given (the other date filters use YYYYMMDD). Not with partner_user_id | |
| modified_since | No | The dateModified filter: 'filter out records modified before' this value. Format not documented; sent as given. Not with partner_user_id | |
| absence_type_id | No | Absence type ID (integer, see list_absence_types) | |
| partner_user_id | No | Only this user's absences, via GET /api/v2/users/{partnerUserId}/absences | |
| include_contact_details | No | Include payroll and employee numbers, and stop redacting email addresses, phone numbers and UK postcodes typed into names and other text |