---
title: "List the users the caller referred"
method: GET
path: "/partners/referred_users"
tags: ["Partners"]
---

# List the users the caller referred

`GET /partners/referred_users`

Lists the users the caller referred onto Whop (newest first), each with the second-tier earnings the caller has made from that user's businesses.

## Query parameters

- `query` string
- `has_businesses` boolean
- `has_earning_businesses` boolean
- `first` integer
- `after` string
- `last` integer
- `before` string

## Response `200`

referred users listed

- object
  - `data` object[], required
    - `business_count` integer, required — Number of active businesses this user referred that credit the caller as a second-tier partner. Excludes deleted businesses.
    - `earnings` Money, required
      - `amount` string, required — The amount in major units, as an exact decimal string — `"10.00"` is ten dollars. A string so no float rounds it in transit.
      - `currency` string, required — Three-letter ISO 4217 currency code, lowercase.
      - `decimals` integer, required — How many decimal places the amount CARRIES — the precision the charge itself runs at.
      - `display_decimals` integer, required — How many decimal places to SHOW. Usually equal to `decimals`, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is `2` and `0`. Format the number in your own locale using this.
    - `joined_at` string, date-time, required — When the referred user joined Whop, as an ISO 8601 timestamp.
    - `total_earnings_usd` string, required
    - `total_volume_usd` string, required
    - `user` object, required
      - `city` string, nullable
      - `country` string, nullable
      - `email` string, nullable, required — The referred user's email address, so a partner can follow up with someone they brought onto Whop. Requires the `partner:email:read` scope; `null` without it, or while the account has no reachable address of its own.
      - `id` string, required
      - `name` string, nullable
      - `profile_picture` object
        - `url` string, nullable
      - `username` string, required
    - `volume_30d` Money, required
      - `amount` string, required — The amount in major units, as an exact decimal string — `"10.00"` is ten dollars. A string so no float rounds it in transit.
      - `currency` string, required — Three-letter ISO 4217 currency code, lowercase.
      - `decimals` integer, required — How many decimal places the amount CARRIES — the precision the charge itself runs at.
      - `display_decimals` integer, required — How many decimal places to SHOW. Usually equal to `decimals`, and deliberately not always: COP is charged in centavos but written in whole pesos, so it is `2` and `0`. Format the number in your own locale using this.
  - `page_info` object, required
    - `end_cursor` string, nullable, required
    - `has_next_page` boolean, required
    - `has_previous_page` boolean, required
    - `start_cursor` string, nullable, required

## Other responses

- `401` — Unauthorized

## Changes

> 71 revisions in range; 1 not diffed.

- **2026-09-25** `c1dceb26e505` — 7 info
  - the security scope `partner:basic:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `referral:basic:read` was removed from the endpoint's security scheme `bearerAuth`
  - added the new optional `query` request parameter `query`
  - added the required property `data/items/business_count` to the response with the `200` status
  - …3 more
- **2026-09-24** `7fcefabddb0a` — 2 info
  - the security scope `partner:basic:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `referral:basic:read` was removed from the endpoint's security scheme `bearerAuth`
- **2026-09-23** `140d015b9966` — 2 info
  - the security scope `partner:basic:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `referral:basic:read` was removed from the endpoint's security scheme `bearerAuth`
- **2026-09-22** `35edb053220a` — 2 info
  - the security scope `partner:basic:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `referral:basic:read` was removed from the endpoint's security scheme `bearerAuth`
- **2026-09-21** `ac2b9b1c6a00` — 2 info
  - the security scope `partner:basic:read` was added to the endpoint's security scheme `bearerAuth`
  - the security scope `referral:basic:read` was removed from the endpoint's security scheme `bearerAuth`

[Full history](https://skmtc.dev/whop/apis/whop-api/changes/partners/referred_users/get.md)

---

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