Saltar a la navegación
ReceptionBusiness Profile

Get Business Profile

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

Encabezados

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

Respuesta

Respuesta correcta.
idstring
created_at_unixinteger
updated_at_unixinteger
workspace_nowobject
Current time in workspace timezone, computed on each request.
business_namestringOpcionalValor predeterminado:
Name of the business.
business_countrystring or nullOpcional

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

business_descriptionstringOpcionalValor predeterminado:
What the business does, given to the receptionist.
timezonestringOpcionalformat: "zoneinfo"
currencyenumOpcionalValor predeterminado: USD

Currency code for all prices (ISO 4217)

operating_hoursobjectOpcional
tool_call_soundenum or nullOpcional

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.

Valores permitidos:

Errores

422
Unprocessable Entity Error