Skip to navigation

List agents

Returns the agents of the organization, newest first, one page at a time. Each item has the name, the language, the phone line, the state (active or suspended) and the variables declared by the organization. It never returns the script, the voice, the models or anything about how an agent works. Only main agents are listed: the colleagues of a team are not agents on their own. Required scope: agents:read. With a test key (vx_test_) it behaves exactly as with a live key and consumes nothing.

Authentication

AuthorizationBearer
API key created by an Owner or Admin of the organization. Never in the query string.

Headers

VoxAI-VersionenumOptional

API version for this request; defaults to the version the key is pinned to.

Allowed values:

Query parameters

limitintegerOptional1-100Defaults to 20
Maximum number of items in the page, from 1 to 100. Default 20.
cursorstringOptional1-400 characters

Opaque cursor from next_cursor of the previous page, to read the next one. Pass it back unchanged, with the same filters; omit it for the first page.

Response

Successful response.
datalist of objects
The items of this page, in the requested order.
has_moreboolean

true if there are more items after this page.

next_cursorstring or null

Pass it as cursor to read the next page; null on the last page.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error