Sign in

v8

OpenAPI 3.1.02026-08-033623795.0 MB
Partners

List referred businesses

Lists the businesses the authenticated user referred onto Whop, most recent first.

get/partners/businesses

Query parameters

status'active' | 'removed'

Filter by referral status.

has_earningsboolean

When true, only businesses with pending or completed earnings paid to the caller.

firstinteger

Number of partner businesses to return from the start of the window.

afterstring

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

lastinteger

Number of partner businesses to return from the end of the window.

beforestring

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

order'created_at' | 'referral_started_at' | 'referral_expires_at' | 'payout_percentage' | 'volume_usd' | 'earnings_usd'

The field to sort partner businesses by.

direction'asc' | 'desc'

Sort direction.

created_beforestring

Only return partner businesses created before this timestamp.

created_afterstring

Only return partner businesses created after this timestamp.

referred_user_idstring

Filter to referrals attributed to this user. For first-tier referrals, this is the referred account owner; for second-tier referrals, this is the partner you recruited.

referred_usernamestring

Filter by the referred user's exact username. Ignored when referred_user_id is present.

tier'first' | 'second'

Filter to only first-tier referrals or only second-tier referrals.

Response

partner businesses listed

Example response

{
  "data": [
    {
      "status": "active"
    }
  ]
}