---
title: "Get Referral List"
method: GET
path: "/cabinet/referral/list"
tags: ["Cabinet Referral"]
---

# Get Referral List

`GET /cabinet/referral/list`

## Request

- The document declares no server URL.
- Auth: HTTP bearer
- TypeScript: <https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api/docs/cabinet/referral/list/get.ts> (a function with typed inputs; its response is checked against the schema)

Get list of invited users.

## Query parameters

- `page` integer: Page number
- `per_page` integer: Items per page

## Response `200`

Successful Response

- ReferralListResponse: Paginated referral list.
  - `items` ReferralItemResponse[], required
    - `id` integer, required
    - `username` string, nullable
    - `first_name` string, nullable
    - `created_at` string, date-time, required
    - `has_subscription` boolean, required
    - `has_paid` boolean, required
  - `total` integer, required
  - `page` integer, required
  - `per_page` integer, required
  - `pages` integer, required

## Other responses

- `422`: Validation Error

## Changes

- **2026-11-03** `2360876ff9c5`: 1 info
  - endpoint added

[Operation history](https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api/changes/cabinet/referral/list/get.md)

---

[API](https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api.md) - [All operations](https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api/llms.txt) - [OpenAPI document](https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api/revisions/2360876ff9c5?raw)