Skip to main content
GET
List the users the caller referred

Authorizations

Authorization
string
header
required

A user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-29"

Query Parameters

user_id
enum<string>

Set to global to view referred users across partners with each primary referrer's cached total earnings. Requires an admin or partner manager session; OAuth tokens and company API keys cannot use global mode. Optionally narrow to one earning_partner_id or earning_partner_username.

Available options:
global
earning_partner_id
string

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

earning_partner_username
string

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

query
string

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

has_businesses
boolean

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

has_earning_businesses
boolean

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

order
enum<string>
default:created_at

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.

Available options:
created_at,
earnings_usd
direction
enum<string>
default:desc

The direction to sort results.

Available options:
asc,
desc
first
integer
default:20

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

Required range: x <= 100
after
string

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

last
integer

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

Required range: x <= 100
before
string

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

Response

referred users listed

data
object[]
required
page_info
object
required