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

# List all broadcast recipients

`GET /orgs/broadcasts/recipients`

## Request

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

Get recipients for a specific org.

## Query parameters

- `status` 'ALL' | 'QUEUED' | 'SENDING' | 'PROCESSED' | 'SENT' | 'FAILED' | 'SKIPPED': Only deliveries in this status.
- `is_skipped` boolean
- `is_failed` boolean
- `is_bounced` boolean
- `is_sent` boolean
- `is_delivered` boolean
- `is_complained` boolean
- `is_unsubscribed` boolean
- `is_opened` boolean
- `is_played` boolean
- `is_clicked` boolean
- `clicked_link` string
- `error_reason` string
- `channel_type` string: Only deliveries on this channel type, e.g. 'whatsapp_bot'.
- `contact_id` string: Only deliveries to this contact.
- `user_id` string
- `username` string
- `email` string: Only deliveries to this email address.
- `search` string: Search recipients by name, email, phone or username.
- `from_date` string, date-time, nullable: Only deliveries created at or after this ISO 8601 date.
- `to_date` string, date-time, nullable: Only deliveries created at or before this ISO 8601 date.
- `sort_field` 'created_at' | 'updated_at': Field to sort broadcast recipients by
- `sort_direction` 'asc' | 'desc': Direction to sort broadcast recipients by
- `page` number
- `take` number
- `next` string
- `progressive` boolean

## Response `200`

- BroadcastRecipientSchema[]
  - `id` string, required
  - `broadcast_id` string, required
  - `broadcast_name` string, required
  - `template_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
  - `contact` ContactSchema: Schema for the contact
    - `id` string, required
    - `name` string, nullable, required
    - `blocked` boolean, required
    - `blocked_at` string, date-time
    - `unsubscribed` boolean, required
    - `unsubscribed_at` string, date-time
    - `unsubscribe_reason` string
    - `unsubscribe_feedback` string
    - `ai_replies` boolean, required
    - `ai_replies_at` string, date-time
    - `is_admin` boolean, required
    - `channels` ContactChannelSchema[], required
      - `id` string, required
      - `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
      - `user_id` string, required: The unique identifier for the contact channel, e.g Phone Number or User ID
      - `avatar` string, nullable, required: The avatar for the contact channel, e.g X Avatar URL
      - `name` string, nullable, required: The name for the contact channel, e.g Full Name
      - `username` string, nullable, required: The username for the contact channel, e.g Username
      - `email` string, nullable, required: The email for the contact channel, e.g Email
      - `phone` string, nullable, required: The phone number for the contact channel, e.g Phone Number
      - `country` string, nullable, required: The country code associated with the contact channel, e.g US for United States
      - `agent` string, nullable, required: The user agent associated with the contact channel
      - `ip` string, nullable, required: The IP address associated with the contact channel
      - `language` string, nullable, required: The language code associated with the contact channel, e.g en for English
      - `link` string: A link to the contact channel, e.g a link to the social media profile
      - `created_at` string, date-time, required
      - `updated_at` string, date-time, 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` object, required: Map of contact field key → value.
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `user_id` string, nullable, required
  - `name` string, nullable, required
  - `username` string, nullable, required
  - `phone` string, nullable, required
  - `email` string, nullable, required
  - `status` 'QUEUED' | 'SENDING' | 'PROCESSED' | 'SENT' | 'FAILED' | 'SKIPPED', required: The status of the broadcast recipient
  - `source` 'API' | 'MANUAL' | 'INBOX' | 'IMPORT' | 'null', nullable, required: How the recipient was triggered (transactional only)
  - `payload` object, nullable, required
  - `retries` number, required
  - `is_skipped` boolean, nullable, required
  - `is_skipped_at` string, date-time, nullable, required
  - `is_failed` boolean, nullable, required
  - `is_failed_at` string, date-time, nullable, required
  - `is_bounced` boolean, nullable, required
  - `is_bounced_at` string, date-time, nullable, required
  - `is_sent` boolean, nullable, required
  - `is_sent_at` string, date-time, nullable, required
  - `is_delivered` boolean, nullable, required
  - `is_delivered_at` string, date-time, nullable, required
  - `is_complained` boolean, nullable, required
  - `is_complained_at` string, date-time, nullable, required
  - `is_unsubscribed` boolean, nullable, required
  - `is_unsubscribed_at` string, date-time, nullable, required
  - `is_opened` boolean, nullable, required
  - `is_opened_at` string, date-time, nullable, required
  - `is_played` boolean, nullable, required
  - `is_played_at` string, date-time, nullable, required
  - `error_message` string, nullable, required
  - `external_message_id` string, nullable, required
  - `interactions` BroadcastRecipientInteractionItemSchema[], required
    - `type` 'CLICK', required: The type of the broadcast recipient interaction
    - `label` string, nullable, required
    - `value` string, required
    - `created_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)