Skip to main content
GET
Get Referral

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