v1

latestOpenAPI 3.1.02026-08-066984441.1 MB

workspaceAbsences

Creates a new workspace absence.

Creates a new workspace absence. A workspace absence is a kind of absence that is applied to all users in a workspace. It can be used to define special holidays (e.g: company offsite) that apply to all users in a workspace. It can be limited to a specific absence region, in which case only users in that region will be affected.

<Note title="Subscription Level" icon="layer-group">This endpoint requires the Standard plan or higher.</Note>

<Check title="Required Permissions" icon="key">The user must be an admin or have user-planning-data:write permissions.</Check>

post/workspaceabsences

Headers

Authorizationstring required

Bearer authentication

Request body

startOnstring date-time required

The start time of the workspace absence.

endOnstring date-time required

The end time of the workspace absence.

descriptionstring required

The description of the workspace absence.

regionIdstring uuid nullable

(optional) The id of the absence region to limit the workspace absence to. If not set, the workspace absence will apply to all users in the workspace. Otherwise, it will only apply to users in the specified absence region.

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 will start 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 will end on the first half of the last day of the absence period.

Response

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.

startOnstring date-time

The start time of the workspace absence.

endOnstring date-time

The end time of the workspace absence.

descriptionstring nullable

The description of the absence.

regionIdstring uuid nullable

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 nullable

The name of the region of the workspace absence. Null if the absence is global for the entire workspace.

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.