iCallAgent

Appearance

List agents​

GET
/agents/

Only Live agents are returned — a Paused agent has no working phone/telephony config to place calls with, so it's excluded rather than returned with a status field to filter on client-side.

Authorizations​

ApiKeyAuth

Personal API key. Code samples use Authorization: Bearer <token> — replace <token> with your key from Settings → API Keys (include the word Bearer).

Type
HTTP (bearer)
or
oauth2

OAuth2 access token from the consent flow third-party apps go through (see /oauth/authorize/). Interchangeable with a personal API key on every operation below — both are sent as a Bearer token in the same header.

authorizationCode Flow
Authorization URL"/oauth/authorize/"
Token URL"/oauth/token/"
Scopes:
  • "campaigns:read"List your call campaigns
  • "campaigns:write"Create new call campaigns
  • "contacts:write"Create contacts and queue calls into your campaigns

Parameters​

Query Parameters

limit

Max results to return. Default 100, clamped to [1, 200] — out-of-range values are silently clamped, not rejected.

Type
integer
offset

Number of results to skip. Default 0. Negative values are clamped to 0.

Type
integer

Responses​

application/json
JSON
{
  
"results": [
  
  
{
  
  
  
"id": 7,
  
  
  
"name": "Support Agent"
  
  
}
  
]
}

Playground​

Server
Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

List is Live-only

This endpoint returns just id and name for Live agents so dropdowns (and Make modules) stay simple. Paused agents are omitted. Creating or editing agents is done in the dashboard for now.