---
title: "List broadcast recipients"
method: GET
path: "/v1/messaging/broadcasts/{broadcastId}/recipients"
tags: ["Broadcasts"]
---

# List broadcast recipients

`GET /v1/messaging/broadcasts/{broadcastId}/recipients`

## Request

- Base URL: `https://apihub.co.il`
- URL: `https://apihub.co.il/v1/messaging/broadcasts/{broadcastId}/recipients`
- Auth: HTTP bearer

Returns recipients for a broadcast with individual delivery status. Filter by status.

**Billing:** Read (free unless it says otherwise) · **Rate limit:** 120/min

## Path parameters

- `broadcastId` string, required

## Query parameters

- `skip` integer
- `limit` integer
- `status` 'pending' | 'sent' | 'delivered' | 'read' | 'failed'

## Headers

- `Idempotency-Key` string
- `X-Tag` string

## Response `200`

Completed

- object
  - `id` string: Execution id — stable across internal retries; use it with GET /v1/executions/{id}
  - `status` 'pending' | 'processing' | 'completed' | 'partial' | 'failed' | 'cancelled' | 'timeout'
  - `operation` string
  - `tag` string, nullable: Your X-Tag, if sent
  - `created_at` string, date-time
  - `completed_at` string, date-time, nullable
  - `output` object: Operation result (see each operation). While a Studio render is processing: `stage` (queued · transcribing · downloading · preparing · cleaning_voice · mixing_audio · rendering · finishing), `phase` (the engine's: download · prepare · voice · audio · encode · qa · upload, or null), `progress` (a percent, 0–100) and `progress_fraction` (0–1), `eta_seconds` (seconds left, never below 0) and `estimate_seconds`
    - `success` boolean
    - `summary` object: Delivery totals across all recipients in the broadcast, independent of pagination and status filtering.
      - `read` integer
      - `sent` integer
      - `total` integer
      - `failed` integer
      - `pending` integer
      - `delivered` integer
    - `pagination` object
      - `skip` integer
      - `limit` integer
      - `total` integer
      - `hasMore` boolean
    - `recipients` object[]
      - `id` string
      - `error` string
      - `readAt` string, date-time
      - `sentAt` string, date-time
      - `status` 'pending' | 'sent' | 'delivered' | 'read' | 'failed'
      - `channelId` string
      - `contactId` string
      - `errorCode` integer, nullable: Meta WhatsApp error code (e.g. 131049 for antispam, 131021 for invalid phone, 131026 for re-engagement required). Only populated for status=failed.
      - `messageId` string
      - `contactName` string, nullable
      - `deliveredAt` string, date-time
      - `errorTraceId` string, nullable: Meta trace id (fbtrace_id) for the failed send. Quote this when escalating to Meta Direct Support. Only populated for status=failed on Meta platforms.
      - `errorExplanation` string, nullable: Plain-language translation of errorCode (e.g. for 131026, that the recipient has likely opted out of marketing messages). Null for unmapped codes; fall back to error.
      - `platformIdentifier` string
  - `error` string, nullable
  - `usage` object
    - `credits_charged` number, nullable
    - `credits_reserved` number
    - `estimated_credits` number
    - `cost_source` 'provider_reported' | 'calculated' | 'estimated' | 'null', nullable
    - `provider_usage` object, nullable: Normalised consumption, e.g. { VIDEO_SECOND: 22.4 }
  - `balance` object
    - `available` number
    - `reserved` number

## Other responses

- `400`: Invalid input
- `402`: Insufficient credits / project budget
- `404`: Resource not found (or not yours)
- `429`: Rate limited
- `503`: Service temporarily paused

---

[API](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai.md) · [All operations](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/llms.txt) · [OpenAPI document](https://skmtc.dev/apihub/apis/apihub-one-api-for-chat-image-video-ai/revisions/a8caa42835ce?raw)