SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Outreach

List the keywords people can text to sign up

Sorted alphabetically.

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

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

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Number of keywords to skip (default 0).

Response

Response Body · array of objects

idstringKeyword id.
keywordstringThe word people text in, in capitals.
channelstringChannel the keyword listens on.
book_idstring | nullContact book new sign-ups are added to.
book_namestring | nullName of that contact book.
tagsarray of stringsTags given to new sign-ups.
reply_textstring | nullReply sent when someone texts the keyword.
confirm_textstring | nullQuestion sent first when double opt-in is on.
double_opt_inbooleanWhether people must confirm with YES before they are signed up.
wordingstring | nullConsent wording stored with each sign-up.
is_activebooleanWhether the keyword is listening.
created_atstringWhen the keyword was created.
updated_atstringWhen the keyword last changed.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/outreach/keywords \
--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": "4",
"keyword": "JOIN",
"channel": "sms",
"book_id": "42",
"book_name": "Event sign-ups",
"tags": [
"newsletter"
],
"reply_text": "Thanks for joining!",
"confirm_text": null,
"double_opt_in": false,
"wording": null,
"is_active": true,
"created_at": "2026-09-01T09:00:00.000Z",
"updated_at": "2026-09-01T09:00:00.000Z"
}
],
"meta": {
"limit": 50,
"offset": 0,
"total": 1,
"has_more": false
}
}