---
title: "GET /v1/workspaces/{workspaceId}/campaigns/{campaignId}/recipients"
method: GET
path: "/v1/workspaces/{workspaceId}/campaigns/{campaignId}/recipients"
---

# GET /v1/workspaces/{workspaceId}/campaigns/{campaignId}/recipients

`GET /v1/workspaces/{workspaceId}/campaigns/{campaignId}/recipients`

## Request

- Base URL: `https://api.bangermail.com`
- URL: `https://api.bangermail.com/v1/workspaces/{workspaceId}/campaigns/{campaignId}/recipients`
- Auth: HTTP bearer

## Query parameters

- `cursor` string
- `limit` integer
- `status` 'pending' | 'queued' | 'sent' | 'failed' | 'skipped' | 'delivered' | 'deferred' | 'bounced' | 'complained' | 'unsubscribed'

## Response `200`

Successful response.

- object
  - `data` object[], required
    - `contact_id` string, uuid, nullable
    - `recipient_email` string
    - `recipient_name` string, nullable
    - `recipient_hash` string
    - `status` string
    - `dispatch_status` string
    - `command_id` string, uuid, nullable
    - `error_code` string, nullable
    - `created_at` string, date-time
    - `updated_at` string, date-time
    - `delivery_state` string, nullable
    - `provider_message_key` string, nullable
    - `last_event_at` string, date-time, nullable
    - `first_delivered_at` string, date-time, nullable
    - `first_opened_at` string, date-time, nullable
    - `first_clicked_at` string, date-time, nullable
    - `first_human_likely_opened_at` string, date-time, nullable
    - `first_human_likely_clicked_at` string, date-time, nullable
    - `first_replied_at` string, date-time, nullable
    - `machine_open_count` integer
    - `machine_click_count` integer
    - `privacy_proxy_open_count` integer
    - `unknown_open_count` integer
    - `unknown_click_count` integer
    - `first_unsubscribed_at` string, date-time, nullable
  - `page` PageInfo, required
    - `next_cursor` string
    - `has_more` boolean, required

## Other responses

- `404`: The requested resource does not exist in this workspace.

---

[API](https://skmtc.dev/bangermail/apis/banger-api.md) · [All operations](https://skmtc.dev/bangermail/apis/banger-api/llms.txt) · [OpenAPI document](https://skmtc.dev/bangermail/apis/banger-api/revisions/a149909267f9?raw)