---
title: "Get current user's referral program summary"
method: GET
path: "/referrals/me"
tags: ["Referrals"]
---

# Get current user's referral program summary

`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`

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.

## Headers

- `Authorization` string, required

## Response `200`

Referral summary

- ReferralsReferralsMeResponseDoc
  - `attribution_window_days` integer
  - `code` string
  - `items` ReferralsReferralAttributionDoc[]
    - `campaign` string
    - `code` string
    - `created_at` string
    - `expires_at` string
    - `id` string
    - `qualified_at` string
    - `reward_credits` integer
    - `rewarded_at` string
    - `role` 'referrer' | 'referred'
    - `status` 'attributed' | 'qualified' | 'review_required' | 'rewarded' | 'expired' | 'capped' | 'failed' | 'rejected'
  - `monthly_referrer_reward_cap` integer
  - `referred_reward_credits` integer
  - `reward_credits` integer
  - `share_path` string
  - `stats` ReferralsReferralsStatsDoc
    - `attributed` integer
    - `capped` integer
    - `expired` integer
    - `qualified` integer
    - `rejected` integer
    - `review_required` integer
    - `rewarded` integer

## Other responses

- `401`: Authentication required
- `500`: Internal server error

---

[API](https://skmtc.dev/crawlora/apis/crawlora-api.md) · [All operations](https://skmtc.dev/crawlora/apis/crawlora-api/llms.txt) · [OpenAPI document](https://skmtc.dev/crawlora/apis/crawlora-api/revisions/0497899e2016?raw)