Batch List

Retrieves a paginated list of batches for your organization.

Each batch includes details such as the batch identification number, type, status, and creation date.
Use this endpoint to monitor the progress of data uploads or updates.

Typical use-cases:

  • Track the status of ongoing or completed batch operations.
  • Retrieve batch metadata for auditing or troubleshooting.

Supports pagination via limit and offset query parameters for efficient handling of large datasets.

us-east-2 eu-west-2 ap-southeast-2 ca-central-1 eu-central-1 ap-southeast-1

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Query Params
string
enum

Status filter to apply to the batches.
Example: processing

Allowed:
integer
0 to 100
Defaults to 20

Maximum number of records per page.
Example: 20

integer
≥ 0
Defaults to 0

Index of the first record to return.
Example: 0

Responses

400

Invalid request data

401

Unauthorized

500

Internal server error

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json