Skip to content

Получить общий список партнёров

Request

Одна строка на партнёра с завершённым профилем и подтверждёнными документами, даже если реквизиты ещё не заполнены. Возвращаются два текущих уровня. Количество приглашённых и начисления в строке показаны за всю историю; статус активности определяется наличием подтверждённого приглашения за выбранный период. Даты не меняют текущие уровни.

Security
bearerAuth or jwtCookie
Query
fromstring, (date)^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Начало периода активности; передаётся вместе с to. По умолчанию текущий месяц. Год от 1 до 9999; предыдущий период сравнения также должен попадать в этот диапазон.

tostring, (date)^[0-9]{4}-[0-9]{2}-[0-9]{2}$

Конец периода активности включительно; передаётся вместе с from. Год от 1 до 9999.

searchstring, <= 200 characters

Поиск по имени партнёра без учёта регистра.

statusstring
Enum:"ACTIVE""INACTIVE"
client_level_codestring

Фильтр по текущему уровню клиентской линии. Если указан также business_level_code — должны совпасть оба уровня.

Enum:"START""DEVELOPMENT""PROFESSIONAL""STRATEGIC"
business_level_codestring

Фильтр по текущему уровню бизнес-линии. Можно применять отдельно или вместе с client_level_code.

Enum:"START""DEVELOPMENT""PROFESSIONAL""STRATEGIC"
offsetinteger, >= 0
Default:0
limitinteger, [ 1 .. 100 ]
Default:20
curl -i -X GET \
  'https://felmee.com/api/admin/referral/partners?from=2019-08-24&to=2019-08-24&search=string&status=ACTIVE&client_level_code=START&business_level_code=START&offset=0&limit=20' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Список получен; total содержит количество строк до пагинации

Bodyapplication/json
codeErrorstring or nullrequired

Устаревший camelCase-alias поля error_code; при ошибке оба поля содержат одинаковое значение.

successbooleanrequired

Флаг успешного выполнения запроса

messagestringrequired

Человекочитаемое описание результата

error_codestring or null(ERROR_CODE)required

Код ошибки. Для успешных ответов всегда null.

Enum:"INVALID_BODY""INVALID_DATE""invalid_body""unauthorized""not_found""slot_unavailable""conflict""BUSINESS_INACTIVE""INSUFFICIENT_FUNDS""REQUISITES_REQUIRED"
dataobject or null(AdminReferralPartnerPage)required

Полезная нагрузка. Может быть объектом, массивом или null.

Response
{ "success": true, "message": "Referral partners retrieved successfully", "codeError": null, "error_code": null, "data": { "items": [ … ], "total": 1, "offset": 0, "limit": 20 } }