API OverviewBatches

List batches

List your organization's batches, newest first.

Authentication

AuthorizationBearer
Your production key sent as a bearer token.

Query parameters

limitintegerOptionalDefaults to 20

Batches per page; values outside 1 to 100 are clamped.

afterstringOptional

Return batches after this batch ID (the previous page’s last_id).

statuslist of stringsOptional

Filter by status; repeat to match several.

created_afterstringOptional

Only batches created at or after this time, as unix seconds or an ISO-8601 date or datetime (UTC when no offset is given).

created_beforestringOptional

Only batches created before this time, in the same formats as created_after.

Response

Successful Response
datalist of objects
object"list"OptionalDefaults to list
first_idstring or nullOptional
ID of the first batch on this page.
last_idstring or nullOptional

ID of the last batch on this page; pass it as after to get the next page.

has_morebooleanOptionalDefaults to false
Whether more batches follow this page.

Errors

422
Unprocessable Entity Error