email-broadcasts

List broadcasts

Returns a paginated list of broadcasts in the workspace, newest first. created_after and created_before narrow the list to broadcasts created in a half-open window, which is how you page a single month or quarter rather than the whole history.

get/v1/email/broadcasts

Request

  • Base URL: https://us1.platform.bird.com
  • URL: https://us1.platform.bird.com/v1/email/broadcasts
  • Auth: one of:
    • HTTP bearer
    • API key in cookie bird_session

Query parameters

limitinteger

Maximum number of items to return per page.

starting_afterstring

Cursor from the next_cursor field of a previous list response. Returns items immediately after the cursor position in the current sort order.

ending_beforestring

Cursor from the prev_cursor or refresh_cursor field of a previous list response. Returns items immediately before the cursor position in the current sort order. prev_cursor returns the preceding page. refresh_cursor anchors at the first row of that response, which on a newest-first sort is how to fetch the items that have appeared since.

statusEmailBroadcastStatus[]

Filter by lifecycle status. Repeat the parameter to match more than one status, for example ?status=accepted&status=sending.

audience_idstring
Example:adn_01krdgeqcxet5s7t44vh8rt9mg

Filter by audience. Only broadcasts that use this audience are returned.

tagstring

Filter by tag. Pass name to match any broadcast that has that tag name, or pass name:value to match a specific tag pair, for example campaign:spring_launch.

qstring

Case-insensitive literal substring match against the broadcast's tags or the referenced template's name. With email_management read access, also matches the subject in the effective language of the template version resolved when this broadcast's execution starts. Draft and scheduled broadcasts have no execution subject to search. Percent signs, underscores, and backslashes are literal characters.

created_afterstring date-time
Example:2026-05-01T00:00:00Z

Limits the response to resources created at or after this timestamp. Combine it with created_before to select a time window. Use an RFC 3339 timestamp with a timezone offset.

created_beforestring date-time
Example:2026-06-01T00:00:00Z

Limits the response to resources created before this timestamp. Combine it with created_after to select a time window. Use an RFC 3339 timestamp with a timezone offset.

Headers

X-Workspace-Idstring

Workspace context for the request. Required for dashboard authentication and master keys. Workspace keys and access tokens already identify their workspace; send that workspace or omit the header. A different one is rejected.

X-Organization-Idstring

Organization context for the request. Required for dashboard authentication. An API key or access token carries its own organization, so send either that organization or no header at all; a different one is rejected.

Response

Paginated list of broadcasts.

next_cursorstring nullable required

Cursor for the next page. Pass back as starting_after to advance forward. null when no next page exists.

prev_cursorstring nullable required

Cursor for the previous page. Pass back as ending_before to step backward. null when no previous page exists.

refresh_cursorstring nullable required

Refresh anchor, the first row of this response. Pass back as ending_before to fetch what precedes it in the current sort order. On a newest-first sort those are the items that have appeared since; on any other sort they are the items that sort earlier, so refreshing such a list means re-fetching it instead. Non-null whenever data is non-empty; null only on an empty page. Distinct from prev_cursor.

Example response

{
  "data": [
    {
      "id": "eb_01krdgeqcxet5s7t44vh8rt9mg",
      "display_label": "Weekly news",
      "from": {
        "email": "jane@acme.com",
        "name": "Jane Doe"
      },
      "audience_id": "adn_01krdgeqcxet5s7t44vh8rt9mg",
      "template": {
        "id": "emt_01krdgeqcxet5s7t44vh8rt9mg",
        "language": "pt-BR",
        "version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg"
      },
      "html_bytes": 18432,
      "text_bytes": 2104,
      "reply_to": [
        {
          "email": "jane@acme.com",
          "name": "Jane Doe"
        }
      ],
      "recipient_count": 4820,
      "sent_count": 4820,
      "delivered_count": 4712,
      "bounced_count": 96,
      "complained_count": 12,
      "open_count": 3104,
      "click_count": 812,
      "sending_ips": [
        "198.51.100.42"
      ],
      "unique_opens_non_prefetched": 2140,
      "unique_clicks": 693,
      "out_of_band_bounces": 14,
      "delivered_recipients": 4724,
      "tags": [
        {
          "name": "category",
          "value": "welcome"
        }
      ],
      "track_opens": true,
      "track_clicks": true,
      "created_at": "2026-09-01T09:14:02.418Z",
      "scheduled_at": "2026-09-02T08:00:00Z",
      "started_at": "2026-09-02T08:00:03.771Z",
      "sent_at": "2026-09-02T08:11:47.902Z",
      "failure_parameters": {
        "code": "parameter_required",
        "phase": "validation",
        "pointer": "/template/parameters/first_name",
        "observed_version_id": "emv_01krdgeqcxet5s7t44vh8rt9mg",
        "problems": [
          {
            "code": "parameter_required",
            "phase": "validation",
            "severity": "error",
            "pointer": "/template/parameters/first_name",
            "site": "subject",
            "budget": "output_bytes",
            "contact_id": "con_01krdgeqcxet5s7t44vh8rt9mg"
          }
        ]
      }
    }
  ],
  "next_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE0OjAzOjEwWlwiIiwiaSI6IjAxOTJmM2IxLTRjN2UtN2EyYi05ZDYxLThmM2E1YzJlN2I0MCJ9",
  "refresh_cursor": "eyJ2IjoxLCJzIjoiXCIyMDI2LTA1LTI1VDE2OjQyOjAxWlwiIiwiaSI6IjAxOTJmM2IxLTllMDQtN2NkMy1iODE3LTJhNmY0ZDFjOGUwOSJ9"
}

Changes

No recorded changes to this operation across all 2 revisions of this API.