Get Referral Stats

Get referral statistics for the current user.

GET /api/v1/referral/stats

Get Referral Stats

cURL

curl --request GET \
  --url https://api.example.com/api/v1/referral/stats \
  --header 'Authorization: Bearer <token>'

200

{
  "total_earned": 123,
  "active_referrals": 123,
  "referral_uses": [
    {
      "status": "<string>",
      "created_at": "<string>",
      "converted_at": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

200

application/json

Successful Response

total_earned · number · required

active_referrals · integer · required

referral_uses · ReferralUseSummary · object[] · required

Show child attributes