Get Broadcast

Retrieve the details of a specific broadcast.

GET/broadcasts/{broadcast_id}

Requires a full_access API key.

Path Parameters

broadcast_idstringrequired

The broadcast ID (UUID).

Response Fields

objectstring

Always "broadcast".

idstring

The broadcast ID.

segment_idstring

The target segment ID.

topic_idstring | null

The topic ID if scoped to a topic.

fromstring

Sender email address.

reply_tostring[]

Reply-to email addresses.

subjectstring

Email subject.

htmlstring | null

HTML content.

textstring | null

Plain text content.

namestring | null

Internal broadcast name.

statusstring

Broadcast status: "draft", "queued", "sending", or "sent".

created_atstring

ISO 8601 timestamp.

updated_atstring

ISO 8601 timestamp.

scheduled_atstring | null

ISO 8601 timestamp if the broadcast is scheduled.

sent_atstring | null

ISO 8601 timestamp when the broadcast was sent.

curl -X GET 'https://api.postflare.app/broadcasts/d4e5f6a7-b8c9-0123-defa-234567890123' \
  -H 'Authorization: Bearer re_xxxxxxxxx'

const response = await fetch(
  'https://api.postflare.app/broadcasts/d4e5f6a7-b8c9-0123-defa-234567890123',
  {
    headers: {
      'Authorization': 'Bearer re_xxxxxxxxx',
    },
  }
);

const data = await response.json();

Response

{
  "object": "broadcast",
  "id": "d4e5f6a7-b8c9-0123-defa-234567890123",
  "segment_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "topic_id": null,
  "from": "Acme <newsletter@acme.com>",
  "reply_to": [],
  "subject": "Our Monthly Newsletter",
  "html": "<p>Hello!</p>",
  "text": null,
  "name": "April Newsletter",
  "status": "draft",
  "created_at": "2026-01-01T00:00:00.000Z",
  "updated_at": "2026-01-01T00:00:00.000Z",
  "scheduled_at": null,
  "sent_at": null
}