Ir para a navegação
Batch API

List Batches

List all batches for your organization with optional filtering by status and creation date. Results are ordered by creation date (newest first).

Autenticação

x-api-keystring
Autenticação de chave de API via cabeçalho

Parâmetros de consulta

statusenumOpcional
Filter batches by status
Valores permitidos:
created_afterdatetimeOpcional

Filter batches created after this datetime (ISO 8601 format)

created_beforedatetimeOpcional

Filter batches created before this datetime (ISO 8601 format)

Resposta

This endpoint returns a list of objects.
idstring
A unique identifier for the batch.
created_atdatetime
The date and time the batch was created.
statusenum
The current status of the batch.
Valores permitidos:
metricsobject
Metrics about the batch processing progress.
outputUrlstring
The URL to download the batch results file when completed. A GET request follows a 302 redirect to a signed JSONL result URL.
webhookUrlstringOpcional

The webhook URL for batch status notifications. Deliveries include a Sync-Signature header signed with the organization webhook secret.

Erros

401
Unauthorized Error
500
Internal Server Error