v1

latestOpenAPI 3.1.02026-08-0458234268.6 KB

batch

List batches

Returns a paginated list of batch jobs belonging to the authenticated user, sorted by last modified time descending. Use the status filter to narrow results to in-progress or completed batches. Use date_from / date_to to filter by last modified time range.

get/batch

Query parameters

status'processing' | 'completed'

Filter by batch status. processing returns in-progress batches; completed returns finished batches.

date_fromstring date-time

Return only batches last modified at or after this ISO 8601 datetime (e.g. 2024-01-01T00:00:00Z).

date_from_utcstring date-time

UTC filter. Accepts ISO 8601 with optional Z/offset, or YYYY-MM-DD[ HH:MM:SS] (assumed UTC). Takes precedence over the non-_utc variant.

date_tostring date-time

Return only batches last modified at or before this ISO 8601 datetime (e.g. 2024-12-31T23:59:59Z).

date_to_utcstring date-time

UTC filter. Accepts ISO 8601 with optional Z/offset, or YYYY-MM-DD[ HH:MM:SS] (assumed UTC). Takes precedence over the non-_utc variant.

limitinteger

Number of results per page (default 20).

pageinteger

Page number.

Headers

Authorizationstring required

OAuth2 authentication flows. Auth server URLs will vary by environment

X-Api-Keystring required

API key for authentication

X-API-Versionstring

API version to use (optional, defaults to latest). Supported values: 1.0.0, 1.1.0.

Response

Paginated list of batch jobs

countinteger

Total number of batches matching the filter