Mail API reference

Mail API · Broadcasts

get/v1/workspaces/{workspace_id}/broadcastsAuth

List broadcasts, newest first

Path parameters

workspace_id*string · uuid

Id of the workspace.

Query parameters

limitinteger

Page size. Defaults to 20; values above 100 are clamped to 100.

cursorstring

Opaque cursor from the previous page's `pagination.next_cursor`. Omit for the first page.

statusenum (5)

Only broadcasts in this status.

Response · 200

data*array

The broadcasts on this page, newest first.

pagination*object
next_cursor*string

Opaque cursor for the next page. `null` when no more pages are available.

Example: "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNS0wMVQwMDowMDowMFoifQ"

has_more*boolean

True iff another page exists; if true, pass `next_cursor` on the next request.

Example: false

Example

Request

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

Response

{
  "data": [
    {
      "id": "00000000-0000-0000-0000-000000000000",
      "name": "October product update",
      "from": "Acme <news@acme.com>",
      "subject": "What shipped in October",
      "template_name": "october-update",
      "html": "string",
      "text": "string",
      "segment_id": "00000000-0000-0000-0000-000000000000",
      "topic_id": "00000000-0000-0000-0000-000000000000",
      "status": {},
      "scheduled_at": "2026-01-01T00:00:00.000Z",
      "started_at": "2026-01-01T00:00:00.000Z",
      "completed_at": "2026-01-01T00:00:00.000Z",
      "canceled_at": "2026-01-01T00:00:00.000Z",
      "rate_per_minute": 0,
      "failure_reason": "string",
      "counts": {},
      "created_at": "2026-01-01T00:00:00.000Z",
      "updated_at": "2026-01-01T00:00:00.000Z"
    }
  ],
  "pagination": {
    "next_cursor": "eyJjcmVhdGVkX2F0IjoiMjAyNi0wNS0wMVQwMDowMDowMFoifQ",
    "has_more": false
  }
}