Hoppa till navigering
ReceptionHolidays

Get All Holidays

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

Headers

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

Frågeparametrar

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

Filter by type: location, staff, or asset

Tillåtna värden:
resource_idstring or nullValfri

Filter by associated resource ID (staff/asset)

location_idstring or nullValfri
Filter by location ID

Svar

Lyckat svar
namestring
start_dateobject
Represents a calendar date as individual numeric components.
end_dateobject
Represents a calendar date as individual numeric components.
time_off_typeenum
Tillåtna värden:
idstring
created_at_unixinteger
updated_at_unixinteger
holiday_typeenumValfriStandard är closed
Tillåtna värden:
override_hourslist of objects or nullValfri

Replacement working hours when holiday_type is ‘override’.

resource_idstring or nullValfri
location_idstring or nullValfri

For LOCATION type: the location this closure applies to.

reasonstring or nullValfri

Fel

422
Unprocessable Entity Error