Partners

List the users the caller referred

Changed on

Lists the users the caller referred onto Whop, newest first by default, each with the caller's total affiliate earnings from that user across all tiers.

get/partners/referred_users

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/partners/referred_users
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Query parameters

earning_partner_idstring

The selected referring partner's user_ ID. Requires user_id=global; cannot be combined with earning_partner_username.

earning_partner_usernamestring

The selected referring partner's exact username. Requires user_id=global; cannot be combined with earning_partner_id.

referring_account_idstring

List the users this business's team members referred, past members included, instead of the caller's own. Requires company:basic:read on that business, which every team member holds, and cannot be combined with user_id. earning_partner_id or earning_partner_username then narrows to one team member.

querystring

Search referred users by name or username. In global mode, matches the beginning of usernames only.

has_businessesboolean

When true, only referred users who brought at least one business onto Whop.

has_earning_businessesboolean

When true, only referred users with at least one business that has generated earnings.

order'created_at' | 'earnings_usd'

The field to sort by. created_at uses the user's signup date; earnings_usd uses the current primary referrer's cached total affiliate earnings from that user.

direction'asc' | 'desc'

The direction to sort results.

firstinteger

Number of results to return from the start of the range.

afterstring

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

lastinteger

Number of results to return from the end of the range.

beforestring

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

referred users listed

Example response

{
  "data": [
    {
      "business_count": 1,
      "earnings": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "joined_at": "2026-01-01T12:00:00.000Z",
      "total_earnings_usd": "10.00",
      "total_volume_usd": "100.00",
      "user": {
        "city": "Austin",
        "country": "US",
        "email": "marcus@shinetime.example",
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Tanya Cole",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "tanyacole"
      },
      "volume_30d": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

  • 507636677fe9Revision changes
    • info

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

  • c3b5561c6176Revision changes
    • info

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

    • info

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth