Referrals

Get current user's referral program summary

Returns the signed-in user's referral summary: referral code, share_path, reward_credits and referred_reward_credits, attribution_window_days (30 by default), monthly_referrer_reward_cap, counts by status in stats, and recent items with the user's role. Creates the code on first use.

get/referrals/me

Request

  • Base URL: https://api.crawlora.net/api/v1
  • URL: https://api.crawlora.net/api/v1/referrals/me
  • Auth: none declared. Required headers: Authorization

Headers

Authorizationstring required

JWT token in the form Token <jwt>

Response

Referral summary

attribution_window_daysinteger
codestring
monthly_referrer_reward_capinteger
referred_reward_creditsinteger
reward_creditsinteger
share_pathstring

Example response

{
  "attribution_window_days": 30,
  "code": "A1B2C3D4E5F6",
  "items": [
    {
      "campaign": "spring-launch",
      "code": "A1B2C3D4E5F6",
      "id": "abc123",
      "reward_credits": 10000,
      "role": "referrer",
      "status": "rewarded"
    }
  ],
  "monthly_referrer_reward_cap": 10,
  "referred_reward_credits": 10000,
  "reward_credits": 10000,
  "share_path": "/r/A1B2C3D4E5F6",
  "stats": {
    "attributed": 3,
    "qualified": 1,
    "rewarded": 1
  }
}

Changes

No recorded changes to this operation across all 2 revisions of this API.