---
title: "List Referral"
method: GET
path: "/contests/referral"
tags: ["contests"]
---

# List Referral

`GET /contests/referral`

## Request

- The document declares no server URL.
- Auth: API key in header `X-API-Key`
- TypeScript: <https://skmtc.dev/bedolagam/apis/remnawave-bot-admin-api/docs/contests/referral/get.ts> (a function with typed inputs; its response is checked against the schema)

Получение списка реферальных конкурсов.

## Query parameters

- `contest_type` string, nullable
- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- ReferralContestListResponse
  - `items` ReferralContestResponse[], required
    - `id` integer, required
    - `title` string, required
    - `description` string, nullable
    - `prize_text` string, nullable
    - `contest_type` string, required
    - `start_at` string, date-time, required
    - `end_at` string, date-time, required
    - `daily_summary_time` string, time, required
    - `daily_summary_times` string, nullable
    - `timezone` string, required
    - `is_active` boolean, required
    - `last_daily_summary_date` string, date, nullable
    - `last_daily_summary_at` string, date-time, nullable
    - `final_summary_sent` boolean, required
    - `created_by` integer, nullable
    - `created_at` string, date-time, required
    - `updated_at` string, date-time, required
  - `total` integer, required
  - `limit` integer, required
  - `offset` 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/contests/referral/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)
