List a batch's deliveries

GET/v1/batches/{id}/deliveries

Lists the batch's deliveries. q matches the title, the recipient's name or e-mail in part, or a delivery ID exactly; never a personal code or a phone number. pin, recipient_email and phone match exactly. With Accept: text/csv, every match is streamed as CSV.

Path parameters

idstringrequired

The batch's ID, starting bat_.

Query parameters

limitinteger

Default 25
cursorstring
qstring
statusstring

One of created notified opened authenticated auth_failed confirmed delivered evidence_sealed expired revoked bounced consignment_failed paper_pending_approval paper_dispatched
needs_attentionboolean
pinstring
recipient_emailstring · email
phonestring

The whole number, E.164 or 7 Icelandic digits.
outcomestring

One of delivered in_progress unreachable expired revoked not_matched
remindersinteger
policy_sourcestring

One of batch own none
channelstring

One of email sms
sortstring

Returns

200 application/json. Paginated member deliveries.

Errors have one shape; see Errors for every code.

Code language

Request

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

const res = await fetch('https://api.parasend.com/v1/batches/bat_01M6R27T8SXWNM911FS53W4S9F/deliveries', {
  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/bat_01M6R27T8SXWNM911FS53W4S9F/deliveries",
    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/bat_01M6R27T8SXWNM911FS53W4S9F/deliveries");
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/bat_01M6R27T8SXWNM911FS53W4S9F/deliveries"))
    .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/bat_01M6R27T8SXWNM911FS53W4S9F/deliveries', [
    'headers' => [
        'Authorization' => 'Bearer ' . getenv('PARASEND_KEY'),
    ],
]);
$data = json_decode($response->getBody(), true);

Response · 200

{
  "data": [
    {
      "id": "dlv_01M6R27T9M7Z1HH1FADRGGMEZK",
      "object": "delivery",
      "kind": "documents",
      "direction": "outbound",
      "content_type": "files",
      "status": "created",
      "last_activity": null,
      "title": "Final notice: invoice 2026-115",
      "message": null,
      "language": "is",
      "certificate_language": "is",
      "recipient": {
        "name": "Jón Jónsson",
        "verified_name": null,
        "verified_method": null,
        "verification_photos": [],
        "email": "jon.jonsson@example.com",
        "phone": null,
        "address": null,
        "verification_level": "high",
        "conditional_authentication": false,
        "personal_code": null,
        "id_document_number": null
      },
      "files": [
        {
          "file_id": "fil_01M6R27SZK99V6N6WG4GK15T6R",
          "path": "test-notice.pdf",
          "primary": true
        }
      ],
      "batch_id": "bat_01M6R27T8SXWNM911FS53W4S9F",
      "delivery_url": null,
      "short_url": null,
      "evidence_policy": "urn:parasend:policy:evidence:standard:1",
      "sender_display": "legal_person",
      "operator_reference": "OP-7K3Q-M2",
      "recipient_ref": "rcp_01M6R27T9M3F3MJ7NMBYGW3V30",
      "private": false,
      "options": {
        "auth_methods": [
          "audkenni",
          "smart_id",
          "passkey"
        ],
        "reminder_policy": null,
        "brand_profile_id": null,
        "expires_in_days": 30,
        "sender_display": "legal_person",
        "notify_channels": [
          "email"
        ]
      },
      "legal_hold": false,
      "deletion_scheduled_at": null,
      "livemode": false,
      "created": "2026-11-06T09:15:05.908Z",
      "expires_at": null,
      "metadata": {},
      "origin_request": null,
      "reminder_waiting": null,
      "email_waiting": null,
      "follow_up": {
        "policy_id": null,
        "policy_name": null,
        "policy_source": "batch",
        "state": "done",
        "reminders_sent": 0,
        "last_step": null,
        "next_step": null,
        "paused": false
      }
    },
    {
      "id": "dlv_01M6R27T9GD2VVC1DVVE1DD6RB",
      "object": "delivery",
      "kind": "documents",
      "direction": "outbound",
      "content_type": "files",
      "status": "created",
      "last_activity": null,
      "title": "Final notice: invoice 2026-114",
      "message": null,
      "language": "is",
      "certificate_language": "is",
      "recipient": {
        "name": "Anna Björk Jónsdóttir",
        "verified_name": null,
        "verified_method": null,
        "verification_photos": [],
        "email": "anna.bjork@example.com",
        "phone": null,
        "address": null,
        "verification_level": "high",
        "conditional_authentication": false,
        "personal_code": null,
        "id_document_number": null
      },
      "files": [
        {
          "file_id": "fil_01M6R27SZK99V6N6WG4GK15T6R",
          "path": "test-notice.pdf",
          "primary": true
        }
      ],
      "batch_id": "bat_01M6R27T8SXWNM911FS53W4S9F",
      "delivery_url": null,
      "short_url": null,
      "evidence_policy": "urn:parasend:policy:evidence:standard:1",
      "sender_display": "legal_person",
      "operator_reference": "OP-7K3Q-M2",
      "recipient_ref": "rcp_01M6R27T9GVJW7HXAWJ0T5H4EM",
      "private": false,
      "options": {
        "auth_methods": [
          "audkenni",
          "smart_id",
          "passkey"
        ],
        "reminder_policy": null,
        "brand_profile_id": null,
        "expires_in_days": 30,
        "sender_display": "legal_person",
        "notify_channels": [
          "email"
        ]
      },
      "legal_hold": false,
      "deletion_scheduled_at": null,
      "livemode": false,
      "created": "2026-11-06T09:15:05.904Z",
      "expires_at": null,
      "metadata": {},
      "origin_request": null,
      "reminder_waiting": null,
      "email_waiting": null,
      "follow_up": {
        "policy_id": null,
        "policy_name": null,
        "policy_source": "batch",
        "state": "done",
        "reminders_sent": 0,
        "last_step": null,
        "next_step": null,
        "paused": false
      }
    }
  ],
  "has_more": false,
  "next_cursor": null
}