---
title: "Get the referral leaderboard"
method: GET
path: "/admin/referrals"
tags: ["referrals"]
---

# Get the referral leaderboard

`GET /admin/referrals`

## Request

- Base URL: `https://api.instruxi.dev/api/v1/enforcer`
- URL: `https://api.instruxi.dev/api/v1/enforcer/admin/referrals`
- Auth: one of:
  - API key in header `Authorization`
  - API key in header `X-API-Key`

## Query parameters

- `tenant_id` string
- `q` string
- `group_id` string, uuid
- `exclude_group_id` string, uuid
- `sort` 'referred_desc' | 'referred_asc' | 'kyc_verified_desc' | 'name_asc'
- `limit` integer
- `offset` integer

## Response `200`

OK

- InternalDeliveryHttpHandlerReferralLeaderboardResponse
  - `data` EnforcerV3InternalDomainReferralLeaderRow[]
    - `account_id` string
    - `active` integer
    - `email` string
    - `kyc_verified` integer
    - `referred` integer
    - `username` string
  - `limit` integer
  - `offset` integer
  - `success` boolean
  - `total` integer

## Other responses

- `400`: Bad Request
- `403`: Forbidden
- `404`: group_not_found

---

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