nevent_list_campaign_recipients
List the individual recipients of a campaign and what happened to each message. Use this to put names behind the aggregate numbers from nevent_get_campaign_metrics: who bounced, who clicked, who unsubscribed. Filter with status (SCHEDULED, DELIVERED, OPENED, CLICKED, BOUNCES, UNSUBSCRIBES), narrow to one audience with segment_id when the campaign targeted several segments, or find one person with search (matches name and email). Returns a paginated envelope — content (the recipient rows), page, size, totalElements, totalPages. Rows contain personal data: request the smallest page that answers the question, filter rather than paginate through everything, and do not dump full recipient lists into a summary.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| page | No | Zero-based page number. Default: 0 (first page). | |
| search | No | Free-text search across recipient name and email address. | |
| status | No | Filter recipients by delivery state. SCHEDULED = queued but not sent; DELIVERED = accepted by the receiving server; OPENED / CLICKED = engaged; BOUNCES = delivery failed; UNSUBSCRIBES = opted out from this send. Omit to return every recipient. | |
| page_size | No | Recipients per page (1-100). Default: 25. Keep this small — recipient rows contain personal data and large pages waste context. | |
| segment_id | No | Restrict the listing to recipients that came from one segment. Useful on multi-segment campaigns to compare which segment engaged. Get segment IDs from nevent_list_segments. | |
| campaign_id | Yes | Campaign ID. Get it from nevent_list_campaigns, or from the response of nevent_create_campaign. |