API referenceBroadcasts

List broadcasts

GET
/v1/broadcasts

Newest-first keyset page over (created_at, id).

Authorization

bearerAuth
headerAuthorizationBearer <token>

API key sent as Authorization: Bearer <key>. Looked up by SHA-256 hash (email_core::sha256_hex) against api_keys.hash; revoked keys and keys belonging to a suspended tenant are rejected. See the top-level Authentication section for permission levels.

Query Parameters

limit?integer

Max rows to return.

Range1 <= value <= 100
Default25
cursor?string

Response Body

Broadcast list.

application/json
  1. response
data?array<>
next_cursor?string|null
curl -X GET "https://example.com/v1/broadcasts"
{  "data": [    {      "id": "string",      "name": "string",      "subject": "string",      "from_domain_id": "string",      "body_html": "string",      "body_text": "string",      "target_kind": "audience",      "target_id": "string",      "status": "draft",      "scheduled_at": 0,      "total_recipients": 0,      "sent_count": 0,      "created_at": 0,      "updated_at": 0,      "sent_at": 0    }  ],  "next_cursor": "string"}