List batches

Lists batches in the workspace of the authenticating API key, newest first. To fetch the next page, pass the previous page's last_id as after. List items omit results. Use GET /batches/{id} to get them. See the Batch API Quickstart.

limitinteger

Maximum number of batches to return, from 1 through 100.

Example:20

Maximum number of batches to return, from 1 through 100.

afterstring

Batch id from the previous page's last_id.

Example:batch_7a4b02

Batch id from the previous page's last_id.

statusBatchListStatus[]

Repeat this parameter to include more than one status.

[
  "completed",
  "failed"
]

string

OR

string date

OR

string date-time

Only include batches created strictly after this timestamp.

string

Only include batches created strictly before this timestamp.

OR

string date

Only include batches created strictly before this timestamp.

OR

string date-time

Only include batches created strictly before this timestamp.

Response

A newest-first page of batches.

first_idstring nullable required

has_moreboolean required

last_idstring nullable required

object'list' required

Example response

{
  "data": [],
  "first_id": null,
  "has_more": false,
  "last_id": null,
  "object": "list"
}

List batches

Query parameters

Response

Example response

Changes