SoftSolzSoftSolz
Sign up
HomeAPI GuideAPI ReferenceWidget Tester
Outreach

List contact books

Sorted by name. A plain API key sees only contact books shared with the whole workspace.

GEThttps://app.softsolz.uk/api/v1/services/outreach/contact-books

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

Rows to skip (default 0).

Response

Response Body · array of objects

idstringContact book id.
tenant_idstringWorkspace id.
namestringContact book name.
descriptionstring | nullWhat the book is for.
created_byinteger | nullMember who created the book.
created_atstringWhen the book was created.
updated_atstringWhen the book last changed.
entry_countintegerPeople in the book.
phone_countintegerPeople in the book with a phone number.
email_countintegerPeople in the book with an email address.
visibilitystringWho can see it: private (only the creator), tenant (the whole workspace) or shared (named people or roles).
shared_usersarray of objectsMembers it is shared with, when visibility is shared. Included when listing or reading one.
shared_rolesarray of objectsRoles it is shared with, when visibility is shared. Included when listing or reading one.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/outreach/contact-books \
  --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": "42",
      "tenant_id": "4c1a7e52-9b3d-4f86-a2e1-7d5c0b9f3e61",
      "name": "Event sign-ups",
      "description": "People who signed up at the spring fair.",
      "created_by": 4115,
      "created_at": "2026-09-01T09:00:00.000Z",
      "updated_at": "2026-09-01T09:00:00.000Z",
      "entry_count": 250,
      "phone_count": 240,
      "email_count": 180,
      "visibility": "tenant",
      "shared_users": [
        {
          "user_id": 4115,
          "name": "Jane Doe",
          "email": "jane@example.com"
        }
      ],
      "shared_roles": [
        {
          "role_id": 12,
          "role_name": "manager"
        }
      ]
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  }
}