Skip to main content
GET
cURL

Authorizations

X-API-Key
string
header
required

Customer API key created in the Sendora dashboard.

Headers

X-API-Key
string | null
Authorization
string | null

Query Parameters

id
string | null

Return this one agent with its full configuration.

type
enum<string>
default:voice

Which kind of agent to list.

Available options:
voice,
chat
include
string | null

voices adds the voice choices for this agent. templates (without id) returns an object with agents and templates, the starting points for a new agent.

page
integer
default:1
Required range: x >= 1
per_page
integer
default:50
Required range: 1 <= x <= 200

Response

Successful Response

Deliberately minimal public representation of a voice agent.

The authenticated operator API returns the full configuration, but public API keys must not receive system prompts, tool definitions, tenant IDs, or connected service resource identifiers as an incidental side effect of listing an agent. Configuration is accepted on write requests but is never echoed.

created_at
string<date-time>
required

Created at returned by the Sendora API.

id
string
required

The voice agent's id. Pass it to any endpoint that takes agent_id.

name
string
required

Name returned by the Sendora API.

direction
string
default:outbound

Direction returned by the Sendora API.

display_name
string | null

Display name returned by the Sendora API.

first_message
string
default:""

First message returned by the Sendora API.

is_active
boolean
default:false

Is active returned by the Sendora API.

ready
boolean
default:false

Ready returned by the Sendora API.

updated_at
string<date-time> | null

Updated at returned by the Sendora API.