Customers

Read customers linked to your store. A customer is "linked" if they were created by your POS (customerType: "pos") or have placed at least one order with you.

List customers

Scope: customers:read. Supports ?search= on name, email, phone.

Get a customer

Returns 404 if the customer is not linked to your store.

Customer object

json
{
  "id": "67d9...",
  "email": "jane@example.com",
  "name": "Jane Doe",
  "phone": "+1...",
  "company": "",
  "customerType": "online",
  "status": "active",
  "emailVerified": true,
  "newsletterSubscribed": false,
  "tags": ["vip"],
  "addresses": [
    {
      "id": "67d9a...",
      "label": "Home",
      "fullName": "Jane Doe",
      "addressLine1": "123 Main St",
      "city": "Beirut",
      "country": "Lebanon",
      "isDefault": true
    }
  ],
  "createdAt": "2026-03-15T08:00:00.000Z"
}

Privacy

Password hashes and verification tokens are never returned. The customers:writescope is reserved for v2 — there are no customer-mutation endpoints in v1.