Naar navigatie springen
ReceptionHolidays

Get All Holidays

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

Headers

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

Queryparameters

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

Filter by type: location, staff, or asset

Toegestane waarden:
resource_idstring or nullOptioneel

Filter by associated resource ID (staff/asset)

location_idstring or nullOptioneel
Filter by location ID

Response

Geslaagde response
namestring
start_dateobject
Represents a calendar date as individual numeric components.
end_dateobject
Represents a calendar date as individual numeric components.
time_off_typeenum
Toegestane waarden:
idstring
created_at_unixinteger
updated_at_unixinteger
holiday_typeenumOptioneelStandaard closed
Toegestane waarden:
override_hourslist of objects or nullOptioneel

Replacement working hours when holiday_type is ‘override’.

resource_idstring or nullOptioneel
location_idstring or nullOptioneel

For LOCATION type: the location this closure applies to.

reasonstring or nullOptioneel

Fouten

422
Unprocessable Entity Error