Skip to content

Your referred teams, credits and tiers

GET
/api/referral/rewards
curl --request GET \
--url https://foxleague.ai/api/referral/rewards \
--header 'Authorization: Bearer <token>'

Answers the teams that registered with your invitations, each with its progress (matches_played of matches_required, counted live: a match counts once its result is public, so a tournament match counts only after its broadcast ended), its deadline and the reward promised to you when it qualifies; the in-game credits you earned (a Recover All credit per qualified friend; the XP booster and Common pack tiers, each once ever) with whether the app can use them now; and where you stand on each tier.

A friend’s match counts when it is one that moves ELO: a ranked match the friend started against a real opponent, a Silver or Gold tournament match, a paid Bronze tournament match that is public (or private while rules.private_bronze_earns is on). A tournament match counts on either side. A ranked match another team started and the friend was drawn into, a casual game, a match of a free tournament, a forfeit, a match the ELO pair cap stopped (it moved no ELO: elo_pair_capped_nth on the match), a match against you and a match outside the friend’s window do not count.

Who: a signed-in player with a team.

Refusals: none.

Success or a refusal: read success (the refusals are in the description).

Media type application/json
object
code

A machine-readable reason next to error, set only where the caller must act differently. tx_pending: the payment was not refused but could not be verified yet; keep the transaction hash and confirm again with the same hash, never pay twice.

string | null
data

The answer. Present when success is true.

object
credits
required

Your credits, oldest first, used ones included.

Array<object>

One in-game credit you earned.

object
friend_team

The friend whose qualification earned it. null for a tier credit.

string | null
granted_at
required

When you earned it (RFC 3339, UTC).

string
id
required

The credit id (POST /api/referral/credits/{id}/use).

integer format: int64
kind
required

recover_all (your squad’s players below full condition back to 100), xp_booster (the shop’s XP booster, started when you use it) or common_pack (five Common players from the pool, delivered to your wallet).

string
redeemed_at

When you used it (RFC 3339, UTC). null while unused.

string | null
usable
required

true when you can use it now: it is unused.

boolean
inviter_tickets
required

Free ranked tickets you get when a friend who registers now qualifies.

integer format: int64
matches_required
required

Matches a friend who registers now must play to qualify.

integer format: int64
referred
required

The teams that registered with your invitations, oldest first.

Array<object>

A team that registered with one of your invitations.

object
deadline
required

The end of the window (RFC 3339, UTC).

string
inviter_tickets
required

Free ranked tickets you get when this friend qualifies, fixed when the team registered.

integer format: int64
matches_played
required

Qualifying matches played so far, counted once each result is public.

integer format: int64
matches_required
required

Matches this friend must play, fixed when the team registered.

integer format: int64
qualified_at

When the friend qualified (RFC 3339, UTC). null otherwise.

string | null
recover_all
required

true when a Recover All credit is part of your reward for this friend.

boolean
referral_id
required

The referral’s id.

integer format: int64
registered_at
required

When the friend’s team registered (RFC 3339, UTC).

string
status
required

pending (still counting), qualified (your reward was granted) or expired (the window ended first).

string
team

The friend’s team name.

string | null
tickets_granted
required

Free ranked tickets the programme granted you so far.

integer format: int64
tiers
required

The XP booster and Common pack tiers.

Array<object>

A tier reward and where you stand on it.

object
at_friends
required

Qualified friends needed.

integer format: int64
granted
required

true once the tier fired. Each tier fires once per team, ever.

boolean
kind
required

xp_booster or common_pack.

string
qualified_friends
required

Your qualified friends so far.

integer format: int64
window_days
required

Days a friend who registers now has to play them.

integer format: int64
error

Why the request was refused, in plain words. Present when success is false.

string | null
success
required

true when the request did what it asked. false is a refusal: read error.

boolean
Example
{
"success": true,
"data": {
"referred": [
{
"referral_id": 12,
"team": "Steaua Nordului",
"status": "pending",
"matches_played": 3,
"matches_required": 5,
"registered_at": "2026-11-14T09:12:00Z",
"deadline": "2026-12-14T09:12:00Z",
"qualified_at": null,
"inviter_tickets": 5,
"recover_all": true
}
],
"credits": [
{
"id": 4,
"kind": "recover_all",
"granted_at": "2026-11-20T18:00:00Z",
"redeemed_at": null,
"friend_team": "FC Vultur",
"usable": true
},
{
"id": 7,
"kind": "common_pack",
"granted_at": "2026-11-28T18:00:00Z",
"redeemed_at": null,
"friend_team": null,
"usable": true
}
],
"tiers": [
{
"kind": "xp_booster",
"at_friends": 3,
"qualified_friends": 1,
"granted": false
},
{
"kind": "common_pack",
"at_friends": 5,
"qualified_friends": 1,
"granted": false
}
],
"tickets_granted": 5,
"matches_required": 5,
"window_days": 30,
"inviter_tickets": 5
}
}

No valid session. The body is plain text: Missing Authorization header, Invalid Authorization format, Invalid session token or Session expired or invalid. Sign in again.

Media type text/plain
string
Example
Session expired or invalid

A database read failed. The body is empty.