---
title: "Get Customers"
method: GET
path: "/v1/shops/{shopId}/customers"
tags: ["Customers"]
---

# Get Customers

`GET /v1/shops/{shopId}/customers`

Retrieves the customers.

## Request body

- object
  - `page` integer — Page number.
  - `perPage` integer — Items per page, 1-100. Must be at least 1. Must not be greater than 100.
  - `orderColumn` 'id' | 'email' | 'discord_id' | 'discord_username' | 'balance' | 'total_completed' | 'total_spent_usd' | 'last_completed_at' | 'newsletter_at' | 'affiliate_code'
  - `orderDirection` 'asc' | 'desc'
  - `id` string — Filter by customer ID.
  - `email` string — Filter by email.
  - `discord_id` string
  - `discord_username` string
  - `subscribed` string — Only newsletter subscribers.
  - `affiliate_code` string — Filter by affiliate code.
  - `affiliate_referrer_email` string — Filter by referring affiliate email.

## Response `200`

- object
  - `current_page` integer
  - `data` object[]
    - `id` integer
    - `email` string
    - `discord_id` string
    - `discord_username` string
    - `balance` string
    - `total_completed` integer
    - `total_spent_usd` string
    - `last_completed_at` string
    - `newsletter_at` string
    - `affiliate_code` string
    - `affiliate_referrer_id` string
    - `affiliate_referrer` string
  - `first_page_url` string
  - `from` integer
  - `last_page` integer
  - `last_page_url` string
  - `links` object[]
    - `url` string
    - `label` string
    - `active` boolean
  - `next_page_url` string
  - `path` string
  - `per_page` integer
  - `prev_page_url` string
  - `to` integer
  - `total` integer

---

[API](https://skmtc.dev/sellauth/apis/sellauth-api.md) · [All operations](https://skmtc.dev/sellauth/apis/sellauth-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/sellauth/sellauth-api/revisions/945e6d749d68/schema)