Skip to main content
GET
List calls

Authorizations

Authorization
string
header
required

Tenant API key (vdx_live_…) as Authorization: Bearer.

Query Parameters

limit
integer
default:25
Required range: 1 <= x <= 100
offset
integer
default:0
Required range: x >= 0
q
string

Free text over either number, the agent's name, the contact's name and the call id.

from
string<date-time>

Calls that started at or after this instant (ISO 8601).

to
string<date-time>

Calls that started before this instant (ISO 8601). Exclusive.

direction
string

Comma-separated inbound, outbound, web, unknown.

Example:

"inbound,outbound"

retries
enum<string>

1 for only the calls that were a second or later attempt at the same batch row.

Available options:
1
status
string

Comma-separated callStatus values (see CallListItem).

Example:

"no_answer,busy"

assistantId
string

Comma-separated assistant uuids.

batchId
string

Comma-separated batch uuids. none matches calls no batch placed.

campaignId
string

Comma-separated campaign uuids — every batch the campaign has dialled, all blocks included.

outcome
string

Comma-separated outcome keys (the assistant's outcomes[].key). none matches calls with no outcome.

Example:

"renewed,callback-requested"

minBilled
integer

Calls billed for at least this many seconds.

Required range: x >= 0
maxBilled
integer

Calls billed for fewer than this many seconds.

Required range: x >= 0

Response

A page of calls.

calls
object[]
total
integer
statusCounts
object

How many of total are in each callStatus. Absent without a database.

limit
integer
offset
integer