API v1 ReferenceWorkspace Absences

Gets all workspace absences.

Gets all workspace absences. The result can be filtered, sorted, and paged.

Required Permissions
The user must be an admin or have user-planning-data:write permissions.

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
startOndatetime or null
The start time of the workspace absence.
endOndatetime or null
The end time of the workspace absence.
descriptionstring or null
The description of the absence.
regionIdUUID or null

The (optional) regionId of the workspace absence. If null, the absence is global for the entire workspace. Otherwise, it will be applied only to the users of the region.

regionstring or null
The name of the region of the workspace absence. Null if the absence is global for the entire workspace.
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.