List customersGET

OpenStock Docs

GET

/api/customer-balance-api/customers

customer_balance_api

Lists the store’s customers with their balances, newest first.

Authorization#

AuthorizationBearer <token>

In: header. A store API key starting with sk_ that has the customer_balance_api permission.

Query parameters#

limitinteger

Number of results to return, between 1 and 100. Default: 20

offsetinteger

Number of results to skip. Default: 0

min_balancenumber

Only customers with at least this balance.

searchstring

Case-insensitive match on email or name.

Responses#

200A page of customers.
401Missing, malformed, disabled or expired API key.
403The key lacks the customer_balance_api permission.

curl -X GET "https://openstock.dev/api/customer-balance-api/customers" \
  -H "Authorization: Bearer $OPENSTOCK_API_KEY"

A page of customers.

{
  "data": [
    {
      "id": "6f1d3c2a-0b4e-4c8d-9a7f-2e5b1c0d9a8e",
      "email": "jane@example.com",
      "name": "Jane Doe",
      "balance": 25,
      "total_spent": 189.5,
      "order_count": 7,
      "created_at": "2026-01-12T09:30:00.000Z",
      "updated_at": "2026-03-04T18:30:00.000Z"
    }
  ],
  "total": 1,
  "limit": 20,
  "offset": 0
}