Skip to Content
Developers
Customers

List customers

GET
/customers

Customers sorted by when the shop first saw them. Filter by email or phone to look one up, or by updated_after to fetch what changed since your last sync.

Keys: a key that may read. A public key gets 403.

Authorization

apiKey
headerAuthorizationBearer wo_live_...

A key from the shop's admin. Secret keys start with wo_live_, public keys with wo_pub_.

Query parameters

cursor?string

next_cursor from the page before. Leave out for the first page.

Lengthlength <= 200
limit?integer

How many objects a page holds.

Range1 <= value <= 100
Default25
order?string

The list sorts on created_at, then the id. desc puts the newest customer first.

Default"desc"
Value in"asc""desc"
email?string

The exact address, in any case.

Lengthlength <= 254
phone?string

The exact number in E.164, such as +32470123456.

Lengthlength <= 20
updated_after?string

Only customers changed after this moment. ISO 8601 with an offset, such as 2026-11-01T00:00:00Z.

Formatdate-time

Response body

The request worked.

application/json
  1. response
data*array<>
has_more*boolean

Whether another page follows this one.

next_cursor*|null
object*string
Example request
curl 'https://api.weerom.com/v1/customers'
Example response
{  "data": [    {      "blocked": false,      "created_at": "2026-04-11T09:05:22.000Z",      "email": "[email protected]",      "has_account": true,      "id": "5f0c9d3a-7b2e-4c61-8a4d-9e1f3b6c2d75",      "locale": "nl",      "name": "Lotte Peeters",      "no_show_count": 0,      "object": "customer",      "phone": "+32470123456",      "postal_code": "9000",      "updated_at": "2026-11-18T14:02:11.000Z"    }  ],  "has_more": false,  "next_cursor": null,  "object": "list"}

Details

Keys

Read keyWrite key

Any other kind of key answers 403 key_not_allowed.

Sort

By created_at, the moment the shop first saw the customer, then by id. order=desc, the default, lists the newest first. order=asc starts with the oldest.

Filters

  • email matches the whole address in any case. [email protected] finds [email protected]. Part of an address finds nothing.
  • phone matches the stored number exactly, as E.164: +32470123456. The API does not rewrite 0470 12 34 56 for you.
  • updated_after leaves out a customer changed at that exact moment.

What it does

  • There is no endpoint that makes a customer. A booking makes its customer.

When a field is null

  • email is null when the shop has no email for the customer.
  • postal_code is null when the customer never gave one.

Errors

Besides 401 for a missing, unknown or removed key, 403 plan_required, 429 rate_limited and 500 internal_error, which every endpoint can answer. Errors has all of them.

StatuscodeWhenWhat to do
400invalid_requestA parameter is malformed or unknown, a date has no time and offset, or the cursor is not one the API gave out.Fix the parameter param names.