Campaign recipients by status
GET/v1/public/campaigns/:campaignId/recipients
Paginated list of campaign recipients with delivery/engagement status filter. Each recipient gets exactly one status by priority: complaint > unsubscribed > hard_bounced > soft_bounced > error > clicked > error_infrastructure > opened > delivered > not_delivered. This means clicked includes opened (a recipient who clicked will not appear under opened), while unsubscribed and complaint override all other statuses. The exact page count is not returned — use hasMore for navigation. For statuses error, soft_bounced and hard_bounced the SMTP server response (responseSmtp) is returned.
Request
Responses
- 200
- 400
- 401
- 403
- 404
- 422
- 429
- 500
A page of campaign recipients.
The request is invalid.
A valid Public API token is required.
The endpoint requires a scope that is not granted to the token.
The requested resource was not found.
The request is syntactically correct but cannot be processed.
The current API key exceeded the configured rate limit.
Response Headers
Number of seconds after which the request may be retried safely.
Internal server error.