---
title: "Inspect campaign recipient outcomes"
method: POST
path: "/api/v1/tools/list_campaign_recipients"
---

# Inspect campaign recipient outcomes

`POST /api/v1/tools/list_campaign_recipients`

## Request

- Base URL: `https://whatsync.app`
- URL: `https://whatsync.app/api/v1/tools/list_campaign_recipients`
- Auth: one of:
  - HTTP bearer
  - API key in header `X-API-Key`

Read a bounded page of recipient outcomes and provider message IDs. Pending, sending, accepted, failed, unknown and suppressed are distinct; never automatically retry uncertain recipients.

## Headers

- `Idempotency-Key` string

## Request body

- object
  - `campaignId` string, uuid, required
  - `after` string, uuid
  - `limit` integer
  - `status` 'pending' | 'sending' | 'accepted' | 'failed' | 'unknown' | 'suppressed'

## Response `200`

JSON result. Every response includes X-Request-Id.

- object

## Other responses

- `400`: API error
- `401`: API error
- `403`: API error
- `404`: API error
- `409`: API error
- `413`: API error
- `415`: API error
- `422`: API error
- `429`: API error
- `503`: API error

---

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