> ## Documentation Index > Fetch the complete documentation index at: https://docs.shoply.gg/llms.txt > Use this file to discover all available pages before exploring further. # List customers > The store's customers, a page at a time, each with how many orders they have paid for, what they have spent, their balance and their `tags`: Shoply's two first (`vip` and `disputed`, worked out from their orders as they are read), then the store's own. Needs the `customers.read` permission (Read Customers). ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId}/customers openapi: 3.1.0 info: title: Shoply API version: '1' description: >- Everything a store's own server can do with a secret API key: its catalogue, orders, customers, marketing, finance and the rest of what the dashboard does. And the Customer API, which a buyer's own device asks with a token of theirs. servers: - url: https://api.shoply.gg/v1 security: - apiKey: [] tags: - name: API key - name: Store - name: Domain - name: Payment methods - name: Analytics - name: Storefronts - name: Storefront code - name: Payment Routing - name: Custom payment methods - name: Products - name: Product pictures - name: Stock - name: Categories - name: Upsells - name: Subscriptions - name: Orders - name: Invoices - name: Reviews - name: Coupons - name: Coupon categories - name: Coupon pop-up - name: Sales - name: Blog - name: Search settings - name: Redirects - name: Sitemap - name: Cart Recovery - name: Email Marketing - name: Email Templates - name: Customers - name: Affiliates - name: Support Tickets - name: Blacklist - name: Fraud protection - name: Disputes - name: Finance - name: Tax - name: Expenses - name: Expense setup - name: API requests - name: Webhook endpoints - name: Webhook deliveries - name: Customer API paths: /stores/{storeId}/customers: get: tags: - Customers summary: List customers description: >- The store's customers, a page at a time, each with how many orders they have paid for, what they have spent, their balance and their `tags`: Shoply's two first (`vip` and `disputed`, worked out from their orders as they are read), then the store's own. Needs the `customers.read` permission (Read Customers). operationId: customers.list parameters: - name: storeId in: path required: true description: >- The store's ID. A key reaches the store it was made in: `GET /key` answers which. schema: type: string - name: page in: query required: false description: Which page of the list. The first is 1. schema: type: integer default: 1 - name: perPage in: query required: false description: How many a page holds. schema: type: integer default: 20 - name: search in: query required: false description: Part of an email address. schema: type: string - name: sort in: query required: false description: What the list is ordered by, largest or latest first. schema: type: string enum: - newest - spent - orders - recent - balance default: newest - name: only in: query required: false description: >- Only customers who are affiliates, or who are subscribed to the store's news and offers. schema: type: string enum: - affiliates - subscribed - name: tag in: query required: false description: >- Only customers wearing this tag: `vip`, `disputed`, or the ID of one of the store's own. schema: type: string - name: range in: query required: false description: Only customers first seen in this period. schema: type: string enum: - today - yesterday - 7d - 30d - this_week - last_week - this_month - last_month - this_year - name: from in: query required: false description: >- Only customers first seen on or after this day, as `YYYY-MM-DD`. With `to`, in place of `range`. schema: type: string - name: to in: query required: false description: Only customers first seen on or before this day, as `YYYY-MM-DD`. schema: type: string - name: tz in: query required: false description: The time zone those days are in, as an IANA name. Left out, UTC. schema: type: string example: Europe/Berlin responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: array items: type: object properties: id: type: string emailAddress: type: string dateCreated: type: string totalOrders: type: integer totalSpend: type: integer paidOrders: type: integer lastOrderAt: nullable: true balance: type: integer affiliateState: nullable: true tags: type: array items: type: object properties: id: type: string name: type: string tone: type: string automatic: type: boolean pages: type: integer total: type: integer meta: type: object properties: currencyCode: type: string example: success: true message: null code: null data: - id: f637fc21-973d-43ec-a7db-f819a9ebf73a emailAddress: ada@example.com dateCreated: '2026-10-22T16:20:18Z' totalOrders: 0 totalSpend: 0 paidOrders: 0 lastOrderAt: null balance: 0 affiliateState: null tags: - id: a537f7cb-125f-43a0-bd90-e29657620d76 name: Wholesale tone: primary automatic: false pages: 1 total: 1 meta: currencyCode: USD '401': $ref: '#/components/responses/NoKey' '403': $ref: '#/components/responses/NotAllowed' '404': $ref: '#/components/responses/NotFound' '429': $ref: '#/components/responses/TooMany' x-codeSamples: - lang: javascript label: Node.js source: | import Shoply from "@shoplygg/node"; const shoply = new Shoply({ apiKey: process.env.SHOPLY_API_KEY }); const page = await shoply.customers.list(); // Or every row of every page: for await (const row of shoply.customers.list()) { console.log(row); } - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $page = $shoply->customers->list(); // Or every row of every page: foreach ($shoply->customers->list() as $row) { print_r($row); } - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY page = client.customers.list() # Or every row of every page: for row in client.customers.list(): print(row) components: responses: NoKey: description: >- No API key was sent, or the one sent is not a live key: `api_key_required`, `invalid_api_key`. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotAllowed: description: >- The key is real and may not do this: `missing_scope` (with `requiredScope`), `ip_not_allowed`, `account_unavailable`, or `dashboard_only` for something only a person in the dashboard may do. content: application/json: schema: $ref: '#/components/schemas/Refusal' NotFound: description: >- There is no such thing in this store: `not_found`. A store that is not the key's own is answered the same way. content: application/json: schema: $ref: '#/components/schemas/Refusal' TooMany: description: >- The key has used up its budget for now: `rate_limited`. `Retry-After` says how many seconds to wait. content: application/json: schema: $ref: '#/components/schemas/Refusal' schemas: Refusal: type: object properties: success: type: boolean example: false message: type: string description: What is wrong, in words for a person. code: type: string description: What is wrong, as a word that does not change. data: nullable: true errors: type: object description: >- For `validation_failed`: what is wrong with each field, by the field's name. additionalProperties: type: string required: - success - message - code securitySchemes: apiKey: type: http scheme: bearer description: >- A secret API key, made under Developers in the dashboard: `Authorization: Bearer shoply_sk_...` ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.