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

# List customers

`GET /customers`

Retrieves a paginated list of customers enrolled in your company's loyalty program.
Use `max` and `offset` parameters to paginate through results.

## Query parameters

- `max` integer
- `offset` integer
- `cursor` string

## Response `200`

Paginated list of company customers.

- object
  - `rows` Customer[] — Customers information.
    - `uid` string, nullable — Customer ID in the UDS.
    - `avatar` string, nullable — Avatar URL.
    - `displayName` string — Customer name.
    - `gender` 'MALE' | 'FEMALE' | 'NOT_SPECIFIED', nullable — Customer's gender for personalization and marketing segmentation.
    - `phone` string, nullable — Participant phone number.
    - `birthDate` string, date, nullable — Customer birth date
    - `participant` Participant — Customer's loyalty program details within your company — point balance, discount rates, transaction statistics, and membership tier. This is the core loyalty data for a customer.
      - `id` integer, nullable — Participant ID.
      - `inviterId` integer, nullable — ID of the inviting participant.
      - `points` number — Available loyalty points that the customer can redeem for discounts on future purchases.
      - `discountRate` number — Current discount rate (percentage) based on the customer's membership tier. Applied to purchases when baseDiscountPolicy is APPLY_DISCOUNT.
      - `cashbackRate` number — Current cashback rate (percentage) based on the customer's membership tier. Determines points earned per purchase when baseDiscountPolicy is CHARGE_SCORES.
      - `cashSpent` number — Total amount the customer has paid in currency across all completed purchases (excluding point payments). Used for automatic membership tier upgrades based on spending thresholds.
      - `savedFunds` number — Total amount the customer has saved through discounts, point redemptions, and certificates across all transactions.
      - `invitedCount` integer — Total number of people this customer has invited to join the loyalty program via referral link.
      - `effectiveInvitedCount` integer — Number of invited people who made at least one purchase (effective referrals). Used for membership tier upgrade conditions.
      - `operationsCount` integer — Total number of completed purchase transactions by this customer.
      - `fullRefundsCount` integer — Number of fully refunded transactions for this customer.
      - `note` string, nullable — Note.
      - `membershipTier` MembershipTier — Membership tier (loyalty level) configuration. Defines the discount/cashback rate and automatic upgrade conditions based on spending or referral count.
        - `uid` string — Tier ID.
        - `name` string, required — Tier name.
        - `rate` number, required — Tier rate.
        - `maxScoresDiscount` number, nullable — The maximum discount (in percentage) allowed when redeeming points.
        - `conditions` object — Conditions to upgrade customer tiers automatically.
          - `totalCashSpent` object, nullable — Upgrade to tier when customer reaches target `cashSpent`.
            - `target` number — Amount of cash spent.
          - `effectiveInvitedCount` object, nullable — Upgrade to tier when customer reaches target `effectiveInvitedCount`.
            - `target` integer — Amount of invited count.
      - `dateCreated` string, date-time, nullable — Date and time when customer was registered in company.
      - `lastTransactionTime` string, date-time, nullable — Date and time when the customer made the last transaction.
      - `pointsExpireIn` string, date-time, nullable — Date and time when the customer's points will be expired.
    - `channelName` string, nullable — Acquisition channel name
    - `email` string, nullable — Customer email

---

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