List appointment customers.

GEThttps://app.softsolz.uk/api/v1/services/appointments/customers

Recent Requests

TimeStatusUser Agent

Make a request to see history.

Headers

Authorizationstringrequired

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

Query Params

searchstring

Case-insensitive match against name, email, or phone.

tagstring

Only customers with this tag.

limitinteger

Page size, 1-200.

offsetinteger

Pagination offset.

Response

Response Body · array of objects

idintegerUnique identifier.

display_namestringName shown throughout the product.

emailstring | nullEmail address.

phonestring | nullPhone number in international format.

timezonestring | nullIANA timezone, for example Europe/London.

addressesarray of objectsSaved addresses.

tagsarray of stringsFree-form labels for grouping and filtering.

custom_fieldsobjectYour own extra fields, keyed by the definitions in workspace settings.

no_show_countintegerHow many appointments this person did not attend.

completed_countintegerHow many appointments this person attended.

created_atstringWhen the record was created.

updated_atstringWhen the record was last changed. Round-trip as expected_updated_at to guard against stale writes.

Request

import { SoftSolz } from '@softsolz/sdk';

const client = new SoftSolz({ apiKey: process.env.SOFTSOLZ_API_KEY });

const result = await client.appointments.listCustomers({});
console.log(result);

Credentials

Authorization

Sent as a Bearer token. Stored only in your browser.

Response · 200

{
  "data": [
    {
      "id": 0,
      "display_name": "string",
      "email": "string",
      "phone": "string",
      "timezone": "string",
      "addresses": [],
      "tags": [],
      "custom_fields": {},
      "no_show_count": 0,
      "completed_count": 0,
      "created_at": "string",
      "updated_at": "string"
    }
  ]
}