Skip to main content
GET
List rows

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Query Parameters

status
string

Comma-separated: pending,dialing,done,failed,skipped_suppressed,callback_scheduled,cancelled.

rowRef
string
endReason
string
blockNo
integer

Only rows in this block of a ranged batch. The block's row range is resolved server-side, so it stays correct across a resize. A block number the batch does not have matches nothing.

Required range: x >= 1
q
string

Free-text match over the row's number, reference, status and end reason. Narrows within status and blockNo rather than replacing them.

sort
enum<string>

seq orders by upload position, which never changes once assigned. Use it for anything paging the whole list: the default order is by last update, and the dialer rewrites that field, so a row settling between two pages moves and an offset walk repeats it while missing another.

Available options:
seq
limit
integer
default:50
Required range: 1 <= x <= 500
offset
integer
default:0
Required range: x >= 0
include
enum<string>

recordingUrl signs a link per row, one IAM call each — omitted by default, so a poll (the console refreshes a running batch every few seconds) does not pay for it. Ask for it only where you intend to read every row returned, such as a CSV export.

Available options:
recordingUrl

Response

A page of rows.

rows
object[]
total
integer

Rows matching every filter, including status.

counts
object

Row counts by status for blockNo and q, ignoring status itself, plus total. A client showing one chip per status can keep every count truthful while one of them is switched on.

limit
integer
offset
integer