Skip to main content
GET
Fetch a batch

Authorizations

Authorization
string
header
required

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

Path Parameters

id
string<uuid>
required

Query Parameters

run
integer

Historic run number for endReasons.

Response

The batch.

id
string<uuid>
name
string
status
enum<string>
Available options:
running,
paused,
completed,
cancelled,
failed
runNo
integer
assistantId
string<uuid>

The assistant's uuid, shown on its configure page in the console. Names and slugs are not accepted.

concurrency
integer
retry
object
window
object | null

When this batch may dial — outside it, rows wait rather than fail.

suppress
string[]
createdAt
string<date-time> | null
startedAt
string<date-time> | null
completedAt
string<date-time> | null
counts
object

Row counts by status, plus total.

countsScope
integer

The run counts describes — always the current one.

run
integer

The run endReasons describes.

endReasons
object
runRows
integer

Present only for a historic ?run=.

runAttempts
integer

Present only for a historic ?run=.

from
object
runs
object[]
pacing
object

Why the batch is going as fast (or as slowly) as it is.