Skip to main content
GET
JavaScript

Authorizations

Authorization
string
header
required

An Account API key, account-scoped JWT, App API key, or user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-07-31"

Query Parameters

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.

first
integer
default:20

Number of referred users to return from the start of the window.

Required range: x <= 100
after
string

Cursor to fetch the page after (from page_info.end_cursor).

last
integer

Number of referred users to return from the end of the window.

Required range: x <= 100
before
string

Cursor to fetch the page before (from page_info.start_cursor).

Response

referred users listed

data
object[]
required
page_info
object
required