API v1 ReferenceAbsences

Returns all absences.

Admin or user planning data permissions are required, otherwise only the absences of the current user are returned.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Query parameters

pageintegerOptionalDefaults to 1
Page number for pagination
pageSizeintegerOptionalDefaults to 10
Number of items per page
orderbystringOptional
The properties to order by
filterbystringOptional
The filter expression to filter by

Response

OK
idUUID or null
createdOndatetime or null
createdByUUID or null
updatedOndatetime or null
updatedByUUID or null
userIdUUID or null
The id of the user to create the absence for.
startOndatetime or null
The start time of the absence.
endOndatetime or null
The end time of the absence.
descriptionstring or null
The reason for the absence.
externalProviderstring or null
The external provider for the absence.
deletedOndatetime or null
The date the absence was deleted.
deletedByUUID or null
The id of the user that deleted the absence.
isReadOnlyboolean or null

If it’s true it means that this Absence is read-only and cannot be edited/deleted by the user.

isHalfDayOnStartboolean or null
If it's true and it's a single day absence means that the absence is for the first half of the workday. If it's a multi day absence it started on the second half of the first day of the absence period.
isHalfDayOnEndboolean or null
If it's true and it's a single day absence means that the absence is for the second half of the workday. If it's a multi day absence it ended on the first half of the last day of the absence period.