SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Outreach

List who agreed to hear from you and who asked to stop

One row per person and channel, showing their latest answer, newest first.

GEThttps://app.softsolz.uk/api/v1/services/outreach/consents

Recent Requests

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

Headers

Authorizationstringrequired

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

Query Params

channelstring

sms, whatsapp, email or ai_call.

statusstring

opted_in, opted_out or pending.

searchstring

Match part of a phone number or email address.

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Rows to skip (default 0).

Response

Response Body · array of objects

idstringConsent record id.
channelstringChannel the consent is for.
addressstringPhone number or email address.
statusstringTheir latest answer.
sourcestringHow the answer was collected.
wordingstring | nullThe wording the person agreed to.
page_urlstring | nullPage where the person agreed, when known.
created_atstringWhen the answer was recorded.
recorded_bystring | nullMember who recorded it, when a member did.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/outreach/consents \
--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": "880",
"channel": "sms",
"address": "+447700900123",
"status": "opted_in",
"source": "api",
"wording": "Yes, text me offers. Reply STOP to end.",
"page_url": null,
"created_at": "2026-09-01T09:00:00.000Z",
"recorded_by": null
}
],
"meta": {
"limit": 50,
"offset": 0,
"total": 1,
"has_more": false
}
}