Ir para a navegação

Get All Holidays

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

Cabeçalhos

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

Parâmetros de consulta

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

Filter by type: location, staff, or asset

Valores permitidos:
resource_idstring or nullOpcional

Filter by associated resource ID (staff/asset)

location_idstring or nullOpcional
Filter by location ID

Resposta

Resposta bem-sucedida

namestring
start_dateobject
Represents a calendar date as individual numeric components.
end_dateobject
Represents a calendar date as individual numeric components.
time_off_typeenum
Valores permitidos:
idstring
created_at_unixinteger
updated_at_unixinteger
holiday_typeenumOpcionalPadrão é closed
Valores permitidos:
override_hourslist of objects or nullOpcional

Replacement working hours when holiday_type is ‘override’.

resource_idstring or nullOpcional
location_idstring or nullOpcional

For LOCATION type: the location this closure applies to.

reasonstring or nullOpcional

Erros

422
Unprocessable Entity Error