List customers

GET

/customers

const url = 'https://example.com/customers?includeArchived=true&limit=50&offset=0&sort=name&dir=asc&owing=true&kind=commercial&marketing=email&surcharge=add&ordering=stopped&shop=confirmed&activity=returning';
const options = {
  method: 'GET',
  headers: {cookie: '__Host-bottle.session_token=<__Host-bottle.session_token>'}
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example.com/customers?includeArchived=true&limit=50&offset=0&sort=name&dir=asc&owing=true&kind=commercial&marketing=email&surcharge=add&ordering=stopped&shop=confirmed&activity=returning' \
  --cookie __Host-bottle.session_token=<__Host-bottle.session_token>

Returns the tenant’s customers, ordered by trading name. Archived customers are excluded unless includeArchived=true.

Authorizations

sessionCookie
customers:read
apiKey
customers:read

Parameters

Query Parameters

Search trading name

string

<= 100 characters

Search trading name

includeArchived

string

default: false

Allowed values: true false

limit

integer

default: 50 >= 1 <= 200

offset

integer | null

sort

string

default: name

Allowed values: name owed overdue

dir

string

Allowed values: asc desc

owing

string

default: false

Allowed values: true false

kind

string

Allowed values: commercial domestic

rateSet

Any of:

string
string

UUID v7

string format: uuid

Example

019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

marketing

Only customers whose consent on this channel is granted.

string

Allowed values: email sms phone post

Only customers whose consent on this channel is granted.

surcharge

Add: on the chosen list for the business surcharge. exclude: on the excluded list.

string

Allowed values: add exclude

Add: on the chosen list for the business surcharge. exclude: on the excluded list.

ordering

Stopped: orders or deliveries are stopped now, for money owed. rule: set to stop while unpaid, owing or not.

string

Allowed values: stopped rule

Stopped: orders or deliveries are stopped now, for money owed. rule: set to stop while unpaid, owing or not.

shop

Confirmed: at least one shop sign-in for this customer has a confirmed email. unconfirmed: has a shop sign-in, none confirmed. none: no shop sign-in.

string

Allowed values: confirmed unconfirmed none

Confirmed: at least one shop sign-in for this customer has a confirmed email. unconfirmed: has a shop sign-in, none confirmed. none: no shop sign-in.

createdFrom

string format: date

createdTo

string format: date

activity

string

Allowed values: returning inactive

activityFrom

string format: date

activityTo

string format: date

Responses

200

Customers

application/json

object

items

required

Array<object>

object

accountAccess

object

unpaidInvoices

required

boolean

newOrdersBlocked

required

boolean

deliveriesBlocked

required

boolean

required

UUID v7

string format: uuid

tradingName

required

string

>= 1 characters <= 160 characters

accountNumber

string | null

kind

required

string

Allowed values: commercial domestic

legalName

required

string | null

<= 200 characters

contactName

required

string | null

<= 200 characters

email

required

string | null format: email

phone

required

string | null

/^\+?[\d\s()-]{7,20}$/

paymentTerms

required

string

Allowed values: prepaid on_account cash_on_delivery

surchargeRule

string | null

Allowed values: add exclude

blockNewOrdersWhenUnpaid

boolean

blockBookedDeliveriesWhenUnpaid

boolean

preferredLocale

required

A language: en-GB English, ar Arabic, ur Urdu, pa Punjabi (Gurmukhi), hi Hindi, bn Bengali, gu Gujarati, zh-Hans Chinese (Simplified), pl Polish, ro Romanian, es Spanish, fr French, de German.

string | null

Allowed values: en-GB ar ur pa hi bn gu zh-Hans pl ro es fr de

paymentTermsDays

required

integer | null

<= 120

billingAddressId

required

UUID v7

string | null format: uuid

hireBillingPeriod

required

string | null

Allowed values: weekly monthly quarterly

cylinderCharge

required

Deposit: paid once with the cylinder and refunded on return. rent: charged while they keep it, no deposit.

string | null

Allowed values: deposit rent both

rateSetId

required

UUID v7

string | null format: uuid

invoiceSchedule

One of:

object

mode

required

string

Allowed values: business

hireBilledTo

required

string | null format: date

notes

required

string | null

<= 2000 characters

archivedAt

required

string | null format: date-time

mergedIntoId

required

UUID v7

string | null format: uuid

legalHold

required

boolean

erasedAt

required

string | null format: date-time

contacts

Array<object>

object

required

UUID v7

string format: uuid

name

required

string

email

required

string format: email

phone

required

string | null

/^\+?[\d\s()-]{7,20}$/

kind

required

string

Allowed values: normal billing both

relationship

required

string | null

<= 60 characters

shopperAccounts

Array<object>

object

required

UUID v7

string format: uuid

email

required

string

verified

required

boolean

lastSignInAt

required

string | null format: date-time

twoFactor

required

boolean

role

required

string

Allowed values: manager buyer accounts

shopperInvitations

Array<object>

object

required

UUID v7

string format: uuid

email

required

string

role

required

string

Allowed values: manager buyer accounts

expiresAt

required

string format: date-time

createdAt

required

string format: date-time

createdAt

required

string format: date-time

updatedAt

required

string format: date-time

owedPence

required

integer

overduePence

required

integer

total

required

integer

Example

{
  "items": [
    {
      "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "tradingName": "Camden Lock Grill",
      "accountNumber": "BTL00313",
      "kind": "commercial",
      "legalName": "Camden Lock Grill Ltd",
      "contactName": "Priya Shah",
      "email": "orders@camdenlockgrill.co.uk",
      "phone": "07700 900123",
      "paymentTerms": "prepaid",
      "surchargeRule": "add",
      "preferredLocale": "en-GB",
      "billingAddressId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "hireBillingPeriod": "weekly",
      "cylinderCharge": "deposit",
      "rateSetId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "invoiceSchedule": {
        "mode": "business"
      },
      "mergedIntoId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
      "contacts": [
        {
          "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
          "phone": "07700 900123",
          "kind": "normal",
          "relationship": "Accounts"
        }
      ],
      "shopperAccounts": [
        {
          "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
          "role": "manager"
        }
      ],
      "shopperInvitations": [
        {
          "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
          "role": "manager"
        }
      ]
    }
  ]
}

401

Not signed in

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

403

Not a member of that tenant

application/json

object

error

required

string

message

required

string

Example

{
  "error": "not_found",
  "message": "Customer not found"
}

422

Validation failed

application/json

object

error

required

string

Allowed values: validation

message

required

string

issues

required

Array<object>

object

path

required

string

message

required

string

Example

{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}