Absences
Manage user absences and availability exceptions.
List absences
query Parameters
page0-based page number for offset pagination. Mutually exclusive with cursor.
cursor^[A-Za-z0-9._~\-]*$Opaque cursor for keyset pagination. Mutually exclusive with page. Clients must not parse or construct it; pass the nextCursor value back unchanged. Current tokens use the shared v1.BASE64... format.
sizeRequested page size. Defaults to 20 and must not exceed 100.
sort^[A-Za-z0-9_,.\s]*$Sort expression. Blank values are treated as not provided and default sorting is used.
fromDateAbsence start date filter (inclusive).
toDateAbsence end date filter (inclusive).
userIdFilter by user ID.
userEmailFilter by user email.
typeFilter by absence type code.
Absence type code accepted by write and filter operations.
Known values:
0Other2Business trip3Vacation4Day off6Short work
List absences › Responses
OK
Items returned in this response.
hasMoreWhether more results are available.
nextCursorCursor for the next page of results.
Page-based pagination metadata.
sizeRequested page size.
Create absence
Creates a new absence.
Create absence › Request Body
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
Omit or set null to leave it unset on create.
noteAbsence note.
Omit or set null to leave it unset on create.
Create absence › Responses
Created
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
idAbsence ID.
noteAbsence note.
Get absence by external ID
path Parameters
externalIdGet absence by external ID › Responses
OK
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
idAbsence ID.
noteAbsence note.
Replace absence by external ID
Replaces the writable state of the addressed absence.
path Parameters
externalIdReplace absence by external ID › Request Body
Absence period.
null is invalid.
Absence type.
null is invalid.
externalIdExternal ID.
Omit or set null to clear it.
noteAbsence note.
Omit or set null to clear it.
Replace absence by external ID › Responses
OK
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
idAbsence ID.
noteAbsence note.
Update absence by external ID
Partially updates the writable state of the addressed absence.
path Parameters
externalIdUpdate absence by external ID › Request Body
externalIdExternal ID.
Omit to leave it unchanged. Set null to clear it.
noteAbsence note.
Omit to leave it unchanged. Set null to clear it.
Absence period.
Omit to leave it unchanged. null is invalid.
Absence type.
Omit to leave it unchanged. null is invalid.
Update absence by external ID › Responses
OK
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
idAbsence ID.
noteAbsence note.
Get absence by ID
path Parameters
idGet absence by ID › Responses
OK
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
idAbsence ID.
noteAbsence note.
Replace absence by ID
Replaces the writable state of the addressed absence.
path Parameters
idReplace absence by ID › Request Body
Absence period.
null is invalid.
Absence type.
null is invalid.
externalIdExternal ID.
Omit or set null to clear it.
noteAbsence note.
Omit or set null to clear it.
Replace absence by ID › Responses
OK
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
idAbsence ID.
noteAbsence note.
Update absence by ID
Partially updates the writable state of the addressed absence.
path Parameters
idUpdate absence by ID › Request Body
externalIdExternal ID.
Omit to leave it unchanged. Set null to clear it.
noteAbsence note.
Omit to leave it unchanged. Set null to clear it.
Absence period.
Omit to leave it unchanged. null is invalid.
Absence type.
Omit to leave it unchanged. null is invalid.
Update absence by ID › Responses
OK
Absence period.
Absence type.
User associated with the absence.
externalIdExternal ID.
idAbsence ID.
noteAbsence note.