Zur Navigation springen
ReceptionHolidays

Get All Holidays

Get all holidays/time-off entries for the current workspace with optional filters

Header

xi-api-keystringOptional
xi-workspace-idstring or nullOptional
The customer workspace a reseller's API key acts on.

Abfrageparameter

start_unixinteger or nullOptional
Filter entries overlapping from this timestamp
end_unixinteger or nullOptional
Filter entries overlapping before this timestamp
time_off_typeenum or nullOptional

Filter by type: location, staff, or asset

Erlaubte Werte:
resource_idstring or nullOptional

Filter by associated resource ID (staff/asset)

location_idstring or nullOptional
Filter by location ID

Antwort

Erfolgreiche Antwort
namestring
start_dateobject
Represents a calendar date as individual numeric components.
end_dateobject
Represents a calendar date as individual numeric components.
time_off_typeenum
Erlaubte Werte:
idstring
created_at_unixinteger
updated_at_unixinteger
holiday_typeenumOptionalStandardwert ist closed
Erlaubte Werte:
override_hourslist of objects or nullOptional

Replacement working hours when holiday_type is ‘override’.

resource_idstring or nullOptional
location_idstring or nullOptional

For LOCATION type: the location this closure applies to.

reasonstring or nullOptional

Fehler

422
Unprocessable Entity Error