Skip to content

Получить рефералов текущего клиента

Request

Возвращает приглашённых друзей, текущий этап каждого приглашения и награду.

Security
bearerAuth or jwtCookie
Query
statusstring

Фильтр по этапу. WAITING объединяет ожидание записи и ожидание визита.

Enum:"WAITING""WAITING_FOR_BOOKING""WAITING_FOR_VISIT""COMPLETED""EXPIRED"
sortstring

Сортировка; по умолчанию registered_at_desc. Также поддерживается запись с запятой, например registered_at,desc; регистр и пробелы по краям игнорируются.

Default:"registered_at_desc"
Enum:"registered_at_asc""registered_at_desc""completed_at_asc""completed_at_desc""expires_at_asc""expires_at_desc""status_asc""status_desc""registered_at,asc""registered_at,desc"
offsetinteger

Сколько элементов пропустить. Отрицательное значение приводится к 0.

Default:0
limitinteger

Размер страницы. Значения меньше 1 приводятся к 1, больше 200 — к 200.

Default:100
curl -i -X GET \
  'https://felmee.com/api/referral/referrals?status=WAITING&sort=registered_at_asc&offset=0&limit=100' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Список рефералов успешно получен

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(ReferralsData)required

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

Response
{ "success": true, "message": "Referrals successfully retrieved", "codeError": null, "error_code": null, "data": { "items": [ … ] } }