batches

Retrieve a batch

Retrieve a batch by its ID, including its status and the IDs of all runs in the batch.

get/api/v1/batches/{batchId}

Request

Base URL
https://api.trigger.dev
Auth
HTTP bearer
TypeScript
https://skmtc.dev/triggerdotdev/apis/trigger-dev-v3-rest-api/docs/api/v1/batches/:batchId/get.ts
A function with typed inputs. Its response is checked against the schema.

Successful request

idstring

The batch ID.

status'PENDING' | 'PROCESSING' | 'COMPLETED' | 'PARTIAL_FAILED' | 'ABORTED'

The current status of the batch.

idempotencyKeystring nullable

The idempotency key provided when triggering, if any.

createdAtstring date-time

updatedAtstring date-time

runCountinteger

The total number of runs in the batch.

runsstring[]

Array of run IDs in the batch.

successfulRunCountinteger nullable

Number of successful runs (populated after completion).

failedRunCountinteger nullable

Number of failed runs (populated after completion).