API referenceBatches

List batches

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

Authentication

AuthorizationBearer
Bearer HTTP authentication.

Headers

IB-ContextstringOptional

Typically your organization ID. 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.
offsetintegerOptional
If paginating results, specify the offset of the returned list.

Response

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