Vai alla navigazione
ReceptionHolidays

Get All Holidays

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

Header

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

Parametri di query

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

Filter by type: location, staff, or asset

Valori consentiti:
resource_idstring or nullOpzionale

Filter by associated resource ID (staff/asset)

location_idstring or nullOpzionale
Filter by location ID

Risposta

Risposta riuscita
namestring
start_dateobject
Represents a calendar date as individual numeric components.
end_dateobject
Represents a calendar date as individual numeric components.
time_off_typeenum
Valori consentiti:
idstring
created_at_unixinteger
updated_at_unixinteger
holiday_typeenumOpzionalePredefinito a closed
Valori consentiti:
override_hourslist of objects or nullOpzionale

Replacement working hours when holiday_type is ‘override’.

resource_idstring or nullOpzionale
location_idstring or nullOpzionale

For LOCATION type: the location this closure applies to.

reasonstring or nullOpzionale

Errori

422
Unprocessable Entity Error