Przejdź do nawigacji
ReceptionHolidays

Get All Holidays

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

Nagłówki

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

Parametry zapytania

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

Filter by type: location, staff, or asset

Dozwolone wartości:
resource_idstring or nullOpcjonalny

Filter by associated resource ID (staff/asset)

location_idstring or nullOpcjonalny
Filter by location ID

Odpowiedź

Pomyślna odpowiedź

namestring
start_dateobject
Represents a calendar date as individual numeric components.
end_dateobject
Represents a calendar date as individual numeric components.
time_off_typeenum
Dozwolone wartości:
idstring
created_at_unixinteger
updated_at_unixinteger
holiday_typeenumOpcjonalnyDomyślnie closed
Dozwolone wartości:
override_hourslist of objects or nullOpcjonalny

Replacement working hours when holiday_type is ‘override’.

resource_idstring or nullOpcjonalny
location_idstring or nullOpcjonalny

For LOCATION type: the location this closure applies to.

reasonstring or nullOpcjonalny

Błędy

422
Unprocessable Entity Error