---
title: "Список клиентов"
method: GET
path: "/customers"
tags: ["Customers"]
---

# Список клиентов

`GET /customers`

Получение списка клиентов компании, начиная с новых.

## Query parameters

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

## Response `200`

Постраничный список клиентов компании.

- object
  - `rows` Customer[] — Список клиентов.
    - `uid` string, nullable — Идентификатор клиента в UDS (UID).
    - `avatar` string, nullable — URL изображения клиента.
    - `displayName` string — Имя клиента.
    - `gender` 'MALE' | 'FEMALE' | 'NOT_SPECIFIED', nullable — Пол.
    - `phone` string, nullable — Номер телефона клиента.
    - `birthDate` string, date, nullable — Дата рождения клиента.
    - `participant` Participant — Данные клиента в программе лояльности компании — баланс баллов, ставки скидок, статистика транзакций и уровень членства.
      - `id` integer, nullable — ID клиента в компании.
      - `inviterId` integer, nullable — ID клиента в компании, пригласившего данного клиента.
      - `points` number — Баланс бонусных баллов клиента.
      - `discountRate` number — Размер скидки (в процентах).
      - `cashbackRate` number — Размер кешбэка (в процентах) для данного клиента UDS.
      - `cashSpent` number — Общая сумма, оплаченная клиентом деньгами по всем завершённым покупкам (без учёта оплаты баллами). Используется для автоматического повышения уровня.
      - `savedFunds` number — Сумма общей выгоды с учетом прямой скидки и оплатой бонусами и сертификатами.
      - `invitedCount` integer — Общее количество людей, которых клиент пригласил в программу лояльности по реферальной ссылке.
      - `effectiveInvitedCount` integer — Количество приглашённых людей, совершивших хотя бы одну покупку (эффективные рекомендации). Используется для условий повышения уровня.
      - `operationsCount` integer — Общее количество покупок данного клиента.
      - `fullRefundsCount` integer — Количество полных возвратов.
      - `note` string, nullable — Заметка.
      - `membershipTier` MembershipTier — Конфигурация уровня (статуса) в программе лояльности. Определяет ставку скидки/кешбэка и условия автоматического повышения по сумме покупок или количеству рекомендаций.
        - `uid` string — Идентификатор статуса.
        - `name` string, required — Название статуса.
        - `rate` number, required — Коэффициент статуса.
        - `maxScoresDiscount` number, nullable — Процент счета, который можно оплатить бонусными баллами.
        - `conditions` object — Условия для автоматического назначения статуса.
          - `totalCashSpent` object, nullable — Повысить статус, когда сумма покупок достигнет данного значения.
            - `target` number — Сумма покупок.
          - `effectiveInvitedCount` object, nullable — Повысить уровень, когда клиент достигнет значения `effectiveInvitedCount`.
            - `target` integer — Количество эффективных рекомендаций.
      - `dateCreated` string, date-time, nullable — Дата, когда клиент присоединился к компании
      - `lastTransactionTime` string, date-time, nullable — Дата и время, когда клиент совершил последнюю транзакцию.
      - `pointsExpireIn` string, date-time, nullable — Срок действия бонусов клиента.
    - `channelName` string, nullable — Источник трафика.
    - `email` string, nullable — Email клиента.

---

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