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": {
"list": "newsletter",
"segments": [
"premium_users"
],
"exclude_unsubscribed": true
},
"schedule": {
"is_scheduled": false,
"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": [
{
"template_id": "template_variant_a",
"variation_name": "Variation 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>"
},
"data_feed": {
"global_feed": {
"enabled": true,
"url": "https://api.example.com/broadcast-data",
"headers": [
{
"name": "Authorization",
"value": "Bearer token123"
}
]
},
"global_feed_data": {},
"global_feed_fetched_at": "2023-11-07T05:31:56Z",
"recipient_feed": {
"enabled": true,
"url": "https://api.example.com/recipient-data",
"headers": [
{
"name": "Authorization",
"value": "Bearer token123"
}
]
}
},
"metadata": {},
"winning_template": "template_winner",
"test_sent_at": "2023-11-07T05:31:56Z",
"winner_sent_at": "2023-11-07T05:31:56Z",
"enqueued_count": 1000,
"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>"
}
}Retrieves a single broadcast by ID. Optionally includes template details for each variation.
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": {
"list": "newsletter",
"segments": [
"premium_users"
],
"exclude_unsubscribed": true
},
"schedule": {
"is_scheduled": false,
"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": [
{
"template_id": "template_variant_a",
"variation_name": "Variation 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>"
},
"data_feed": {
"global_feed": {
"enabled": true,
"url": "https://api.example.com/broadcast-data",
"headers": [
{
"name": "Authorization",
"value": "Bearer token123"
}
]
},
"global_feed_data": {},
"global_feed_fetched_at": "2023-11-07T05:31:56Z",
"recipient_feed": {
"enabled": true,
"url": "https://api.example.com/recipient-data",
"headers": [
{
"name": "Authorization",
"value": "Bearer token123"
}
]
}
},
"metadata": {},
"winning_template": "template_winner",
"test_sent_at": "2023-11-07T05:31:56Z",
"winner_sent_at": "2023-11-07T05:31:56Z",
"enqueued_count": 1000,
"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>"
}
}Documentation Index
Fetch the complete documentation index at: https://docs.notifuse.com/llms.txt
Use this file to discover all available pages before exploring further.
API token for authentication
The ID of the workspace
The ID of the broadcast
Include full template details for each variation
Broadcast retrieved successfully
Show child attributes