API referenceBatches

List batches

Return a list of batches. Use query parameters to filter results.

Headers

AuthorizationstringRequired

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

IB-ContextstringOptional

Specify whether to use your community account or organization account to complete the request. To use your community account, define as your user ID. To use your organization account, define as your organization ID. If unspecified, defaults to community account context. See Authorization and context identification for details.

Query parameters

workspacestringOptional
Filter to batches in the specified workspace.
usernamestringOptional

Filter to batches created by the specified username (user ID).

limitintegerOptional
If paginating results, specify how many batches to return.
file_offsetintegerOptional
If paginating results, specify the offset of the returned list.

Response

Request successful.
batcheslist of objectsOptional
List of batches. See response schema for each batch object.