List Batches

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

x-api-keystring

API Key authentication via header

statusenumOptional

Filter batches by status

Allowed values:

created_afterdatetimeOptional

Filter batches created after this datetime (ISO 8601 format)

created_beforedatetimeOptional

Filter batches created before this datetime (ISO 8601 format)

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.

Allowed values:

metricsobject

Metrics about the batch processing progress.

outputUrlstring

The URL to download the batch results file (available when completed).

webhookUrlstring

The webhook URL for batch status notifications.

401

Unauthorized Error

500

Internal Server Error

1	[
2	{
3	"id": "batch_abc123",
4	"created_at": "2024-01-15T10:30:00Z",
5	"status": "COMPLETED",
6	"metrics": {
7	"total_generations": 5,
8	"success_count": 4,
9	"failed_count": 1,
10	"pending_count": 0
11	},
12	"outputUrl": "https://api.sync.so/v2/batches/batch_abc123/result",
13	"webhookUrl": "https://your-webhook-url.com/batch-webhook"
14	},
15	{
16	"id": "batch_def456",
17	"created_at": "2024-01-14T15:20:00Z",
18	"status": "PROCESSING",
19	"metrics": {
20	"total_generations": 10,
21	"success_count": 3,
22	"failed_count": 0,
23	"pending_count": 7
24	},
25	"outputUrl": ""
26	}
27	]

1	curl https://api.sync.so/v2/batch \
2	-H "x-api-key: <apiKey>"