Notify API reference

Notify API · Notifications

get/v1/workspaces/{workspace_id}/batches/{batch_id}Auth

Get a batch

The notifications collected in it, its deliveries (while open, `scheduled: batched`; after it closes, one carrier per channel with its outcome, the rest `skipped: batched_into`), and the `batch` data templates got.

Path parameters

workspace_id*string · uuid

Id of the workspace.

batch_id*string · uuid

The batch id (from a delivery's `batch_id`, or the list).

Response · 200 The batch.

id*string · uuid

The batch id.

type*string

The notification type key.

Example: "comment.created"

recipient*string

The recipient external id (null once erased).

Example: "user_123"

key*string

The value of the type's batch `key` in the sends (empty: one batch per recipient).

Example: "p_42"

state*object

`open` (collecting), `flushed` (sent as one message), `cancelled` (every notification in it was cancelled).

item_count*integer

Notifications in the batch.

opened_at*string · date-time

When the first notification opened it.

flush_at*string · date-time

When it closes (or closed): the window end or the digest time. A sliding window moves it.

flushed_at*string · date-time

When it was closed.

notification_ids*array

The notifications in the batch, oldest first (the first 100).

deliveries*array

Its deliveries on the batched channels: while open, one `scheduled: batched` per notification and channel; after the flush, the carrier per channel with its outcome.

payload*object

What templates got as `batch` when it closed (`count`, `items`, `actors`, …); null while open.

Example

Request

GET https://api.notify.productcraft.co/v1/workspaces/{workspace_id}/batches/{batch_id}
Authorization: Bearer YOUR_TOKEN

Response

{
  "id": "00000000-0000-0000-0000-000000000000",
  "type": "comment.created",
  "recipient": "user_123",
  "key": "p_42",
  "state": {},
  "item_count": 0,
  "opened_at": "2026-01-01T00:00:00.000Z",
  "flush_at": "2026-01-01T00:00:00.000Z",
  "flushed_at": "2026-01-01T00:00:00.000Z",
  "notification_ids": [
    "00000000-0000-0000-0000-000000000000"
  ],
  "deliveries": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "notification_id": "00000000-0000-0000-0000-000000000000",
      "channel": "string",
      "state": "string",
      "reason": "string"
    }
  ],
  "payload": {}
}