Batch List

View as Markdown
List all batch files for the account, including each batch UUID, status, name, and creation date.

Authentication

X-API-Keystring
API Key authentication via header

Query parameters

limitintegerOptional1-1000Defaults to 100
offsetintegerOptional>=0Defaults to 0
from_datedatetime or nullOptional
to_datedatetime or nullOptional

Response

Successful Response
batch_uuidstringformat: "uuid"
namestring
descriptionstring or null
created_atdatetime
updated_atdatetime

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error