List absences
Operation ID: absences
Group: People Management › Absences
Open in the interactive reference
GET /people/absences
Read-only: Reads and returns; changes nothing.
Lists absences. To filter by employee or by text in the description, use POST people/absences/search.
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | string · v1 | yes | The API version this request targets, named by its public identifier. Required on every request; omitting it, or naming a version this company does not have, is answered with 400. This document describes version v1. |
Query surface
id— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likeabsenceTypeId— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likestartDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenendDate— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweendays— filter by eq, ne, gt, gte, lt, lte, in, notIn, betweenstatus— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like- Orderable: id, leaveNumber, startDate, endDate, days, status
- Selectable: id, leaveNumber, employeeId, absenceTypeId, startDate, endDate, days, status, leaveDescription
page[size]— Page sizepage[cursor]— Opaque continuation cursor
Response
200 Success
Under data, an array of absencesRow:
| Field | Type | Required | Filter | Sort | Description |
|---|---|---|---|---|---|
id |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The unique identifier for the absence. |
leaveNumber |
string | null | no | no | yes | The absence number. |
employeeId |
string | no | no | no | The employee the absence belongs to. See id on GET people/person/:id. |
absenceTypeId |
string | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
no | The type of the absence. See id on GET people/absence-types/:id. |
startDate |
date-time | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date and time the absence starts, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
endDate |
date-time | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The date and time the absence ends, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
days |
decimal | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn) |
yes | The number of absence days. May be fractional for partial days. |
status |
string | null | no | Exact (eq, ne), Range (gt, gte, lt, lte, between), Any of (in, notIn), Pattern (like) |
yes | The status of the absence. Possible values: 'requested', 'approved', 'rejected', 'canceled'. |
leaveDescription |
string | null | no | no | no | The reason for the absence. |
{
"data": [
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"leaveNumber": "<leaveNumber>",
"employeeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"absenceTypeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"startDate": "2026-01-15T09:30:00.000Z",
"endDate": "2026-01-15T09:30:00.000Z",
"days": "19.99",
"status": "<status>",
"leaveDescription": "<leaveDescription>"
}
],
"pagination": {
"hasMore": true,
"nextCursor": "<nextCursor>"
}
}
Statuses
400— Invalid request or business failure401— The request carries no valid access token.403— Not authorized404— Not found429— Too many requests from this client address. The response has no body and noRetry-Afterheader.500— Internal server error