List batches

GET/v1/batches

Lists your batches, a page at a time.

Query parameters

limitinteger

Default 25
cursorstring
statusstring

One or more of draft, scheduled, sending, following_up, completed, cancelled, comma-separated.
follow_up_policy_idstring
created_bystring

The member (usr_…) who made the batch.
created_afterstring · date-time
created_beforestring · date-time
qstring

Part of the name, or the exact bat_ id.
sortstring

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_deliveriesboolean

true: only drafts and open rolling batches, the ones a delivery can join now. false: the others.

Returns

200 application/json. Paginated list.

Errors have one shape; see Errors for every code.

Code language

Request

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

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

import os, requests

res = requests.get(
    "https://api.parasend.com/v1/batches",
    headers={
        "Authorization": f"Bearer {os.environ['PARASEND_KEY']}",
    },
)
data = res.json()

using var http = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Get, "https://api.parasend.com/v1/batches");
request.Headers.Authorization = new AuthenticationHeaderValue("Bearer", Environment.GetEnvironmentVariable("PARASEND_KEY"));
var response = await http.SendAsync(request);
var body = await response.Content.ReadAsStringAsync();

var request = HttpRequest.newBuilder(URI.create("https://api.parasend.com/v1/batches"))
    .header("Authorization", "Bearer " + System.getenv("PARASEND_KEY"))
    .GET()
    .build();
var response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());

$client = new GuzzleHttp\Client();
$response = $client->request('GET', 'https://api.parasend.com/v1/batches', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('PARASEND_KEY'),
    ],
]);
$data = json_decode($response->getBody(), true);

Response · 200

{
  "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
}