> ## 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. # Get a customer > One customer: their orders, their balance and its history, their `tags`, whether they are blacklisted, and their affiliate figures if they are one. Needs the `customers.read` permission (Read Customers). ## OpenAPI ````yaml /api-reference/openapi.json get /stores/{storeId}/customers/{customerId} 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/{customerId}: get: tags: - Customers summary: Get a customer description: >- One customer: their orders, their balance and its history, their `tags`, whether they are blacklisted, and their affiliate figures if they are one. Needs the `customers.read` permission (Read Customers). operationId: customers.show 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: customerId in: path required: true description: The customer. schema: type: string responses: '200': description: It worked. content: application/json: schema: type: object properties: success: type: boolean message: nullable: true code: nullable: true data: type: object properties: balance: type: integer balanceAtCheckout: type: boolean tags: type: array items: type: object properties: id: type: string name: type: string tone: type: string automatic: type: boolean balanceHistory: type: array items: type: object properties: id: type: string kind: type: string amount: type: integer balanceAfter: type: integer currencyCode: type: string note: type: string orderId: nullable: true by: type: string dateCreated: type: string affiliate: nullable: true blacklisted: type: boolean blacklistedBy: type: - array - object blacklistRules: type: integer knownAddresses: type: integer id: type: string emailAddress: type: string dateCreated: type: string totalOrders: type: integer totalSpend: type: integer paidOrders: type: integer lastOrderAt: nullable: true currencyCode: type: string ordersTruncated: type: boolean orders: type: - array - object example: success: true message: null code: null data: balance: 5 balanceAtCheckout: true tags: - id: a537f7cb-125f-43a0-bd90-e29657620d76 name: Wholesale tone: primary automatic: false balanceHistory: - id: ce46d95e-769f-4a0d-9469-7298d67f7a7b kind: add amount: 5 balanceAfter: 5 currencyCode: USD note: Goodwill credit orderId: null by: api-docs-25aa8416@noblecheats.net dateCreated: '2026-10-22T16:20:19Z' affiliate: null blacklisted: false blacklistedBy: [] blacklistRules: 0 knownAddresses: 0 id: f637fc21-973d-43ec-a7db-f819a9ebf73a emailAddress: ada@example.com dateCreated: '2026-10-22T16:20:18Z' totalOrders: 0 totalSpend: 0 paidOrders: 0 lastOrderAt: null currencyCode: USD ordersTruncated: false orders: [] '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 result = await shoply.customers.show("CUSTOMER_ID"); - lang: php label: PHP source: | getenv('SHOPLY_API_KEY')]); $result = $shoply->customers->show('CUSTOMER_ID'); - lang: python label: Python source: | import shoply client = shoply.Client() # reads SHOPLY_API_KEY result = client.customers.show("CUSTOMER_ID") 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.