Skip to main content
GET
List all batches on a ledger

Authorizations

Authorization
string
header
required

Path Parameters

ledger_id
string
required

Ledger friendly ID (e.g., led_abc123def456)

Query Parameters

page
integer<int32>
default:1
page_size
integer<int32>
default:10
sort
string

Comma-separated list of fields to sort by. Prefix with - for descending. Available fields: id, start_time, end_time, created_at, updated_at, tracking_id, friendly_id

Example:

"-start_time,created_at"

filter[id][eq]
string

Filter by exact batch ID (friendly_id)

filter[state][eq]
string
filter[tracking_id][eq]
string
filter[friendly_id][eq]
string
filter[start_time][geq]
string<date-time>
filter[start_time][leq]
string<date-time>
filter[end_time][geq]
string<date-time>
filter[end_time][leq]
string<date-time>
response_mode
enum<string>

Controls response format. default returns paginated data. summary returns count and 10 samples. summary_with_export returns summary and triggers an async export.

Available options:
default,
summary,
summary_with_export
export_format
enum<string>
default:csv

File format for async export (only with response_mode=summary_with_export). Default: csv.

Available options:
csv,
json

Response

200

data
object[]
info
object