Returns the absence with the given identifier.
GET /people/absences/{id}
Group: People Management › Absences · Operation ID: getAbsence
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. |
id |
path | string | yes | The unique identifier for the absence to return. |
Response
200 Success
Under data (getAbsenceOutput):
| Field | Type | Required | Description |
|---|---|---|---|
id |
string | yes | The unique identifier for the absence. |
leaveNumber |
string | no | The absence number. |
employeeId |
string | yes | The unique identifier for the employee the absence belongs to. See id on GET people/:id. |
absenceTypeId |
string | yes | The unique identifier for the absence type. See id on GET people/absence-types/:id. |
startDate |
string (date-time) | yes | The date and time the absence starts, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
endDate |
string (date-time) | yes | The date and time the absence ends, in UTC. Format YYYY-MM-DDTHH:mm:ss.sssZ. |
days |
string (decimal) | no | The number of absence days. May be fractional for partial days. |
status |
string, one of "requested", "approved", "rejected", "canceled" |
no | The status of the absence. |
leaveDescription |
string | no | The free-text reason for the absence. |
Errors
| Code | Status |
|---|---|
NOT_FOUND |
400 |
Statuses
400— Invalid request or business failure. Codes: NOT_FOUND401— Missing or invalid access token403— Not authorized404— Not found429— Too many requests500— Internal server error