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

Get Business Profile

Get the business profile the receptionists answer from, with the current time in the business's timezone.

ヘッダー

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

レスポンス

成功レスポンス。

idstring
created_at_unixinteger
updated_at_unixinteger
workspace_nowobject
Current time in workspace timezone, computed on each request.
business_namestringオプションデフォルト値
Name of the business.
business_countrystring or nullオプション

ISO 3166-1 alpha-2 country code where the business is based (e.g. ‘US’, ‘PL’, ‘DE’).

business_descriptionstringオプションデフォルト値
What the business does, given to the receptionist.
timezonestringオプション形式: "zoneinfo"
currencyenumオプションデフォルト値 USD

Currency code for all prices (ISO 4217)

operating_hoursobjectオプション
tool_call_soundenum or nullオプション

Ambient sound played while any receptionist runs a tool (e.g. checking availability or looking up a client), filling the silence callers would otherwise hear. One sound for the whole workspace, because custom webhook and MCP tools are shared by every receptionist. Off when null.

許可された値:

エラー

422
Unprocessable Entity Error