Skip to main content
GET
List batches for an orchestration address

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

userId
string
required

ID of the user

orchestrationAddressId
string<uuid>
required

ID of the orchestration address.

Query Parameters

status
enum<string>

Filter batches by status.

Available options:
PENDING,
PROCESSING,
COMPLETED,
FAILED
createdAfter
string<date-time>

Inclusive lower bound on createdAt (ISO 8601). Only records created at or after this timestamp are returned.

createdBefore
string<date-time>

Cursor for the next page. Pass the previous response's nextCursor value to return records created strictly before that timestamp.

limit
integer
default:50

Maximum number of records to return. 1–200, defaults to 50.

Required range: 1 <= x <= 200

Response

A paginated list of batches for the named orchestration address.

Paginated list of batches for an orchestration address.

count
integer
records
object[]
nextCursor
string<date-time> | null

Pass this value as createdBefore to retrieve the next page. null means no next page is advertised.