List customers with optional search/limit/offset.

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

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

searchstring

Match against display_name or email.

is_activestring

Filter by active flag ("true"/"false").

limitinteger

Page size, 1-200 (default 50).

offsetinteger

Pagination offset (default 0).

Response

Response Body · array of objects

idintegerCustomer id.

display_namestringCustomer display name.

emailstring | nullPrimary AR email.

phonestring | nullContact phone.

billing_address_line1string | nullBilling address line 1.

billing_citystring | nullBilling city.

billing_postal_codestring | nullBilling postal code.

billing_countrystring | nullBilling country (ISO 2-letter).

tax_idstring | nullTax / VAT id.

default_payment_terms_daysintegerDefault payment terms in days.

default_currencystringDefault ISO 4217 currency code.

is_activebooleanFalse once archived.

created_atstringCreation timestamp.

updated_atstringLast update timestamp; round-trip as expected_updated_at.

Request

curl --request GET \
  --url https://app.softsolz.uk/api/v1/services/invoicing/customers \
  --header 'Authorization: Bearer sk_live_your_key'

Credentials

Authorization

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,
      "display_name": "SoftSolz Ltd",
      "email": "ar@softsolz.example",
      "phone": "+44 20 7946 0000",
      "billing_address_line1": "1 High St",
      "billing_city": "London",
      "billing_postal_code": "EC1A 1BB",
      "billing_country": "GB",
      "tax_id": "GB123456789",
      "default_payment_terms_days": 30,
      "default_currency": "GBP",
      "is_active": true,
      "created_at": "2026-01-15T09:30:00.000Z",
      "updated_at": "2026-01-15T09:30:00.000Z"
    }
  ],
  "meta": {
    "limit": 50,
    "offset": 0,
    "total": 1,
    "has_more": false
  }
}