Партнёры

Партнёр — тот, кто приводит клиентов по реферальной ссылке или промокоду. Через внешний API можно получить полный список партнёров контура — например, чтобы сверить их с записями в своей CRM или посчитать вознаграждение на своей стороне.

Все пути ниже даны относительно базового адреса /api/external, каждый запрос требует заголовок x-api-key — см. Внешний API.

Как получить список партнёров

GET /api/external/partner
x-api-key: ваш-ключ

Метод возвращает всех партнёров контура одним списком — без пагинации и без параметров фильтрации. Партнёры отсортированы по дате регистрации, от новых к старым.

[
  {
    "id": "3d21…",
    "email": "partner@example.com",
    "firstName": "Иван",
    "middleName": null,
    "lastName": "Иванов",
    "isConfirmed": true,
    "emailConfirmedAt": "2026-08-01T10:05:00.000Z",
    "passwordSetAt": "2026-08-01T10:00:00.000Z",
    "isBlocked": false,
    "isActive": false,
    "lastActivityAt": null,
    "legalType": { "id": "a1c9…", "type": "IE", "hidden": false },
    "level": { "id": "9b7e…", "number": 1, "description": "Базовый" },
    "groups": [{ "id": "f001…", "title": "VIP" }],
    "leadCounts": [
      { "statusId": "0f8c…", "count": 5, "status": { "systemName": "new", "title": "Новый" } }
    ],
    "createdAt": "2026-08-01T10:00:00.000Z",
    "updatedAt": "2026-09-01T12:30:00.000Z"
  }
]

Что означают поля партнёра

Поле	Что означает
id	идентификатор партнёра
email	почта, которой партнёр входит в личный кабинет
firstName, middleName, lastName	имя партнёра; не заполнено — null
isConfirmed	администратор допустил партнёра к выплатам; с почтой не связано
emailConfirmedAt	когда партнёр подтвердил email — кодом или переходом по ссылке из письма; null — не подтверждён. Выплату партнёр запросит только при isConfirmed: true и заполненном emailConfirmedAt
passwordSetAt	когда партнёр сам задал пароль; null — партнёра завёл администратор, и он ещё не входил. Пароль задаёт только партнёр, через API его не передать
isBlocked	вход в личный кабинет заблокирован администратором
isActive	признак активности партнёра
lastActivityAt	дата последней активности партнёра; может быть null
legalType	юридический тип партнёра — см. ниже; null, если тип не выбран
level	уровень партнёра, влияет на условия вознаграждения; null, если уровень не назначен
groups	группы, в которые включён партнёр
leadCounts	количество лидов партнёра по каждому статусу
createdAt, updatedAt	даты регистрации и последнего изменения записи

Метод отдаёт только эти поля. Значения дополнительных полей партнёра — ИНН, паспортных данных, реквизитов организации — в списке нет, как нет и реквизитов выплаты. Реквизиты конкретной заявки отдаёт отдельный метод раздела выплат, а узнать заранее, у кого не заполнен ИНН, через API нельзя — отказ придёт в ответ на создание заявки.

Какой бывает юридический тип партнёра

Юридический тип определяет, какие дополнительные поля (паспортные данные, реквизиты ИП, реквизиты организации) администратор запрашивает у партнёра при регистрации. Состав полей, их обязательность и видимость задаются отдельно для каждого типа: одно и то же поле бывает обязательным у ИП и необязательным у физлица. Настраивается это в разделе Поля и юридические типы партнёра.

legalType.type	Что означает
Individual	физическое лицо
SelfEmployed	самозанятый
IE	индивидуальный предприниматель
LegalEntity	юридическое лицо

legalType.hidden означает, что администратор скрыл тип из формы регистрации — новые партнёры выбрать его уже не могут, но у партнёров, заведённых с этим типом раньше, запись сохраняется без изменений.

Какие ошибки возвращает метод

Собственных ошибок у GET /partner нет: любой валидный ключ получает полный список. Общие ошибки авторизации по x-api-key — в разделе Внешний API.

Читать также

• Внешний API — базовый адрес, ключи и остальные методы
• Выплаты — создание выплаты по partnerId из этого списка
• Поля и юридические типы партнёра — где администратор настраивает юридический тип