API · Broadcasts

Retrieve Broadcast

Retrieve a broadcast (requires full access).

GET/broadcasts/{id}Full access

Request parameters

Parameter	Type	Description
`id` path · required	`string`	Opaque resource id.

Request example

Set OPENSEND_BASE_URL=https://api.example.com and OPENSEND_API_KEY=os_replace_me on your server.

bash

curl -X GET "$OPENSEND_BASE_URL/broadcasts/YOUR_id" \
  -H "Authorization: Bearer $OPENSEND_API_KEY"

Response

200 · application/json. Example IDs stand for IDs returned by your installation.

json

{
  "object": "broadcast",
  "id": "YOUR_ID",
  "name": "example",
  "segment_id": "YOUR_SEGMENT_ID",
  "audience_id": "YOUR_AUDIENCE_ID",
  "status": "draft",
  "created_at": "example",
  "scheduled_at": "example",
  "sent_at": "example",
  "from": "example",
  "subject": "example",
  "reply_to": [
    "example"
  ],
  "preview_text": "example",
  "html": "example",
  "text": "example",
  "topic_id": "YOUR_TOPIC_ID"
}

Behavior and errors

The queued state appears as Sending in the dashboard. Sent means eligible recipient copies settled; subsequent delivery feedback still updates the report.

Use a full-access credential. Resource IDs belong to your team; an unknown or foreign resource returns 404. See authentication, errors, rate limits, and compatibility for the shared contract.