Get a broadcast
Retrieves a single broadcast by ID. Optionally includes template details for each variation.
get/api/broadcasts.get
Query parameters
workspace_idstring required
The ID of the workspace
idstring required
The ID of the broadcast
with_templatesboolean
Include full template details for each variation
Response
Broadcast retrieved successfully
Example response
{
"broadcast": {
"id": "broadcast_12345",
"workspace_id": "ws_1234567890",
"name": "Spring Newsletter 2024",
"channel_type": "email",
"status": "draft",
"audience": {
"list": "newsletter",
"segments": [
"premium_users"
],
"exclude_unsubscribed": true
},
"schedule": {
"scheduled_date": "2024-03-15",
"scheduled_time": "10:30",
"timezone": "America/New_York"
},
"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"
}
]
},
"utm_parameters": {
"source": "newsletter",
"medium": "email",
"campaign": "spring_2024"
},
"data_feed": {
"global_feed": {
"enabled": true,
"url": "https://api.example.com/broadcast-data",
"headers": [
{
"name": "Authorization",
"value": "Bearer token123"
}
]
},
"recipient_feed": {
"enabled": true,
"url": "https://api.example.com/recipient-data",
"headers": [
{
"name": "Authorization",
"value": "Bearer token123"
}
]
}
},
"winning_template": "template_winner",
"enqueued_count": 1000
}
}