Email recipients

Get a paginated list of email recipients for a campaign, with optional status filter, search, and sort.

Auth: Account — authentication bearer token. Non-matching id returns 404 Campaign not found.

Rate limit: No rate limit.

Request

  • Query: filter (string, optional) — one of processed,pending,sent,delivered,opened,clicked,unsubscribed,failed; filters by status or by presence of the matching *_at timestamp.
  • Query: search_field (string, optional) — one of email,status,message_id,customer_name; when you omit it but search_value is present, searches across email/status/message_id/customer_name.
  • Query: search_value (string, optional, max 255) — LIKE-matched.
  • Query: sort_field (string, optional) — one of id,email,status,created_at,sent_at,delivered_at,opened_at,clicked_at,unsubscribed_at,failed_at,customer_name; defaults to created_at.
  • Query: sort_by (string, optional) — asc/desc (case-insensitive); defaults to desc.
  • Query: limit (integer, optional, 10–100) — page size; defaults to 10 (values below 10 are raised to 10, capped at 100).
  • Query: page (integer, optional, min 1) — page number.

Response — NOT wrapped in a data envelope. The method returns the paginator directly, so the response is a standard length-aware paginator JSON (top-level current_page, data, per_page, total, last_page, links, etc.). Each data[] item is a selected:

  • id (int)
  • status (string)
  • sent_at / delivered_at / opened_at / clicked_at / unsubscribed_at / failed_at (datetime, nullable)
  • unsubscribe_reason / failure_reason (string, nullable)
  • metadata (object/array, nullable)
  • created_at (datetime)
  • email (string)
  • message_id (string, nullable)
  • campaign_audience_data_id (int, nullable)
  • next_follow_up_at (datetime, nullable), follow_up_count (int), parent_id (int, nullable)
  • audience_data (object, nullable) — included relation with id,customer_name,email,phone,is_email_valid,is_phone_valid,validation_status.

Path params

ParameterTypeRequiredNotes
campaignIdintegerRequiredDigits only.

Errors: 422 on validation failure.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json