List batches

GET/api/v1/email/batches

GET /email/batches

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

Response · 200

{
  "object": "list",
  "has_more": false,
  "data": [
    {
      "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
    }
  ]
}

Your batch sends, newest first and cursor-paginated, as the dashboard's Batches tab lists them. Each is the same live rollup Retrieve a batch returns: how many emails it holds, when it's scheduled, a count per delivery status and how many are still cancelable. Requires the emails:read capability.

Parameters3 fields

Field	Type	Description
`limit`	integer · query	Max rows to return (default 20, max 100).
`after`	string · query	Return rows after this id (forward paging).
`before`	string · query	Return rows before this id (backward paging).

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	—

200401403422

List batches

List batches

Search docs and guides