---
title: "Get customers"
method: GET
path: "/stores/{storeId}/customers"
tags: ["Customer"]
---

# Get customers

`GET /stores/{storeId}/customers`

Retrieves a paginated list of customers for the specified store.
Requires the `stores.customers.view` permission.

## Path parameters

- `storeId` string, uuid, required

## Query parameters

- `email` string
- `ipAddress` string
- `balanceFrom` number, double
- `balanceTo` number, double
- `stripeCustomerId` string
- `affiliateCode` string
- `Filters` string
- `Sorts` string
- `Page` integer
- `PageSize` integer

## Response `200`

The object was successfully returned.

- PublicCustomerReferencePaginatedResponse — Represents a paginated response returned from API endpoints, which contains the paginated data and metadata about the pagination.
  - `success` boolean, required — Indicates whether the operation was successful
  - `pages` integer, required — The total number of pages available in the paginated response.
  - `data` PublicCustomerReference[], required — Represents the collection of items within a paginated response
    - `id` string, uuid, required — The unique identifier of the entity
    - `dateCreated` string, date-time, required — The date the entity was created
    - `emailAddress` string, required — The email address of the customer.
    - `status` string, required — The status of the customer based on their activity (e.g., New, Regular, VIP).
    - `isAffiliate` boolean, required — Whether the customer is an affiliate or not
    - `totalSpend` number, double, required — The total amount spent by the customer.
    - `averageSpend` number, double, required — The average amount spent by the customer.
    - `totalOrders` number, double, required — The total number of orders associated with the customer.
    - `isBlocked` boolean, required — Whether this customer is blocked from purchasing on this store.

## Other responses

- `400` — The provided form information is not valid, check that the provided data is valid. You can use the 'invalidFields' field to get the list of invalid fields or just use the 'message' field.
- `401` — You are not authorized, check your API key and try again.
- `403` — You are not authorized to access this endpoint, you may be missing an API key scope or be requesting a privileged endpoint.
- `404` — One of the objects referenced by the ID given in the URL or form was not found, check the ID and try again.

---

[API](https://skmtc.net/komerza/apis/komerza-api.md) · [All operations](https://skmtc.net/komerza/apis/komerza-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/komerza/komerza-api/revisions/060e78bc7f80/schema)