Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

active
enum<string>

When set to true, lists only agents with active or awaiting threads.

Available options:
true,
false
Example:

"true"

cursor
string

Opaque pagination cursor returned by a previous request.

Example:

"cursor_abc123"

fleetId
string

Fleet to list agents from. Defaults to the API key's default fleet when omitted.

Example:

"fleet_abc123"

limit
string

Maximum number of items to return. Defaults to 20 and preserves parseInt semantics.

Example:

"20"

Response

Agents page.

agents
object[]
required
cursor
string | null
required
hasMore
boolean
required