SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Outreach

List the people a campaign was sent to, and what happened to each

People appear once the campaign has been sent or scheduled.

GEThttps://app.softsolz.uk/api/v1/services/outreach/campaigns/{id}/recipients

Recent Requests

Kept only in this browser
TimeStatusTook
Send a request with Try it to see it here.

Path Params

idstringrequired

Headers

Authorizationstringrequired

Bearer token: Bearer sk_live_... (or sk_test_... for sandbox). A login token will not work here.

Query Params

statusstring

Filter by what happened: pending, sent (also delivered or read), delivered (also read), read, failed, skipped, bounced or replied.

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Rows to skip (default 0).

Response

Response Body · array of objects

idstringRecipient id.
customer_idstring | nullBooking customer this person matched, if any.
contact_idstring | nullContact this person matched, if any.
display_namestring | nullName shown for the person.
phonestring | nullPhone number, for text, WhatsApp and call campaigns.
emailstring | nullEmail address, for email campaigns.
statusstringWhat happened to this person.
skip_reasonstring | nullWhy the person was left out, when skipped.
errorstring | nullWhy sending failed, when it failed.
outcomestring | nullCall outcome, for call campaigns, for example answered or no_answer.
sent_atstring | nullWhen the message was sent.
delivered_atstring | nullWhen the message was delivered.
read_atstring | nullWhen the message was read or opened.
replied_atstring | nullWhen the person replied.
created_atstringWhen the person was added to the campaign.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/outreach/campaigns/{id}/recipients \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Sent as a Bearer token and used in the samples above and in Try it. Kept only in this browser tab until you close it. Use an sk_test_ key to stay in your sandbox.

Response · 200

{
  "data": [
    {
      "id": "5021",
      "customer_id": null,
      "contact_id": null,
      "display_name": "Jane Doe",
      "phone": "+447700900123",
      "email": null,
      "status": "delivered",
      "skip_reason": null,
      "error": null,
      "outcome": null,
      "sent_at": "2026-10-05T09:01:00.000Z",
      "delivered_at": "2026-10-05T09:01:04.000Z",
      "read_at": null,
      "replied_at": null,
      "created_at": "2026-09-01T09:00:00.000Z"
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  }
}