跳到导航
ReceptionHolidays

Get All Holidays

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

请求头

xi-api-keystring可选
xi-workspace-idstring or null可选
The customer workspace a reseller's API key acts on.

查询参数

start_unixinteger or null可选
Filter entries overlapping from this timestamp
end_unixinteger or null可选
Filter entries overlapping before this timestamp
time_off_typeenum or null可选

Filter by type: location, staff, or asset

允许的值:
resource_idstring or null可选

Filter by associated resource ID (staff/asset)

location_idstring or null可选
Filter by location ID

响应

成功响应

namestring
start_dateobject
Represents a calendar date as individual numeric components.
end_dateobject
Represents a calendar date as individual numeric components.
time_off_typeenum
允许的值:
idstring
created_at_unixinteger
updated_at_unixinteger
holiday_typeenum可选默认为 closed
允许的值:
override_hourslist of objects or null可选

Replacement working hours when holiday_type is ‘override’.

resource_idstring or null可选
location_idstring or null可选

For LOCATION type: the location this closure applies to.

reasonstring or null可选

错误

422
Unprocessable Entity Error