List broadcasts

Retrieves a list of broadcasts with pagination and optional filtering by status. Supports fetching template details for each variation.

get/api/broadcasts.list

Query parameters

workspace_idstring required

The ID of the workspace

Filter broadcasts by status

limitinteger

Maximum number of broadcasts to return

offsetinteger

Number of broadcasts to skip for pagination

with_templatesboolean

Include full template details for each variation

Response

List of broadcasts retrieved successfully

total_countinteger

Total number of broadcasts matching the query

Example response

{
  "broadcasts": [
    {
      "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
    }
  ],
  "total_count": 45
}

Changes

Changed in 5 of the 25 revisions of this API.249

Feb 8, 2026b6f612d3daaa1See the full diff
- ○
  added the optional property broadcasts/items/data_feed to the response with the 200 status
  response-optional-property-added
Dec 31, 2025e42f05599d8a23See the full diff
- ●
  added the new processed enum value to the broadcasts/items/status response property for the response status 200
  response-property-enum-value-added
- ●
  added the new processing enum value to the broadcasts/items/status response property for the response status 200
  response-property-enum-value-added
- ○
  added the optional property broadcasts/items/enqueued_count to the response with the 200 status
  response-optional-property-added
- ○
  removed the sending enum value from the broadcasts/items/status response property for the response status 200
  response-property-enum-value-removed
- ○
  removed the sent enum value from the broadcasts/items/status response property for the response status 200
  response-property-enum-value-removed
Nov 29, 2025c39acad12e49121See the full diff
- ▲
  removed the required property broadcasts/items/audience/lists from the response with the 200 status
  response-required-property-removed
- ●
  removed the optional property broadcasts/items/audience/skip_duplicate_emails from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property broadcasts/items/sent_at from the response with the 200 status
  response-optional-property-removed
- ○
  added the required property broadcasts/items/audience/list to the response with the 200 status
  response-required-property-added
Nov 14, 20256f682a51f76f13See the full diff
- ▲
  removed the required property broadcasts/items/audience/list from the response with the 200 status
  response-required-property-removed
- ○
  added the optional property broadcasts/items/audience/skip_duplicate_emails to the response with the 200 status
  response-optional-property-added
- ○
  added the optional property broadcasts/items/sent_at to the response with the 200 status
  response-optional-property-added
- ○
  added the required property broadcasts/items/audience/lists to the response with the 200 status
  response-required-property-added
Nov 14, 2025940c5636d0b41See the full diff
- ○
  endpoint added
  endpoint-added

Full history