Приглашённые регистрации

Получить все

Эндпоинт

GET https://serpmax.ru/api/referrals-users/

Пример

curl --request GET \
--url 'https://serpmax.ru/api/referrals-users/' \
--header 'Authorization: Bearer {api_key}' \

Параметры	Подробности	Описание
referred_by_has_converted	Необязательный Целое число	Допустимые значения: `0`, `1`
datetime_field	Необязательный Строка	Допустимые значения: `datetime`
datetime_start	Необязательный Строка	Фильтр результатов начиная с этой даты. Формат `Y-m-d H:i:s`.
datetime_end	Необязательный Строка	Фильтр результатов до этой даты. Формат `Y-m-d H:i:s`.
order_by	Необязательный Строка	По какому полю сортировать результаты. Допустимые значения: `datetime`, `referred_by_has_converted`.
order_type	Необязательный Строка	Порядок сортировки. Допустимые значения: `ASC` — по возрастанию, `DESC` — по убыванию.
page	Необязательный Целое число	Номер страницы результатов. По умолчанию `1`.
results_per_page	Необязательный Целое число	Сколько результатов на странице. Допустимые значения: `10`, `25`, `50`, `100`, `250`, `500`, `1000`. По умолчанию `25`.

Пример ответа

{
    "data": [
        {
            "referral_code": "ref_a1b2c3",
            "status": "converted",
            "is_converted": true,
            "payment_types": [
                "one_time",
                "recurring"
            ],
            "commission_statuses": [
                "pending",
                "approved"
            ],
            "total_affiliate_commissions": 2,
            "total_affiliate_commissions_amount": 12.5,
            "pending_affiliate_commissions": 1,
            "approved_affiliate_commissions": 1,
            "withdrawn_affiliate_commissions": 0,
            "latest_affiliate_commission_datetime": "2026-10-24 22:29:37",
            "currency": "RUB",
            "datetime": "2026-10-24 22:29:37"
        }
    ],
    "meta": {
        "page": 1,
        "results_per_page": 25,
        "total_results": 1,
        "total_pages": 1
    },
    "links": {
        "first": "https://serpmax.ru/api/referrals-users?page=1",
        "last": "https://serpmax.ru/api/referrals-users?page=1",
        "next": null,
        "prev": null,
        "self": "https://serpmax.ru/api/referrals-users?page=1"
    }
}