Skip to the documentation
API

List broadcasts

Every broadcast in this workspace, newest first, one page at a time, each with live `counts`. `audienceId` keeps the ones that were sent to that audience, alone or beside others.

GETapi.openemail.uk/broadcasts

Runs the real call against your workspace, with your own key.

GET /broadcasts

Every broadcast in this workspace, newest first, one page at a time, each with live counts. audienceId keeps the ones that were sent to that audience, alone or beside others.

Example

Needs emails:read. limit goes up to 100 and defaults to 25, and cursor takes the previous page's nextCursor, the id of its last broadcast.

curl
curl "$OE/broadcasts?audienceId=aud_4c1b8e2a7d9f05c36b4e8a71&limit=10" -H "$AUTH"
Response
{  "object": "list",  "data": [    {      "object": "broadcast",      "id": "brd_5a8c1e3f7b2d94a06c8e1f3b",      "status": "sending",      "mode": "live",      "source": "api",      "audienceIds": ["aud_4c1b8e2a7d9f05c36b4e8a71"],      "from": "Acme <[email protected]>",      "subject": "{{firstName|Hello}}, the September release is out",      "counts": {        "recipients": 412,        "created": 250,        "skipped": 1,        "failedToQueue": 0,        "queued": 38,        "sending": 2,        "sent": 209,        "failed": 1,        "cancelled": 0      },      "lastError": null,      "scheduledAt": null,      "startedAt": "2026-09-23T12:00:02.000Z",      "completedAt": null,      "cancelledAt": null,      "createdAt": "2026-09-23T12:00:00.000Z",      "updatedAt": "2026-09-23T12:00:41.000Z"    }  ],  "hasMore": false,  "nextCursor": null}

The individual messages are not here. List the copies of one broadcast with GET /emails?broadcastId=.

A cursor that names no broadcast in this workspace is a 400 invalid_cursor. An audienceId that names no audience answers an empty page.