---
title: "List Absences"
method: POST
path: "/absences/v1/query"
tags: ["Absences"]
---

# List Absences

`POST /absences/v1/query`

List approved absences for employees in your organisation.

This includes sickness, time-off-in-lieu (TOIL), annual leave and "other" absences.
Lateness is not included.

The `$type` field denotes the type of absence:
- Holiday: used for annual leave, public holidays, and mandatory leave.
- Sickness: used for absences due to sickness or illness.
- Toil: used for time-off-in-lieu (TOIL)
- Other: used for any other type of absence (except Lateness) that doesn't fit into the above categories.

## Request body

- ListAbsencesRequestDto
  - `filters` ListAbsencesFilters, required — Filters for the list of absences.
    - `employeeId` string, uuid, required
    - `from` string, date
    - `to` string, date
  - `continuationToken` string, nullable — The continuation token from the previous response, or `null` for the first page.
  - `pageSize` integer

## Response `200`

OK

- ListResponseDtoAbsenceDto — A paginated list of items.
  - `items` AbsenceDto[], required
    - union — An employee absence.
      - object — Sickness absence is used to record sickness or illness that prevents the employee's ability to work.
        - `$type` 'Sickness', required
        - `estimatedReturn` EstimatedReturnDto, required — The estimated return date and time of the employee.
          - `date` string, date, required
          - `time` string, time
        - `isCertified` boolean, required
        - `reason` SicknessReasonDto, required — The Sickness reason of a sickness absence.
          - `id` integer, required
          - `description` string, required
        - `duration` union, required — The duration of an absence. The value can be either in days or minutes.
          - object — The duration of an absence in days.
            - `$type` 'Days', required
            - `days` number, required
          - object — The duration of an absence in minutes.
            - `$type` 'Minutes', required
            - `minutes` number, required
        - `isPaid` boolean, required
        - `paidDuration` union, required — The duration of an absence. The value can be either in days or minutes.
          - object — The duration of an absence in days.
            - `$type` 'Days', required
            - `days` number, required
          - object — The duration of an absence in minutes.
            - `$type` 'Minutes', required
            - `minutes` number, required
        - `id` string, uuid, required
        - `employeeId` string, uuid, required
        - `start` union, required — Absence boundaries are inclusive: the absence starts at the specified date and ends at the specified date. All dates and times are local to the employee.
          - object — Local date of the absence. The part of the day is not specified.
            - `$type` 'LocalDate', required
            - `date` string, date, required
          - object — Local date and time of the absence.
            - `$type` 'LocalDateTime', required
            - `time` string, time, required
            - `date` string, date, required
          - object — Local date and part of the day (FirstHalf, SecondHalf or FullDay) of the absence.
            - `$type` 'LocalDatePart', required
            - `datePart` 'FirstHalf' | 'SecondHalf' | 'FullDay', required
            - `date` string, date, required
        - `end` union, required — Absence boundaries are inclusive: the absence starts at the specified date and ends at the specified date. All dates and times are local to the employee.
          - object — Local date of the absence. The part of the day is not specified.
            - `$type` 'LocalDate', required
            - `date` string, date, required
          - object — Local date and time of the absence.
            - `$type` 'LocalDateTime', required
            - `time` string, time, required
            - `date` string, date, required
          - object — Local date and part of the day (FirstHalf, SecondHalf or FullDay) of the absence.
            - `$type` 'LocalDatePart', required
            - `datePart` 'FirstHalf' | 'SecondHalf' | 'FullDay', required
            - `date` string, date, required
        - `displayName` string, required — The human-readable name of the absence type.
        - `note` string, required — A note about the absence, if present.
      - object — Time-off-in-lieu (TOIL) is a type of absence that is used to allow employees to take time off from work when they have worked over their required hours.
        - `$type` 'Toil', required
        - `id` string, uuid, required
        - `employeeId` string, uuid, required
        - `start` union, required — Absence boundaries are inclusive: the absence starts at the specified date and ends at the specified date. All dates and times are local to the employee.
          - object — Local date of the absence. The part of the day is not specified.
            - `$type` 'LocalDate', required
            - `date` string, date, required
          - object — Local date and time of the absence.
            - `$type` 'LocalDateTime', required
            - `time` string, time, required
            - `date` string, date, required
          - object — Local date and part of the day (FirstHalf, SecondHalf or FullDay) of the absence.
            - `$type` 'LocalDatePart', required
            - `datePart` 'FirstHalf' | 'SecondHalf' | 'FullDay', required
            - `date` string, date, required
        - `end` union, required — Absence boundaries are inclusive: the absence starts at the specified date and ends at the specified date. All dates and times are local to the employee.
          - object — Local date of the absence. The part of the day is not specified.
            - `$type` 'LocalDate', required
            - `date` string, date, required
          - object — Local date and time of the absence.
            - `$type` 'LocalDateTime', required
            - `time` string, time, required
            - `date` string, date, required
          - object — Local date and part of the day (FirstHalf, SecondHalf or FullDay) of the absence.
            - `$type` 'LocalDatePart', required
            - `datePart` 'FirstHalf' | 'SecondHalf' | 'FullDay', required
            - `date` string, date, required
        - `displayName` string, required — The human-readable name of the absence type.
        - `note` string, required — A note about the absence, if present.
      - object — Used for annual leave, public holidays, and mandatory leave.
        - `$type` 'Holiday', required
        - `id` string, uuid, required
        - `employeeId` string, uuid, required
        - `start` union, required — Absence boundaries are inclusive: the absence starts at the specified date and ends at the specified date. All dates and times are local to the employee.
          - object — Local date of the absence. The part of the day is not specified.
            - `$type` 'LocalDate', required
            - `date` string, date, required
          - object — Local date and time of the absence.
            - `$type` 'LocalDateTime', required
            - `time` string, time, required
            - `date` string, date, required
          - object — Local date and part of the day (FirstHalf, SecondHalf or FullDay) of the absence.
            - `$type` 'LocalDatePart', required
            - `datePart` 'FirstHalf' | 'SecondHalf' | 'FullDay', required
            - `date` string, date, required
        - `end` union, required — Absence boundaries are inclusive: the absence starts at the specified date and ends at the specified date. All dates and times are local to the employee.
          - object — Local date of the absence. The part of the day is not specified.
            - `$type` 'LocalDate', required
            - `date` string, date, required
          - object — Local date and time of the absence.
            - `$type` 'LocalDateTime', required
            - `time` string, time, required
            - `date` string, date, required
          - object — Local date and part of the day (FirstHalf, SecondHalf or FullDay) of the absence.
            - `$type` 'LocalDatePart', required
            - `datePart` 'FirstHalf' | 'SecondHalf' | 'FullDay', required
            - `date` string, date, required
        - `displayName` string, required — The human-readable name of the absence type.
        - `note` string, required — A note about the absence, if present.
      - object — Used for all other types of leave (e.g. Maternity leave, paternity leave, etc.).
        - `$type` 'Other', required
        - `id` string, uuid, required
        - `employeeId` string, uuid, required
        - `start` union, required — Absence boundaries are inclusive: the absence starts at the specified date and ends at the specified date. All dates and times are local to the employee.
          - object — Local date of the absence. The part of the day is not specified.
            - `$type` 'LocalDate', required
            - `date` string, date, required
          - object — Local date and time of the absence.
            - `$type` 'LocalDateTime', required
            - `time` string, time, required
            - `date` string, date, required
          - object — Local date and part of the day (FirstHalf, SecondHalf or FullDay) of the absence.
            - `$type` 'LocalDatePart', required
            - `datePart` 'FirstHalf' | 'SecondHalf' | 'FullDay', required
            - `date` string, date, required
        - `end` union, required — Absence boundaries are inclusive: the absence starts at the specified date and ends at the specified date. All dates and times are local to the employee.
          - object — Local date of the absence. The part of the day is not specified.
            - `$type` 'LocalDate', required
            - `date` string, date, required
          - object — Local date and time of the absence.
            - `$type` 'LocalDateTime', required
            - `time` string, time, required
            - `date` string, date, required
          - object — Local date and part of the day (FirstHalf, SecondHalf or FullDay) of the absence.
            - `$type` 'LocalDatePart', required
            - `datePart` 'FirstHalf' | 'SecondHalf' | 'FullDay', required
            - `date` string, date, required
        - `displayName` string, required — The human-readable name of the absence type.
        - `note` string, required — A note about the absence, if present.
  - `continuationToken` string, nullable — The continuation token for the next page, or `null` if this is the last page.

## Other responses

- `401` — Token Expired. Re-authenticate to obtain a new token.
- `403` — Forbidden
- `422` — Validation failed

---

[API](https://skmtc.dev/bright/apis/customer-api.md) · [All operations](https://skmtc.dev/bright/apis/customer-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/bright/customer-api/revisions/77b0e300c3a5/schema)