Public Playground

Preview the endpoint before sending a live request

Sample responses, schemas, request previews, and code snippets are visible before sign in. Create an account when you are ready to save an API key and run authenticated requests.

Set up API key Endpoint docs

Playground

Get current user's referral program summary API Playground

Returns the authenticated user's referral code, share path, reward settings, aggregate stats, and recent referral records.

GETjwt1 credit/requestreferrals.referralsMeResponseDocReferrals

Endpoint

Choose one catalog endpoint for this request.

9 shown

Group

Method

Auth

Endpoint

GETjwt1 credit/requestreferrals.referralsMeResponseDocReferrals

GET /referrals/me

Get current user's referral program summary

Returns the authenticated user's referral code, share path, reward settings, aggregate stats, and recent referral records.

Signed-in account session required before running this endpoint.

View docs

Authentication

Signed-in account session required before running this endpoint.

Add an API key to send a live request.

If an active API key is configured, Copy cURL includes it. Share links never include API keys.

View docs

Sample responseGET

Shown before your first request. Add an API key and send a request to see the live response, status, latency, and headers.

{
  "code": 200,
  "msg": "ok",
  "data": {
    "code": "A1B2C3D4E5F6",
    "share_path": "/r/A1B2C3D4E5F6",
    "reward_credits": 10000,
    "referred_reward_credits": 10000,
    "attribution_window_days": 30,
    "monthly_referrer_reward_cap": 10,
    "stats": {
      "attributed": 1,
      "rewarded": 0,
      "expired": 0,
      "capped": 0
    },
    "items": []
  }
}

Endpoint details

Returns the authenticated user's referral code, share path, reward settings, aggregate stats, and recent referral records.

Method: GET
Path: /referrals/me
Authentication: jwt
Credit cost: 1 credit/request
Platform: Referrals
Parameters: 1 documented fields

Request parameters

Authorization:header

Response schema fields

attribution_window_dayscodeitemsitems[].campaignitems[].codeitems[].created_atitems[].expires_atitems[].iditems[].qualified_atitems[].reward_creditsitems[].rewarded_atitems[].role

Sample response summary

{
  "code": 200,
  "msg": "ok",
  "data": {
    "code": "A1B2C3D4E5F6",
    "share_path": "/r/A1B2C3D4E5F6",
    "reward_credits": 10000,
    "referred_reward_credits": 10000,
    "attribution_window_days": 30,
    "monthly_referrer_reward_cap": 10,
    "stats": {
      "attributed": 1,
      "rewarded": 0,
      "expired": 0,
      "capped": 0
    },
    "items": []
  }
}

cURL example

curl "https://api.crawlora.net/api/v1/referrals/me" \
  -H "Authorization: Token <token>"

View endpoint docs Browse all endpoints Pricing List referral attributions Get referral attribution detail Approve a referral held for review Reject a referral held for review Recover pending referral credit grants