Skip to navigation

List batch items

Authentication

AuthorizationApi-Key

Type “Api-Key” followed by a space and the project API key.

Path parameters

batch_uuidstringRequired
Batch UUID

Query parameters

page_sizeintegerOptional1-200Defaults to 50

The maximum number of items in one page. The SDK method returns a pager. In Python, .items holds only the first page. In TypeScript, .data holds only the first page. To read every page, iterate the pager: use for or list(...) in Python, or for await in TypeScript. In Go, the method returns one page, and Iterator() reads all pages.

cursorstringOptional
Opaque page cursor

Response

OK
itemslist of objectsOptional
The batch items on this page.
next_cursorstringOptional
Opaque cursor for retrieving the next page, present only when more results are available.
total_sizeintegerOptional
The total number of items in the batch that match the request.

Errors

400
Bad Request Error
401
Unauthorized Error
404
Not Found Error