---
title: "Customers with their order counts"
method: GET
path: "/shops/{shopId}/customers"
tags: ["Shops"]
---

# Customers with their order counts

`GET /shops/{shopId}/customers`

## Request

- Base URL: `https://hostingsurge.com/api/v1`
- URL: `https://hostingsurge.com/api/v1/shops/{shopId}/customers`
- Auth: one of:
  - HTTP bearer
  - API key in cookie `__Host-hs_session`

## Path parameters

- `shopId` string, uuid, required

## Query parameters

- `q` string

## Response `200`

Customers

- object
  - `items` object[], required
    - `id` string, uuid, required
    - `email` string, required
    - `name` string, nullable, required
    - `phone` string, nullable, required
    - `addresses` object[], required
      - `name` string
      - `company` string
      - `line1` string, required
      - `line2` string
      - `postalCode` string, required
      - `city` string, required
      - `region` string
      - `country` string, required
    - `orderCount` integer, required
    - `totalSpentMinor` integer, required: Minor units of the shop currency (öre, cents)
    - `createdAt` string, required: ISO-8601 timestamp
    - `lastLoginAt` string, nullable, required: ISO-8601 timestamp

## Other responses

- `400`: Invalid request (code invalid_request; details.issues)
- `401`: Missing or invalid session/token (code unauthorized)
- `403`: Authenticated but not permitted (code forbidden)
- `404`: Not found or not visible to the caller (code not_found)
- `409`: Refused in this state (code conflict; details.reason: slug_taken, code_taken, order_status, has_orders, …)
- `501`: Not available on this server (code not_configured; details.reason stripe_off when card payments are off)
- `503`: A payment provider is unavailable (code provider_unavailable)

---

[API](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api.md) · [All operations](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/llms.txt) · [OpenAPI document](https://skmtc.dev/hostingsurge/apis/hostingsurge-platform-api/revisions/4d08337cdff1?raw)