Skip to main content
GET
List agents

Authorizations

Authorization
string
header
required

HTTP Basic Authentication. Use your API Access Key ID as the username and your API Access Key Secret as the password. Generate keys in the CloudTalk Dashboard under Account -> Settings -> API Keys (https://dashboard.cloudtalk.io/menu/account/settings/API-keys).

Query Parameters

id
integer

Filter by agent ID

limit
integer

Max. number of items in response data.

Required range: 1 <= x <= 1000
page
integer

Number of page to return.

Required range: x >= 1
associated_number
string

Filters agents by their assigned number. Please enter a valid number in e164 format

Response

200 - application/json

Agents data

responseData
object
required