---
title: "List all broadcasts"
method: GET
path: "/broadcasts"
---

# List all broadcasts

`GET /broadcasts`

Retrieves a paginated list of broadcasts for the project. Returns basic information about each broadcast including its creation time and status.

## Query parameters

- `limit` integer
- `starting_after` string
- `ending_before` string

## Response `200`

OK

- BroadcastCollection
  - `data` Broadcast[]
    - `action_url` string, nullable — The URL recipients will be directed to when interacting with the broadcast.
    - `category` string, nullable — The label used to group broadcasts.
    - `content` string, nullable — The body content delivered with the broadcast.
    - `created_at` string, date-time — The timestamp when the broadcast was created.
    - `custom_attributes` object, nullable — Arbitrary custom data associated with the broadcast.
    - `id` string, uuid — The unique id for this broadcast.
    - `overrides` object, nullable — Channel- or provider-specific values that override the defaults.
      - `channels` object — Overrides that are scoped to individual delivery channels.
        - `email` object — Overrides for email notifications.
          - `action_url` string, nullable — The link associated with the channel-specific notification.
          - `content` string — The channel-specific content.
          - `title` string — The channel-specific title.
        - `in_app` object — Overrides for in-app notifications.
          - `action_url` string, nullable — The link associated with the channel-specific notification.
          - `content` string — The channel-specific content.
          - `title` string — The channel-specific title.
        - `mobile_push` object — Overrides for mobile push notifications.
          - `action_url` string, nullable — The link associated with the channel-specific notification.
          - `content` string — The channel-specific content.
          - `title` string — The channel-specific title.
        - `sms` object — Overrides for SMS notifications.
          - `action_url` string, nullable — The link associated with the channel-specific notification.
          - `content` string — The channel-specific content.
          - `title` string — The channel-specific title.
      - `providers` object — Overrides that are scoped to specific providers for a channel.
        - `apns` object — Provider-specific overrides for Apple Push Notification service.
        - `expo` object — Provider-specific overrides for Expo push notifications.
        - `fcm` object — Provider-specific overrides for Firebase Cloud Messaging.
        - `mailgun` object — Provider-specific overrides for Mailgun.
        - `sendgrid` object — Provider-specific overrides for Sendgrid.
        - `ses` object — Provider-specific overrides for AWS SES.
        - `slack` object — Provider-specific overrides for Slack.
        - `teams` object — Provider-specific overrides for Microsoft Teams.
        - `twilio` object — Provider-specific overrides for Twilio.
        - `web_push` object — Provider-specific overrides for the web push provider.
    - `recipients` User[], nullable, required — A collection of users or filters that determine who receives the broadcast.
      - `created_at` string, date-time, nullable — The timestamp when the user was created.
      - `custom_attributes` object, nullable — Arbitrary custom values stored on the user.
      - `email` string, nullable — The primary email address of the user.
      - `external_id` string, nullable — The user identifier from an external system.
      - `first_name` string, nullable — The first name of the user.
      - `id` string, uuid — The unique identifier for the user.
      - `last_name` string, nullable — The last name of the user.
      - `last_notified_at` string, date-time, nullable — The timestamp when the user last received a notification.
      - `last_seen_at` string, date-time, nullable — The timestamp when the user last opened the inbox.
      - `updated_at` string, date-time, nullable — The timestamp when the user was last updated.
    - `status` object — The runtime state of the broadcast execution.
      - `errors` object[], nullable, required — A list of errors encountered while processing the broadcast.
        - `message` string — The details about the processing error.
      - `status` 'enqueued' | 'processing' | 'processed', required — The overall processing status of the broadcast.
      - `summary` object, required — The summary counts for total recipients and failures.
        - `failures` integer, required — The number of failures while processing the broadcast.
        - `total` integer, required — The number of recipients that the broadcast was sent to.
    - `title` string, required — The subject or headline that will be shown to recipients.
    - `topic` string, nullable — The topic that further classifies the broadcast.
  - `links` Links
    - `first` string
    - `next` string, nullable
    - `prev` string, nullable

---

[API](https://skmtc.net/magicbell/apis/magicbell-api.md) · [All operations](https://skmtc.net/magicbell/apis/magicbell-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/magicbell/magicbell-api/revisions/8b99dca11019/schema)