Skip to main content
GET
List agents

Authorizations

Authorization
string
header
required

Your organization API key (it starts with anek_org_). The same key works on the Voice API and the Support API. See Authentication.

Query Parameters

limit
integer
required
offset
integer
required
q
string | null
default:""
team_id
string[] | null
account_status
enum<string> | null

Account status (active, disabled)

Available options:
active,
blocked,
not_active
status
enum<string>[] | null
Available options:
online,
offline,
away
used
boolean
default:false
at_capacity
boolean
default:false

Response

Request fulfilled, document follows

list
AgentForListSchema · object[]
required
total
integer
required