ナビゲーションにスキップ
ReceptionLocations

List Locations

List all business locations.

ヘッダー

xi-api-keystringオプション
xi-workspace-idstring or nullオプション
The customer workspace a reseller's API key acts on.

レスポンス

成功レスポンス。

namestring
Internal name, e.g. 'Main Office' or 'Downtown Branch', shown in the dashboard and owner notifications.
_idstring
is_activeboolean読み取り専用
addressstringオプション
Street address.
notesstringオプション
Directions or other notes for customers, e.g. 'Free parking behind the building'.
operating_hoursobjectオプション
customer_facing_namestringオプション

Name shown to customers; empty reuses name.

max_concurrent_appointmentsintegerオプション1-999デフォルト値 1

Maximum number of appointments that may overlap at this location at a single instant. Only enforced while the booking page setting concurrent_limit_enabled is on.

deactivated_at_unixinteger or nullオプション
Unix timestamp when this location was deactivated. None when active.
deactivation_reasonenum or nullオプション
Why this location was deactivated. None when active.
許可された値:

エラー

422
Unprocessable Entity Error