Passer à la navigation
ReceptionHolidays

Get All Holidays

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

En-têtes

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

Paramètres de requête

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

Filter by type: location, staff, or asset

Valeurs autorisées:
resource_idstring or nullOptionnel

Filter by associated resource ID (staff/asset)

location_idstring or nullOptionnel
Filter by location ID

Réponse

Réponse réussie

namestring
start_dateobject
Represents a calendar date as individual numeric components.
end_dateobject
Represents a calendar date as individual numeric components.
time_off_typeenum
Valeurs autorisées:
idstring
created_at_unixinteger
updated_at_unixinteger
holiday_typeenumOptionnelPar défaut closed
Valeurs autorisées:
override_hourslist of objects or nullOptionnel

Replacement working hours when holiday_type is ‘override’.

resource_idstring or nullOptionnel
location_idstring or nullOptionnel

For LOCATION type: the location this closure applies to.

reasonstring or nullOptionnel

Erreurs

422
Unprocessable Entity Error