smb
SMB

List Customer Facing Agents

Changed on

List every customer-facing receptionist for the workspace.

get/v1/smb/customer-facing-agents

Request

  • Base URL
    https://api.elevenlabs.io (the document declares no server; this is the origin it was published from)
  • URL
    https://api.elevenlabs.io/v1/smb/customer-facing-agents
  • Auth
    none declared

Headers

xi-api-keystring nullable

Your API key. This is required by most endpoints to access our API programmatically. You can view your xi-api-key using the 'Profile' tab on the website.

xi-workspace-idstring nullable

The customer workspace a reseller's API key acts on.

Response

Successful Response

agent_idstring

ConvAI agent id. Empty string is the placeholder seeded by the legacy API validator when migrating a single-agent payload; the agent-owning service resolves it from the workspace assignment.

deactivated_at_unixinteger nullable

Unix timestamp when this receptionist was deactivated. None when active.

deactivation_reason'tier_downgrade' | 'user'

Why a receptionist is currently inactive (live calls disabled).

namestring

Display name read from the ConvAI agent document (the single source of truth).

agent_existsboolean

Whether the underlying ConvAI agent document still exists. False when the receptionist references a deleted agent and needs repair.

is_transfer_allowedboolean

Whether this receptionist can configure and use transfer rules.

is_activeboolean required

Changes