SoftSolzSoftSolz
HomeAPI GuideAPI ReferenceWidget Tester
Outreach

List the people in a contact book

Newest first.

GEThttps://app.softsolz.uk/api/v1/services/outreach/contact-books/{id}/entries

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

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Rows to skip (default 0).

Response

Response Body · array of objects

idstringEntry id.
phonestring | nullPhone number with country code.
emailstring | nullEmail address.
display_namestring | nullName.
variablesobjectExtra values for merge fields, keyed by name.
created_atstringWhen the person was added.

Request

curl --request GET \
--url https://app.softsolz.uk/api/v1/services/outreach/contact-books/{id}/entries \
--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": "7001",
"phone": "+447700900123",
"email": "jane@example.com",
"display_name": "Jane Doe",
"variables": {
"first_name": "Jane"
},
"created_at": "2026-09-01T09:00:00.000Z"
}
],
"meta": {
"limit": 50,
"offset": 0,
"total": 1,
"has_more": false
}
}