Broadcasts
GET
List Broadcasts
GET /v1/broadcastsRetrieve a paginated list of all broadcasts in your workspace.
Use Cases:
- View all broadcasts and their statuses
- Monitor campaign progress
- Build broadcast management dashboards
- Audit past broadcast campaigns
- Track scheduled broadcasts
Behavior:
- Returns broadcasts in reverse chronological order (newest first)
- Uses cursor-based pagination for efficient retrieval
- Includes broadcast metadata, status, and email content summary
- Maximum 100 broadcasts per request
- Includes all statuses (DRAFT, QUEUED_FOR_SENDING, SENDING, SENT, etc.)
Required Scope: read:broadcasts
Response Includes:
- Broadcast ID, name, and status
- Sender address and reply-to
- Email content (subject, preview text, HTML, text)
- Topic and segment associations
- Scheduled send time
- Creation timestamp
Query parameters
limitintegerNumber of items to return (default: 20, max: 100)
afterstringCursor for pagination - ID of the last item from the previous page
beforestringCursor for reverse pagination - ID of the first item from the next page
Response
200Successfully retrieved paginated list of broadcasts with metadata and content
objectstringrequiredhasMorebooleanrequireddataobject[]required