Рефсейлс API
Клиенты

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

GET
/api/v1/customers

Клиенты магазина. Удалённые клиенты в список не попадают. Выручка в копейках. Право: customers:read.

Авторизация

bearerApiKey
headerАвторизацияBearer <ключ>

Ключ API в заголовке Authorization: Bearer rsk_live_…. Ключ создаёт владелец магазина: Настройки → Интеграции → API-ключи.

filter[email]?string

Email, без учёта регистра.

filter[phone]?string

Телефон в любом формате: +7 900 000-00-00, 89000000000.

filter[telegramId]?string

Telegram ID клиента, например 123456789.

filter[updatedAt][from]?string

Изменены не раньше, ISO 8601 включительно.

Formatdate-time
filter[updatedAt][to]?string

Изменены не позже, ISO 8601 включительно.

Formatdate-time
order?string

Сортировка. По умолчанию createdAt:desc. Для синхронизации берите updatedAt:asc.

Value in"createdAt:desc""createdAt:asc""updatedAt:desc""updatedAt:asc"
cursor?string

Курсор из page.nextCursor предыдущего ответа. Работает только с той же сортировкой.

limit?integer

Размер страницы от 1 до 100. По умолчанию 50.

Ответ

Страница клиентов.

application/json
  1. response
data*array<>

Записи текущей страницы.

page*

Пагинация.

curl -X GET "https://example.com/api/v1/customers"
{  "data": [    {      "id": "2c8e4a1f-9b3d-4f7e-a6c0-5d1b8e3f2a96",      "name": "Иван Петров",      "email": "customer@example.com",      "phone": "+7 (900) 000-00-00",      "phoneDigits": "79000000000",      "telegramId": "123456789",      "source": "order",      "notes": "Предпочитает доставку после 18:00",      "totalOrders": 4,      "totalRevenue": 1164000,      "firstSeenAt": "2026-03-02T10:21:00.418265+00:00",      "lastOrderAt": "2026-09-12T09:41:07.418265+00:00",      "createdAt": "2026-03-02T10:21:00.418265+00:00",      "updatedAt": "2026-09-12T09:41:07.418265+00:00"    }  ],  "page": {    "nextCursor": null,    "hasMore": false  }}