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

# List broadcasts

`GET /orgs/broadcasts`

## Request

- Base URL: `https://api.useinvent.com`
- URL: `https://api.useinvent.com/orgs/broadcasts`
- Auth: HTTP bearer

Get a list of broadcasts for a specific org.

## Query parameters

- `type` 'ALL' | 'MARKETING' | 'TRANSACTIONAL': Only broadcasts of this type.
- `status` 'ALL' | 'DRAFT' | 'SCHEDULED' | 'SENDING' | 'SENT' | 'CANCELLED' | 'FAILED' | 'ACTIVE' | 'PAUSED': Only broadcasts in this status.
- `search` string: Filter broadcasts by name
- `page` number
- `take` number
- `next` string
- `progressive` boolean

## Response `200`

- BroadcastSchema[]
  - `id` string, required
  - `name` string, required
  - `type` 'MARKETING' | 'TRANSACTIONAL', required: The mode of the broadcast: MARKETING (bulk to many people) or TRANSACTIONAL (single-recipient trigger across channels)
  - `status` 'DRAFT' | 'SCHEDULED' | 'SENDING' | 'SENT' | 'CANCELLED' | 'FAILED' | 'ACTIVE' | 'PAUSED', required: The status of the broadcast
  - `show_in_inbox` boolean, required
  - `scheduled_at` string, date-time, nullable, required
  - `pace_minutes` number, nullable, required
  - `started_at` string, date-time, nullable, required
  - `completed_at` string, date-time, nullable, required
  - `recipients_count` number, required
  - `queued_count` number, required
  - `sending_count` number, required
  - `skipped_count` number, required
  - `sent_count` number, required
  - `failed_count` number, required
  - `bounced_count` number, required
  - `delivered_count` number, required
  - `opened_count` number, required
  - `played_count` number, required
  - `click_count` number, required
  - `complained_count` number, required
  - `unsubscribed_count` number, required
  - `error_message` string, nullable, required
  - `send_cooldown` BroadcastSendCooldownSchema, nullable, required: Provider-wide send pause on this broadcast — sending resumes automatically
    - `resumes_at` string, required
  - `segments` SegmentLimitedSchema[], required
    - `id` string, required
    - `name` string, required
    - `color` 'red' | 'orange' | 'amber' | 'yellow' | 'lime' | 'green' | 'teal' | 'cyan' | 'sky' | 'blue' | 'indigo' | 'violet' | 'purple' | 'fuchsia' | 'pink' | 'rose' | 'neutral', required: Accent color, by name
    - `contacts_count` number, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `fields` BroadcastFieldSchema[], required
    - `id` string, required
    - `broadcast_id` string, required
    - `key` string, required
    - `default_value` string, nullable, required
    - `created_at` string, date-time, required
  - `send_to_all` boolean, required
  - `templates` BroadcastTemplateSchema[], required
    - `id` string, required
    - `broadcast_id` string, required
    - `connection_id` string, nullable, required
    - `channel_type` 'internal' | 'org' | 'agent' | 'custom' | 'whatsapp_bot' | 'messenger_bot' | 'instagram_dm' | 'tiktok_dm' | 'telegram_bot' | 'slack_bot' | 'teams_bot' | 'gmail' | 'outlook' | 'twilio' | 'telnyx' | 'email' | 'smpp', required: The channel type
    - `recipients_count` number, required
    - `config` BroadcastTemplateConfigSchema, required: Configuration object for the broadcast template
    - `error` string, nullable, required
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

---

[API](https://skmtc.dev/useinvent/apis/invent-api.md) · [All operations](https://skmtc.dev/useinvent/apis/invent-api/llms.txt) · [OpenAPI document](https://skmtc.dev/useinvent/apis/invent-api/revisions/98824f3fde82?raw)