List Batches
Returns a paginated list of your Bulk Client Import batches in all statuses. Use it to find an existing batch, check how many batches are still open against the limit of 3, or recover a batch_id you did not store.
Endpoint
GET /v2/compliance/batch
Link
Request
Headers
Authorization
<JWT>
Yes
Accept
application/json
Yes
Query Parameters
page
integer
Page number, starting at 1.
No
1
page_size
integer
Number of batches per page.
No
20
Response (200 OK)
Returns a ListBatchesResponse.
Response Fields
batches
array[object]
Batch objects. See Create Batch → Response Fields.
—
page
integer
Current page.
1
page_size
integer
Page size.
20
total
integer
Total number of batches.
2
Example Response:
Examples
Request
Error Responses
Errors are returned as {"code", "message", "details"}, where code is a gRPC status code. Use the HTTP status for error handling.
Authorization fail (401):
Notes
Open-batch limit: count batches with status
OPEN,CLOSEDorCHANGE_REQUESTEDto see how close you are to the limit of 3.Details: the list returns the same
Batchobject as Get Batch, including counters.
Last updated

