Notify API reference

Notify API · Notifications

get/v1/workspaces/{workspace_id}/batchesAuth

List batches

Batches of notification types with `batch` (a window or a digest), newest first: one per recipient and key value while collecting (`open`), then `flushed` once its one message went out. Filter by `recipient`, `type` and `state`. Pass `next_cursor` as `cursor` until `has_more` is false.

Path parameters

workspace_id*string · uuid

Id of the workspace.

Query parameters

recipientstring

Only this recipient (external id).

typestring

Only this notification type key.

stateenum (3)

Only batches in this state.

cursorstring

Opaque cursor for pagination: the `next_cursor` of the previous page.

limitinteger

Page size.

Response · 200 A page of batches.

data*array

Batches, newest first.

pagination*object

The cursor for the next page.

Example

Request

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

Response

{
  "data": [
    {
      "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"
    }
  ],
  "pagination": {}
}