Sign in

v1

latestOpenAPI 3.1.02026-07-13143194365.4 KB
referrals

Get your referral earnings summary

Get the authenticated user's referral earnings summary.

Returns earnings from commissions on tips received by your referees. Referrers earn a percentage of tips to their referees, deducted from Grove's fee.

Time windows:

  • 24h: Last 24 hours
  • 7d: Last 7 days
  • 30d: Last 30 days
  • all: All time (default)

Response fields:

  • total_earned_usd: Total earnings in the time window
  • total_paid_usd: Earnings that have been paid out
  • earnings_count: Number of earning events
  • referrer_type: Your referrer type ('user' or 'bdr')
  • reward_percentage: Your current reward percentage
  • duration_days: How long you earn on each referee

Authentication: Authorization: Bearer <CLIENT_JWT>

get/v1/referrals/earnings

Query parameters

window'24h' | '7d' | '30d' | 'all'

Time window for earnings summary

Time window for earnings summary

Headers

authorizationstring nullable

Bearer JWT issued by Grove that identifies the account.

Bearer JWT issued by Grove that identifies the account.

Response

Successful Response

total_earned_usdstring required

Total referral earnings in USD for the time window

total_paid_usdstring required

Total earnings that have been paid out in the time window

earnings_countinteger required

Number of referral earning events in the time window

referrer_typestring nullable

Referrer type: 'user' or 'bdr' (None if not a referrer)

reward_percentagestring nullable

Current reward percentage (e.g., '0.02' for 2%)

duration_daysinteger nullable

Reward window in days from referee signup