absences

Returns all absences.

Changed on

Returns workspace absences visible to the current user. <Check title="Required Permissions" icon="key">The user must be an admin or have user-planning-data:read permission to view other users' absences.</Check>

get/absences

Request

  • Base URL: https://api.awork.com/api/v1
  • URL: https://api.awork.com/api/v1/absences
  • Auth: HTTP bearer

Query parameters

pageinteger

Page number for pagination

pageSizeinteger

Number of items per page

orderbystring

The properties to order by

filterbystring

The filter expression to filter by

Response

OK

idstring uuid

The id of the entity.

createdOnstring date-time

The date this entity was created.

createdBystring uuid

The id of the user who created this entity.

updatedOnstring date-time

The date this entity was last modified.

updatedBystring uuid

The id of the user who last modified this entity.

userIdstring uuid nullable

The id of the user to create the absence for.

startOnstring date-time

The start time of the absence.

endOnstring date-time

The end time of the absence.

descriptionstring nullable

The reason for the absence.

externalProviderstring nullable

The external provider for the absence. If this value is set, the absence is treated as externally managed and therefore read-only in awork. This means users in awork can no longer edit or delete the absence.

deletedOnstring date-time nullable

The date the absence was deleted.

deletedBystring uuid nullable

The id of the user that deleted the absence.

isReadOnlyboolean

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

isHalfDayOnStartboolean

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

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.

Changes