Skip to main content
GET
List Agents

Authorizations

Authorization
string
header
required

Organization-scoped Auth0 user access token issued to an approved first-party client or exchanged by a trusted OBO resource server.

Query Parameters

cursor
string

Opaque forward-only cursor returned as nextCursor by the previous page. Never construct one by hand.

Required string length: 1 - 4096
limit
integer
default:25

Page size; defaults to 25 and never exceeds 100.

Required range: 1 <= x <= 100
kind
enum<string>[]
Required array length: 1 - 2 elements

Runtime family implemented by an Agent.

Available options:
voice,
messaging

Matches the Agent name and description.

Required string length: 1 - 200
Example:

"Marta Rojas"

status
enum<string>

Customer-controlled lifecycle state of an Agent.

Available options:
active,
paused
Example:

"active"

Response

OK

One page of Agent summaries.

items
Agent summary · object[]
required
Maximum array length: 100
nextCursor
string | null
required

Opaque forward-only cursor returned as nextCursor by the previous page. Never construct one by hand.

Required string length: 1 - 4096