---
title: "GET /v2/customers"
method: GET
path: "/v2/customers"
tags: ["customers"]
---

# GET /v2/customers

`GET /v2/customers`

## Query parameters

- `since_id` integer
- `limit` integer
- `page` integer
- `sort_field` 'id' | 'updated_at'
- `sort_direction` 'asc' | 'desc'
- `cursor` string — Fetch another page of results using a cursor returned in a previous response
- `email` string
- `created_at_min` string
- `created_at_max` string
- `updated_at_min` string
- `updated_at_max` string

## Response `200`

200

- CustomersListCustomersResponseBody
  - `customers` object[], required
    - `id` number, required
    - `merchant_id` string, required
    - `email` string, nullable, required
    - `points_approved` number, required
    - `points_pending` number, required
    - `points_spent` number, required
    - `properties` object, required
    - `metadata` object, required
      - `shopify_source_url` string
    - `rewards_claimed` integer, required
    - `blocked` boolean, required
    - `guest` boolean, required
    - `enrolled` boolean, required
    - `enrolled_at` string, nullable, required
    - `referral_id` string, nullable, required
    - `referred_by` object, nullable, required
      - `id` number, required
      - `merchant_id` string, required
    - `loyalty_tier_membership` object, nullable, required — Details of the customer's current tier membership, or `null` if the customer doesn't have one — e.g. guests, blocked or unenrolled customers, or programs without tiers enabled
      - `started_at` string, required
      - `expires_at` string, nullable, required
      - `manual` boolean, nullable, required
      - `loyalty_tier` object, required
        - `id` number, required
        - `name` string, required
        - `number` number, required
        - `default` boolean, required
        - `hidden` boolean, required
        - `lower_bound` string, required
        - `upper_bound` string, nullable, required
        - `position` number, required
    - `insights_segment` 'At Risk' | 'Win Back' | 'Loyal', nullable, required
    - `birthday` string, nullable, required
    - `referral_url` string, required
    - `receipt_upload_url` string, nullable, required
    - `loyalty_pass_url` string, nullable, required
    - `linked_merchant_ids` string[]
    - `created_at` string, required
    - `updated_at` string, required
  - `cursor` object, required — Cursors that can be used to fetch the previous or next page of results. If a cursor is `null`, it means there are no more results in that direction
    - `prev` string, nullable, required
    - `next` string, nullable, required

## Other responses

- `400` — Bad Request
- `401` — 401
- `403` — 403

---

[API](https://skmtc.net/loyaltylion/apis/loyaltylion-admin-api.md) · [All operations](https://skmtc.net/loyaltylion/apis/loyaltylion-admin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/loyaltylion/loyaltylion-admin-api/versions/4cfed13b45bc/schema)