API

一斉配信を一覧する

このワークスペースのすべての一斉配信を新しい順に 1 ページずつ、それぞれ最新の `counts` 付きで返します。`audienceId` を指定すると、そのオーディエンスに（単独でも他と一緒でも）送られたものだけが残ります。

GETapi.openemail.uk/broadcasts

実際の呼び出しを、ご自身のキーで自分のワークスペースに対して実行します。

GET /broadcasts

このワークスペースのすべての一斉配信を新しい順に 1 ページずつ、それぞれ最新の counts 付きで返します。audienceId を指定すると、そのオーディエンスに（単独でも他と一緒でも）送られたものだけが残ります。

例

emails:read が必要です。limit は最大 100 でデフォルトは 25、cursor には前のページの nextCursor、つまりその最後の一斉配信の ID を渡します。

curl

curl "$OE/broadcasts?audienceId=aud_4c1b8e2a7d9f05c36b4e8a71&limit=10" -H "$AUTH"

レスポンス

{  "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}

個々のメッセージはここにはありません。1 つの一斉配信のコピーは GET /emails?broadcastId= で一覧します。

このワークスペースのどの一斉配信も指さないカーソルは 400 invalid_cursor になります。どのオーディエンスも指さない audienceId には空のページが返ります。