Hoppa till navigering

Get Business Profile

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

Headers

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

Svar

Lyckat svar
idstring
created_at_unixinteger
updated_at_unixinteger
workspace_nowobject
Current time in workspace timezone, computed on each request.
business_namestringValfriStandard är
Name of the business.
business_countrystring or nullValfri

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

business_descriptionstringValfriStandard är
What the business does, given to the receptionist.
timezonestringValfriformat: "zoneinfo"
currencyenumValfriStandard är USD

Currency code for all prices (ISO 4217)

operating_hoursobjectValfri
tool_call_soundenum or nullValfri

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.

Tillåtna värden:

Fel

422
Unprocessable Entity Error