Absence Types
GET /people/absence-types
Group: People Management › Absence Types · Operation ID: absenceTypes
List absence types with structured filters. GET data-set exposing filter[field][op]=, sort=, sparse fields= and page[size]/page[cursor] cursor pagination.
Open in the interactive reference
Parameters
| Name | In | Type | Required | Description |
|---|---|---|---|---|
Api-Version |
header | "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, likename— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, likecategory— filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like- Orderable: id, name, category
- Selectable: id, name, category, description
Response
200 Success
Under data, an array of absenceTypesRow:
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | no | Stable, platform-assigned id (a UUID) of the absence type — the public identifier used by GET people/absence-types/:id and by createAbsence's absenceTypeId. |
name |
string | no | Display name of the absence type. |
category |
string | no | Category the absence type belongs to: sickLeave, vacation, other or overtime. Try filter[category][eq]=vacation. |
description |
string or null | no | Longer description of the absence type, when one is configured. |
Statuses
400— Invalid request or business failure401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error