Campaign recipients
List Email Campaign Recipients
Inspect the actual campaign audience and recipient eligibility.
Personal token scopes: campaigns:read + contacts:read. Your account must also have access to the requested data. Authentication
GET
This endpoint supports filtering recipients using Prezly Query Language by providing a query parameter.
Supported filters
| Filter | Comparisons | Type | Description |
|---|---|---|---|
is_valid | $eq, $ne | boolean | Filter recipients that can be valid recipients for the current campaign (excludes bounced and unsubscribed recipients) |
is_subscribed | $eq, $ne | boolean | Filter recipients that are subscribed to the newsroom of the current campaign |
is_unsubscribed | $eq, $ne | boolean | Filter recipients that are unsubscribed from the newsroom of the current campaign |
is_bounced | $eq, $ne | boolean | Filter recipients with email address marked as bounced |
is_duplicate_email_address | $eq, $ne | boolean | Filter recipients with email address being used at least twice in scope of the current campaign |
id | $in, $nin | string[] | Filter recipients by Recipient ID |
contact.* | - | - | Filter recipients by contact details. Refer to Contact Search API for supported filters. |
Personal access tokens: campaigns:read and contacts:read. Every listed scope is required; the token owner's permissions, feature availability and newsroom access still apply.
API_keyheader
AuthorizationBearer <token>Bearer authentication using an integration API key, or a personal access token only where the operation explicitly supports it. Every listed personal-token scope is required; owner permissions and newsroom access still apply.
campaign_id*integerCampaign ID
sort?stringSee Ordering Results
Match
[-+]?(\w+\.)*\w+limit?integerNumber of records to fetch
Range
1 <= value <= 1000Default
20offset?integerNumber of records to skip (for pagination)
query?stringJsonQuery to target a selection of Recipients
OK
application/json- response
recipients*array<>sort*Sort OrderSort order to return records in.
Match
[+-]?(\w+\.)*\w+pagination*curl -X GET 'https://api.prezly.com/v2/campaigns/0/recipients'Example Response200
{ "recipients": [ { "id": "string", "display_name": "string", "avatar_url": "http://example.com", "email_address": "user@example.com", "email_addresses": [ { "email_address": "string", "status": "ok" } ], "contact": { "id": 0, "contact_type": "person", "is_person": true, "is_deleted": true, "salutation": "string", "custom_fields": { "property1": "string", "property2": "string" }, "company_name": "string", "first_name": "string", "last_name": "string", "gender": "string", "display_name": "string", "avatar_url": "string", "avatar_image": { "uuid": "095be615-a8ad-4c33-8e9c-c7612fbf6c9f", "version": 0, "filename": "string", "mime_type": "string", "size": 0, "original_width": 0, "original_height": 0, "effects": [ "string" ] }, "bio": "string", "primary_email": "user@example.com", "emails": [ "user@example.com" ], "phone_numbers": [ { "type": "cell", "number": "string" } ], "social": [ { "type": "bluesky", "username": "string" } ], "urls": [ "http://example.com" ], "function_name": "string", "periodicity": "daily", "medium_types": [ "wire" ], "address": { "street": "string", "number": "string", "box": "string", "zip": "string", "city": "string", "region": "string", "country": "string" }, "address_text": "string", "coverage_number": 0, "last_coverage_at": "2019-08-24T14:15:22Z", "organisations_number": 0, "organisations": [ { "id": 0, "display_name": "string", "links": { "view": "http://example.com" } } ], "employees_number": 0, "tags": [ "string" ], "is_bounced": true, "is_duplicated": true, "is_unsubscribed": true, "is_unsubscribed_from_all_communications": true, "has_enrichments": true, "unsubscribed_newsrooms": [ "string" ], "duplicate_contacts": [ { "contact": { "id": 0, "contact_type": "person", "display_name": "string", "function_name": "string", "avatar_url": "http://example.com", "is_deleted": true, "links": { "api": "http://example.com", "view": "http://example.com" } }, "score": 0, "status": "unseen", "links": { "merge_api": "http://example.com" } } ], "created_at": "2019-08-24T14:15:22Z", "modified_at": "2019-08-24T14:15:22Z", "stats": { "sent": 0, "replied": 0, "clicked": 0, "clicked_rate": 0, "opened": 0, "opened_rate": 0 }, "meta": { "is_unsubscribed": true, "is_bounced": true, "is_duplicated": true }, "links": { "api": "http://example.com", "view": "http://example.com", "edit": "http://example.com", "convert": "http://example.com", "exclude_mailbox_conversations": "http://example.com", "organisations_api": "http://example.com", "employees_api": "http://example.com", "enrichments_api": "http://example.com", "duplicates_api": "http://example.com", "data_privacy_requests_api": "http://example.com", "export_personal_data_api": "http://example.com" }, "tag_entities": [ { "id": 0, "name": "string" } ] }, "is_unsubscribed": true, "is_unsubscribed_from_all_communications": true } ], "sort": "+display_name", "pagination": { "offset": 0, "limit": 0, "matched_records_number": 0, "total_records_number": 0 }}