Skip to main content
GET
/
api
/
broadcasts.get
Get a broadcast
curl --request GET \
  --url https://{notifuseDomain}/api/broadcasts.get \
  --header 'Authorization: Bearer <token>'
{
  "broadcast": {
    "id": "broadcast_12345",
    "workspace_id": "ws_1234567890",
    "name": "Spring Newsletter 2024",
    "channel_type": "email",
    "status": "draft",
    "audience": {
      "lists": [
        "newsletter",
        "customers"
      ],
      "segments": [
        "premium_users"
      ],
      "exclude_unsubscribed": true,
      "skip_duplicate_emails": true
    },
    "schedule": {
      "is_scheduled": true,
      "scheduled_date": "2024-03-15",
      "scheduled_time": "10:30",
      "timezone": "America/New_York",
      "use_recipient_timezone": false
    },
    "test_settings": {
      "enabled": true,
      "sample_percentage": 20,
      "auto_send_winner": true,
      "auto_send_winner_metric": "open_rate",
      "test_duration_hours": 24,
      "variations": [
        {
          "variation_name": "Variation A",
          "template_id": "template_variant_a",
          "metrics": {
            "recipients": 123,
            "delivered": 123,
            "opens": 123,
            "clicks": 123,
            "bounced": 123,
            "complained": 123,
            "unsubscribed": 123
          },
          "template": {}
        }
      ]
    },
    "utm_parameters": {
      "source": "newsletter",
      "medium": "email",
      "campaign": "spring_2024",
      "term": "<string>",
      "content": "<string>"
    },
    "metadata": {},
    "winning_template": "template_winner",
    "test_sent_at": "2023-11-07T05:31:56Z",
    "winner_sent_at": "2023-11-07T05:31:56Z",
    "test_phase_recipient_count": 123,
    "winner_phase_recipient_count": 123,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "started_at": "2023-11-07T05:31:56Z",
    "completed_at": "2023-11-07T05:31:56Z",
    "cancelled_at": "2023-11-07T05:31:56Z",
    "paused_at": "2023-11-07T05:31:56Z",
    "pause_reason": "<string>",
    "sent_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

Authorization
string
header
required

API token for authentication

Query Parameters

workspace_id
string
required

The ID of the workspace

id
string
required

The ID of the broadcast

with_templates
boolean
default:false

Include full template details for each variation

Response

Broadcast retrieved successfully

broadcast
object