Retrieve a batch

GET/api/v1/email/batches/{id}

GET /email/batches/{id}

curl -X GET 'https://www.unitpost.com/api/v1/email/batches/batch_123' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -H 'User-Agent: my-app/1.0'

Response · 200

{
  "object": "batch",
  "id": "id_123",
  "count": 1,
  "scheduled_at": "2026-01-01T00:00:00.000Z",
  "created_at": "2026-01-01T00:00:00.000Z",
  "status_counts": {},
  "cancelable": 0
}

Retrieve a batch and its live, per-status rollup (how many of its messages are queued, sent, delivered, bounced, and so on). The counts update as the batch progresses. Create a batch with Send a batch of emails, or stop its remaining messages with Cancel a batch. Requires the emails:read capability.

Parameters1 field

Field	Type	Description
`id`required	string · path	—

Response · 200 fields7 fields

Field	Type	Description
`object`required	enumbatch	—
`id`required	string	—
`count`required	integer	—
`scheduled_at`required	string	—
`created_at`required	string	—
`status_counts`required	object	Live child counts keyed by status (e.g. { delivered: 98, failed: 2 }).
`cancelable`required	integer	—

200401403404

Retrieve a batch

Retrieve a batch

Search docs and guides