Skip to main content
GET
List Voice Agents

Authorizations

Authorization
string
header
required

Pass the API key in the Authorization header, You need to put Token keyword before the API key. e.g. 'Authorization: Token '

Query Parameters

skip
integer
default:1

Page number (pagination).

Example:

1

take
integer
default:10

Number of items to take per page (pagination).

Example:

10

Search query to filter agents by name.

Example:

"Test Agent"

sortField
enum<string>

Field to sort by.

Available options:
createdAt
Example:

"createdAt"

sortOrder
enum<string>

Sort order.

Available options:
asc,
desc
Example:

"desc"

type
string[]

Multi-select filter on the type of voice agents.

Example:
language
string[]

Multi-select filter on the language of voice agents.

Example:

Response

Successful response

success
boolean
Example:

true

data
object