API ReferenceCalls

List calls

Paginated telephony call logs for an agent. Returns id, source, destination, status, direction, created_on, duration_seconds, is_test_call, error_reason, end_reason, ringing_at, and ended_at.

GET
/api/v1/console/agents/{agentId}/calls

Authorization

ApiKeyAuth
AuthorizationBearer <token>

Team API key (prefix sk_). You may also send the key via X-Api-Key header.

In: header

Path Parameters

agentId*string

Query Parameters

page?number

Page number (1-based)

limit?number

Items per page (max 100)

search?string

Free-text search filter

sort?string

Sort field with optional leading "-" for descending (e.g. "-created_at").

is_test_call?boolean

Filter test vs live calls

status?string

Filter by call status

Response Body

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/api/v1/console/agents/string/calls"
{  "message": "Success",  "meta": {    "total_count": 0,    "page_count": 0,    "current_page": 0,    "limit": 0,    "has_next_page": true,    "has_previous_page": true  },  "data": [    {      "id": "string",      "source": "+14155550100",      "destination": "+2348012345678",      "status": "queued",      "direction": "outbound",      "created_on": "2019-08-24T14:15:22Z",      "duration_seconds": 42,      "is_test_call": true,      "error_reason": "string",      "end_reason": "string",      "ringing_at": "2019-08-24T14:15:22Z",      "ended_at": "2019-08-24T14:15:22Z"    }  ]}
{  "message": "Invalid API key.",  "error": "Unauthorized",  "code": "api_key_invalid",  "statusCode": 401,  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}
{  "message": "This API key is missing the required scope: conversations:read.",  "error": "Forbidden",  "code": "insufficient_scope",  "statusCode": 403,  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}
{  "message": "Agent not found",  "error": "Not Found",  "code": "not_found",  "statusCode": 404,  "request_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6"}