---
title: "Get Reffered Users"
method: GET
path: "/v1/referral/reffered_users"
tags: ["referral"]
---

# Get Reffered Users

`GET /v1/referral/reffered_users`

## Request

- Base URL: `https://api.linktodm.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.linktodm.com/v1/referral/reffered_users`
- Auth: HTTP bearer

## Query parameters

- `limit` integer
- `offset` integer

## Response `200`

Successful Response

- ReferredUserPagiantionSchema
  - `total` integer, required
  - `docs` unknown[], required
    - unknown
  - `limit` integer, nullable
  - `offset` integer, nullable
  - `active_subscription_total` integer
  - `total_earnings_with_currency` string, nullable
  - `total_earnings` union
    - integer
    - number
  - `already_paid_with_currency` string, nullable
  - `already_paid` union
    - integer
    - number

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/linktodm/apis/salesmorph.md) - [All operations](https://skmtc.dev/linktodm/apis/salesmorph/llms.txt) - [OpenAPI document](https://skmtc.dev/linktodm/apis/salesmorph/revisions/4af0ad5dbe92?raw)