# List batches

`GET https://api.parasend.com/v1/batches`

Source: https://parasend.com/docs/api/batches/list

Authentication: `Authorization: Bearer <API key>` (a `ps_test_` key in test mode, `ps_live_` in live mode).

Lists your batches, a page at a time.

## Query parameters

- `limit` (integer, optional): Default: `25`.
- `cursor` (string, optional)
- `status` (string, optional): One or more of draft, scheduled, sending, following_up, completed, cancelled, comma-separated.
- `follow_up_policy_id` (string, optional)
- `created_by` (string, optional): The member (usr_…) who made the batch.
- `created_after` (string · date-time, optional)
- `created_before` (string · date-time, optional)
- `q` (string, optional): Part of the name, or the exact bat_ id.
- `sort` (string, optional): Sort by `name` or by `status` (in the order a batch moves through), newest first within each. One of: `created_desc`, `created_asc`, `name_asc`, `name_desc`, `status_asc`, `status_desc`. Default: `"created_desc"`.
- `accepting_deliveries` (boolean, optional): true: only drafts and open rolling batches, the ones a delivery can join now. false: the others.

## Example: List batches

```bash
curl "https://api.parasend.com/v1/batches" \
  -H "Authorization: Bearer $PARASEND_KEY"
```

```js
const res = await fetch('https://api.parasend.com/v1/batches', {
  method: 'GET',
  headers: {
    Authorization: `Bearer ${process.env.PARASEND_KEY}`,
  },
});
const data = await res.json();
```

## Response 200

Paginated list.

```json
{
  "data": [
    {
      "id": "bat_01M6R27T8SXWNM911FS53W4S9F",
      "object": "batch",
      "name": "November notices",
      "status": "draft",
      "sending_mode": "on_finalize",
      "follow_up_policy_id": null,
      "allow_policy_override": true,
      "follow_ups_paused": false,
      "scheduled_at": null,
      "send_window": {
        "tz": "Atlantic/Reykjavik",
        "end": "21:00",
        "start": "09:00"
      },
      "defaults": {},
      "files": [],
      "accepting_deliveries": true,
      "counts": {
        "total": 0,
        "delivered": 0,
        "in_progress": 0,
        "ended": 0
      },
      "created_by": {
        "user_id": "usr_01M6R27SYD4B50414S0BZ4KBKR",
        "via": "api_key"
      },
      "livemode": false,
      "created": "2026-11-06T09:15:05.881Z",
      "sent_out_at": null,
      "following_up_at": null,
      "completed_at": null,
      "cancelled_at": null
    }
  ],
  "has_more": false,
  "next_cursor": null
}
```

Errors: one shape, `{"error": {type, code, message, param, request_id}}`; every code is listed at https://parasend.com/docs/errors.