Skip to main content
GET
/
contests
/
referral
/
{contest_id}
Get Referral
curl --request GET \
  --url https://api.example.com/contests/referral/{contest_id} \
  --header 'X-API-Key: <api-key>'
{
  "id": 123,
  "title": "<string>",
  "contest_type": "<string>",
  "start_at": "2023-11-07T05:31:56Z",
  "end_at": "2023-11-07T05:31:56Z",
  "daily_summary_time": "<string>",
  "timezone": "<string>",
  "is_active": true,
  "final_summary_sent": true,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "prize_text": "<string>",
  "daily_summary_times": "<string>",
  "last_daily_summary_date": "2023-12-25",
  "last_daily_summary_at": "2023-11-07T05:31:56Z",
  "created_by": 123,
  "total_events": 123,
  "leaderboard": [
    {
      "user_id": 123,
      "referrals_count": 123,
      "total_amount_kopeks": 123,
      "total_amount_rubles": 123,
      "telegram_id": 123,
      "username": "<string>",
      "full_name": "<string>"
    }
  ]
}

Documentation Index

Fetch the complete documentation index at: https://docs.bedolagam.ru/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
contest_id
integer
required

Query Parameters

​
leaderboard_limit
integer
default:5
Required range: 1 <= x <= 50

Response

Successful Response

​
id
integer
required
​
title
string
required
​
contest_type
string
required
​
start_at
string<date-time>
required
​
end_at
string<date-time>
required
​
daily_summary_time
string<time>
required
​
timezone
string
required
​
is_active
boolean
required
​
final_summary_sent
boolean
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
description
string | null
​
prize_text
string | null
​
daily_summary_times
string | null
​
last_daily_summary_date
string<date> | null
​
last_daily_summary_at
string<date-time> | null
​
created_by
integer | null
​
total_events
integer | null
​
leaderboard
ReferralContestLeaderboardItem · object[] | null