ナビゲーションにスキップ
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