List voice agents and twins

GET

/voice/agents

• Production
• QA

List agents and twins for the caller’s org, with filtering + paging.

This is the full management list (persona/identity summary fields included). GET /voice/dialer/agents above stays as the lighter picker shape used by the dialer/chat flows - unchanged.

Authorizations

• BearerAuth

Parameters

Query Parameters

entity_type

Any of:

string

string

null

null

Filter by entity type (“agent” or “twin”).

role

Any of:

string

string

null

null

Filter by agent role.

agent_status

Any of:

string

string

null

null

Filter by status.

is_template

Any of:

boolean

boolean

null

null

True=templates only, false=non-templates only.

search

Any of:

string

string

null

null

Substring match on agent name.

page

Page number (1-indexed).

integer

default: 1 >= 1

Page number (1-indexed).

page_size

Results per page (max 100).

integer

default: 20 >= 1 <= 100

Results per page (max 100).

sort_by

“created_at” | “agent_name” | “role” | “status”.

string

default: created_at

“created_at” | “agent_name” | “role” | “status”.

sort_order

“asc” or “desc”.

string

default: desc

“asc” or “desc”.

Header Parameters

X-Target-Org-Id

Any of:

string

string

null

null

Responses

200

Successful Response

object

data

required

Paginated agent list.

object

agents

Array<object>

One row from the agent list (full management shape - see also the lighter-weight DialerAgentSummary used by the dialer picker).

object

agent_id

required

string

agent_name

required

string

agent_status

required

string

avatar_url

Any of:

string

string

null

null

calendar_event_id

Any of:

integer

integer

null

null

collection_count

integer

created_at

Any of:

unknown

null

null

description

Any of:

string

string

null

null

entity_type

required

string

has_knowledge

boolean

id

required

integer

is_template

boolean

org_id

required

string

phone

Any of:

string

string

null

null

role

required

string

template_id

Any of:

string

string

null

null

updated_at

Any of:

unknown

null

null

use_company_knowledge

boolean

default: true

voice

Any of:

string

string

null

null

page

integer

default: 1

page_size

integer

default: 20

total_count

integer

total_pages

integer

pagination

Any of:

PaginationMeta

object

has_next

required

Whether there are more pages

boolean

limit

required

Items per page

integer

next_cursor

Any of:

string

string

null

null

notes

Any of:

Array<string>

Array<string>

null

null

page

required

Current page number (1-indexed)

integer

total

required

Total number of items

integer

total_available

Any of:

integer

integer

null

null

total_is_lower_bound

Any of:

boolean

boolean

null

null

null

null

422

Validation Error

object

detail

Array<object>

object

loc

required

Array

msg

required

string

type

required

string