---
title: 'Get referrals'
description: 'This endpoint allows you to get referrals'
openapi: GET /api/referral/users
---

> **For AI agents:** the complete documentation index is at [llms.txt](https://docs.snagsolutions.io/llms.txt). Append `.md` to any page URL for its markdown version.

`GET /api/referral/users` — query parameters: `organizationId`, `websiteId`, `walletAddress`, `limit`, `startingAfter`, `loyaltyRuleId`

`GET https://admin.snagsolutions.io/api/referral/users`

This endpoint allows you to get referrals

## Authentication

- `apiKeyAuth` — apiKey in header: `X-API-KEY`

## Query parameters

- `organizationId` (string)
- `websiteId` (string)
- `walletAddress` (string)
- `limit` (integer)
- `startingAfter` (string)
- `loyaltyRuleId` (string)

## Response 200

200
  - response (object)
    - `data` (array, required)
      - `items` (object)
        - `referralCode` (object, required)
          - `id` (string, required)
          - `referralCode` (string, required)
          - `loyaltyRuleId` (string, uuid)
          - `createdAt` (string, date-time, required)
          - `updatedAt` (string, date-time, required)
          - `deletedAt` (string, date-time, required)
          - `userId` (string, required)
        - `user` (object, required)
          - `id` (string, required)
          - `walletAddress` (string, required)
        - `eligible` (boolean)
        - `id` (string, required)
        - `tier1Amount` (number, required) — This will only return data for earnings after 2025-04-24
        - `tier2Amount` (number, required) — This will only return data for earnings after 2025-04-24
        - `amount` (number, required) — This will only return data for earnings after 2025-04-24
    - `hasNextPage` (boolean, required)

## Response 403

403
  - response (object) — Schema for forbidden response
    - `message` (string, required) — Error message


---

📦 **OpenAPI specs:** Every OpenAPI specification referenced by this documentation is available as a single download — https://docs.snagsolutions.io/api-specs.zip