v1

latestOpenAPI 3.1.02026-07-13143194365.4 KB
referrals

Get your referral network and referee earnings

Get the authenticated user's referral dashboard showing:

  • referral_code: Your shareable referral code (e.g., "GRV-ABC123")
  • stats: Aggregate metrics about your referral network
    • total_referees: Number of accounts you've referred
    • total_referee_earnings_usd: Total tips earned by your referees (as tippees)
    • avg_referee_earnings_usd: Average tips earned per referee
  • referees: Paginated list of your referees with their individual earnings

Each referee shows:

  • display_name: Their handle (if set) or truncated wallet address
  • display_type: Whether display_name is a "handle" or "wallet"
  • referred_at: When they joined
  • earnings_usd: Total tips they've received
  • tip_count: Number of tips they've received

Privacy: Only handles or wallet addresses are shown. No emails or phone numbers.

Authentication: Authorization: Bearer <CLIENT_JWT>

Query parameters:

  • limit: Maximum referees to return per page (default: 50, max: 100)
  • offset: Number of referees to skip for pagination (default: 0)
get/v1/referrals

Query parameters

limitinteger

Maximum referees to return

Maximum referees to return

offsetinteger

Number of referees to skip for pagination

Number of referees to skip for pagination

Headers

authorizationstring nullable

Bearer JWT issued by Grove that identifies the account.

Bearer JWT issued by Grove that identifies the account.

Response

Successful Response

referral_codestring required

This account's shareable referral code (e.g., GRV-ABC123)