---
title: "List referral attributions"
method: GET
path: "/admin/referrals"
tags: ["Referrals"]
---

# List referral attributions

`GET /admin/referrals`

## Request

- Base URL: `https://api.crawlora.net/api/v1`
- URL: `https://api.crawlora.net/api/v1/admin/referrals`
- Auth: API key in header `x-api-key`

Lists referral attributions with their reward records and `referrer` and `referred` user summaries. Filter by `user_id` (either side), `status`, `campaign` or `pending_grant`. `limit` defaults to 50 and is capped at 100. Pending or failed reward grants show in each item's `rewards`. Read-only.

## Query parameters

- `user_id` string
- `status` 'attributed' | 'qualified' | 'review_required' | 'rewarded' | 'expired' | 'capped' | 'failed' | 'rejected'
- `campaign` string
- `pending_grant` boolean
- `limit` integer

## Headers

- `x-api-key` string, required

## Response `200`

Referral attributions

- ReferralsAdminReferralsListResponseDoc
  - `items` ReferralsAdminReferralAttributionDoc[]
    - `attribution` ReferralsAdminReferralAttributionRecordDoc
      - `click_id` string
      - `code` string
      - `created_at` string
      - `error` string
      - `expires_at` string
      - `first_paid_invoice_id` string
      - `id` string
      - `landing_path` string
      - `qualified_at` string
      - `referred_user_id` string
      - `referrer_user_id` string
      - `review_reason` string
      - `reviewed_at` string
      - `reviewed_by` string
      - `rewarded_at` string
      - `risk_flags` string[]
      - `skip_reason` string
      - `status` 'attributed' | 'qualified' | 'review_required' | 'rewarded' | 'expired' | 'capped' | 'failed' | 'rejected'
      - `stripe_event_id` string
      - `stripe_invoice_id` string
      - `utm_campaign` string
      - `utm_medium` string
      - `utm_source` string
    - `referred` ReferralsAdminReferralUserDoc
      - `country` string
      - `email` string
      - `email_verified` boolean
      - `id` string
      - `region` string
      - `successful_requests` integer
      - `username` string
    - `referrer` ReferralsAdminReferralUserDoc
      - `country` string
      - `email` string
      - `email_verified` boolean
      - `id` string
      - `region` string
      - `successful_requests` integer
      - `username` string
    - `rewards` ReferralsAdminReferralRewardDoc[]
      - `attribution_id` string
      - `created_at` string
      - `credits` integer
      - `credits_grant_error` string
      - `credits_grant_key` string
      - `credits_granted_at` string
      - `id` string
      - `role` 'referrer' | 'referred'
      - `stripe_invoice_id` string
      - `user_id` string

## Other responses

- `401`: Authentication required
- `403`: Admin plan 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)