---
title: "List broadcasts"
method: GET
path: "/broadcasts"
tags: ["Campaigns"]
---

# List broadcasts

`GET /broadcasts`

## Request

- Base URL: `https://sendhq.cc/api/v1`
- URL: `https://sendhq.cc/api/v1/broadcasts`
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/sendhq/apis/sendhq-api/docs/broadcasts/get.ts> (a function with typed inputs; its response is checked against the schema)

List broadcasts

## Query parameters

- `status` 'draft' | 'sending' | 'sent' | 'cancelled' | 'failed'
- `limit` integer
- `offset` integer

## Response `200`

Successful response

- object
  - `data` object[], required
    - `id` string, required
    - `name` string, required
    - `status` string, required
    - `listId` string, required
    - `from` string, required
    - `replyTo` unknown, required
    - `subject` string, required
    - `previewText` string, required
    - `html` string, required
    - `text` unknown, required
    - `template` unknown, required
    - `audience` object, required
      - `segmentId` unknown, required
      - `order` string, required
      - `limit` unknown, required
    - `tracking` object, required
      - `opens` boolean, required
      - `clicks` boolean, required
    - `editor` string, required
    - `content` unknown, required
    - `testSentAt` unknown, required
    - `web` object, required
      - `enabled` boolean, required
      - `slug` unknown, required
      - `pinned` boolean, required
      - `publishedAt` unknown, required
    - `scheduledAt` unknown, required
    - `startedAt` unknown, required
    - `completedAt` unknown, required
    - `nextAttemptAt` unknown, required
    - `lastError` unknown, required
    - `createdAt` string, date-time, required
    - `updatedAt` string, date-time, required
  - `count` integer, required

## Other responses

- `400`: Invalid request
- `401`: Missing or invalid authentication
- `402`: A paid entitlement is required for this recipient or feature
- `403`: The workspace, domain, policy, or suppression state forbids the operation
- `404`: Tenant-scoped resource not found
- `409`: Resource state or idempotency conflict
- `413`: Attachment count or bytes exceed the accepted limit
- `422`: Request validation or suppression check failed
- `423`: Sending is paused for this sender identity or workspace; the message gives the reason and how to appeal
- `429`: A monthly, daily, or trial usage limit was reached
- `500`: Unexpected server error
- `502`: An upstream provider operation failed
- `503`: A required provider or signing configuration is unavailable
- `default`: An error response using SendHQ's standard JSON envelope

---

[API](https://skmtc.dev/sendhq/apis/sendhq-api.md) - [All operations](https://skmtc.dev/sendhq/apis/sendhq-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sendhq/apis/sendhq-api/revisions/98e39e48cb9a?raw)