---
title: "Get the campaign recipients by ID"
method: GET
path: "/api/ext/v3/broadcasts/{broadcast_id}/recipients"
tags: ["Broadcasts"]
---

# Get the campaign recipients by ID

`GET /api/ext/v3/broadcasts/{broadcast_id}/recipients`

## Path parameters

- `broadcast_id` string, required

## Query parameters

- `page_number` integer, required
- `page_size` integer, required

## Response `200`

Returns the broadcast recipients.

- GetBroadcastRecipientsResponse — Response model for getting the recipients of a specific broadcast.
  - `recipients` BroadcastRecipientDto[], nullable — The list of broadcast recipients
    - `id` string, nullable — The identifier of the broadcast recipient
    - `contact_id` string, nullable — The identifier of the contact associated with the recipient
    - `contact_name` string, nullable — The name of the contact
    - `contact_phone` string, nullable — The phone number of the contact
    - `status` string, nullable — The status of the broadcast recipient
    - `failed_code` string, nullable — The failure code if the message failed to send
    - `local_message_id` string, nullable — The local message identifier
    - `message_id` string, nullable — The message identifier from the messaging platform
    - `custom_params` CustomParamDto[], nullable — The custom parameters associated with the recipient
      - `name` string, required — The name of the custom parameter.
      - `value` string, required — The value of the custom parameter.
    - `created` string, date-time — The creation timestamp of the broadcast recipient
  - `page_number` integer — The current page number
  - `page_size` integer — The number of items per page
  - `total_count` integer — The total number of recipients

## Other responses

- `400` — The request is invalid.
- `401` — The request is unauthorized.
- `403` — The request is forbidden.
- `429` — Too many requests. Either the rate limit has been exceeded or usage limits have been reached.
- `500` — Unexpected error occurred. Please try again.

---

[API](https://skmtc.net/wati/apis/api-documentation-v3.md) · [All operations](https://skmtc.net/wati/apis/api-documentation-v3/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/wati/api-documentation-v3/versions/dee16d2c7d41/schema)
