SMS recipients

Get a paginated list of SMS recipients for a campaign, with status filtering, field search, and sorting.

Auth: Account — authentication bearer token; requires the user's own company bundle_id === 3 (ACCOUNT). (404 Campaign not found otherwise). Non-account users get 403.

Rate limit: No rate limit.

Request

  • Query: filter (string, optional) — one of processed, pending, sent, delivered, clicked, failed. Maps to a status/timestamp predicate (e.g. clickedlink_clicked_at NOT NULL).
  • Query: search_field (string, optional) — one of phone_number, status, message_id. When set, LIKE on that column; when you omit it but search_value is set, OR-LIKE across all three.
  • Query: search_value (string, optional, max 255) — search term.
  • Query: sort_field (string, optional) — one of id, phone_number, status, created_at, sent_at, delivered_at, link_clicked_at, failed_at, message_id. Default created_at.
  • Query: sort_by (string, optional) — asc/ASC/desc/DESC. Default desc.
  • Query: limit (integer, optional, 10–100) — per-page; values below 10 are raised to 10, capped at 100. Default 10.
  • Query: page (integer, optional, min 1) — page number. Default 1.

Response — raw paginator. Each row selects: id, status, sent_at, delivered_at, link_clicked_at, failed_at, failure_reason, metadata, created_at, dialing_code, phone_number, message_id, campaign_audience_data_id, and an included audienceData relation (id, customer_name, email, phone, is_email_valid, is_phone_valid, validation_status).

  • current_page (int)
  • data[] (array) — recipient rows with the selected columns above plus nested audience_data.
  • per_page (int), total (int), last_page (int), from/to, first_page_url, next_page_url, etc. (standard paginator keys).

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