GET
List batches

Authorizations

Authorization
string
header
required

The caller's id_token from authentication — the ID token, not the access_token. The program and environment come from the token.

Query Parameters

limit
integer
default:50

Maximum number of batches to return. Values above 1000 are clamped to 1000. Invalid values include 0, negative numbers, non-integer strings, and mixed strings such as 10abc.

Required range: x >= 1
nextToken
string

Pagination token returned by a previous response.

lookbackDays
integer
default:30

Lookback window for program-admin searches. Invalid values include 0, negative numbers, non-integer strings, and mixed strings such as 10abc.

Required range: x >= 1
drafts
enum<string>

Set to true to list batches awaiting submission instead of submitted ones. Omit it and the response is unchanged. Drafts are held in separate indexes, so this selects a different query rather than filtering the normal one — a draft never appears in the default listing. Only the exact string true enables it.

Available options:
true
includeItemSummary
enum<string>

Set to true to include the per-batch item summary — itemsStatus (counts by item status) and totalAmount (the sum of item amounts). Omit it and both fields are absent. Available to every role, including customer callers. Only the exact string true enables it. Has no effect with drafts=true, which has no item rows to summarise.

Available options:
true

Response

Batches. The example shows a response to ?includeItemSummary=true.

success
boolean
Example:

true

data
object