List Referred Businesses

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.partners.businesses.list();

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/partners/businesses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/partners/businesses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/partners/businesses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/partners/businesses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "route": "biz_xxxxxxxxxxxxxx",
        "title": "Gleam Mobile Detailing"
      },
      "blueprint_partner": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Nina Alvarez",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "ninaalvarez"
      },
      "created_at": "2026-01-01T12:00:00.000Z",
      "deal_closed_reason": null,
      "earnings_usd": {
        "completed": "3.00",
        "pending": "1.00",
        "total": "4.00"
      },
      "first_tier_partner": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Nina Alvarez",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "ninaalvarez"
      },
      "id": "coma_xxxxxxxxxxxxxx",
      "my_partner_tier": "first",
      "object": "partner_business",
      "owner": {
        "email": "marcus@shinetime.example",
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Nina Alvarez",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "ninaalvarez"
      },
      "payout_percentages": {
        "ad_spend": 0.015,
        "card_interchange": 0.2,
        "sales": 0.3,
        "transfer": 0.25,
        "withdrawal": 0.3
      },
      "referral_expires_at": "2026-01-01T12:00:00.000Z",
      "referral_started_at": "2026-01-01T12:00:00.000Z",
      "second_tier_partner": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Nina Alvarez",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "ninaalvarez"
      },
      "status": "active",
      "volume_usd": {
        "attributed": "40.00",
        "awaiting_settlement": "0.00",
        "last_30d": "0.00",
        "settled": "40.00"
      },
      "commission_advance": {
        "activity_30_day": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "activity_60_day": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "amount": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "annual_processing": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "clawed_back_at": null,
        "deadline_at": "2026-01-01T12:00:00.000Z",
        "estimated_amount": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "funded_at": null,
        "offer_token": null,
        "processing_target": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "projected_60_day_activity": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "projected_commissions": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "projected_processing_commissions": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "qualified_at": "2026-01-01T12:00:00.000Z",
        "recovery_threshold": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "status": "accepted",
        "terms_version": "2026-01-01"
      },
      "commission_advance_projections_allowed": false,
      "referring_business": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "route": "biz_xxxxxxxxxxxxxx",
        "title": "Gleam Mobile Detailing"
      }
    }
  ],
  "page_info": {
    "end_cursor": null,
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

GET

partners

businesses

TypeScript

import { WhopClient } from "@whop/sdk";

const client = new WhopClient({ token: "YOUR_TOKEN", apiVersionDate: "2026-08-21-1", idempotencyKey: "YOUR_IDEMPOTENCY_KEY" });
await client.partners.businesses.list();

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://api.whop.com/api/v1/partners/businesses', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.whop.com/api/v1/partners/businesses",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.whop.com/api/v1/partners/businesses"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.whop.com/api/v1/partners/businesses")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "data": [
    {
      "account": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "route": "biz_xxxxxxxxxxxxxx",
        "title": "Gleam Mobile Detailing"
      },
      "blueprint_partner": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Nina Alvarez",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "ninaalvarez"
      },
      "created_at": "2026-01-01T12:00:00.000Z",
      "deal_closed_reason": null,
      "earnings_usd": {
        "completed": "3.00",
        "pending": "1.00",
        "total": "4.00"
      },
      "first_tier_partner": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Nina Alvarez",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "ninaalvarez"
      },
      "id": "coma_xxxxxxxxxxxxxx",
      "my_partner_tier": "first",
      "object": "partner_business",
      "owner": {
        "email": "marcus@shinetime.example",
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Nina Alvarez",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "ninaalvarez"
      },
      "payout_percentages": {
        "ad_spend": 0.015,
        "card_interchange": 0.2,
        "sales": 0.3,
        "transfer": 0.25,
        "withdrawal": 0.3
      },
      "referral_expires_at": "2026-01-01T12:00:00.000Z",
      "referral_started_at": "2026-01-01T12:00:00.000Z",
      "second_tier_partner": {
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Nina Alvarez",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "ninaalvarez"
      },
      "status": "active",
      "volume_usd": {
        "attributed": "40.00",
        "awaiting_settlement": "0.00",
        "last_30d": "0.00",
        "settled": "40.00"
      },
      "commission_advance": {
        "activity_30_day": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "activity_60_day": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "amount": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "annual_processing": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "clawed_back_at": null,
        "deadline_at": "2026-01-01T12:00:00.000Z",
        "estimated_amount": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "funded_at": null,
        "offer_token": null,
        "processing_target": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "projected_60_day_activity": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "projected_commissions": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "projected_processing_commissions": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "qualified_at": "2026-01-01T12:00:00.000Z",
        "recovery_threshold": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "status": "accepted",
        "terms_version": "2026-01-01"
      },
      "commission_advance_projections_allowed": false,
      "referring_business": {
        "id": "biz_xxxxxxxxxxxxxx",
        "logo_url": "https://whop-assets-example.s3.amazonaws.com/uploads/image/2026-01-01/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
        "route": "biz_xxxxxxxxxxxxxx",
        "title": "Gleam Mobile Detailing"
      }
    }
  ],
  "page_info": {
    "end_cursor": null,
    "has_next_page": false,
    "has_previous_page": false,
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

{
  "error": {
    "message": "account_id is required",
    "type": "bad_request",
    "code": "<string>"
  }
}

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-10-29-8"

Query Parameters

referring_account_id

string

List the referrals this business's team members made, past members included, instead of the authenticated user's own. Requires company:basic:read on that business, which every team member holds, and cannot be combined with user_id. The owner role reads every referral; anyone else reads only the referrals made by themselves and by the people under them in the org chart.

advance_status

enum<string>

Filter the authenticated partner's CPA offers by status. Use offered for every state after qualification.

Available options:

projected,

available,

accepted,

funded,

clawed_back,

completed,

expired,

withdrawn,

offered

status

enum<string>

Filter by referral status.

Available options:

active,

removed

has_earnings

boolean

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

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.

order

enum<string>

default:created_at

The field to sort partner businesses by.

Available options:

created_at,

referral_started_at,

referral_expires_at,

payout_percentage,

volume_usd,

volume_30d_usd,

earnings_usd

direction

enum<string>

default:desc

Sort direction.

Available options:

asc,

desc

created_before

string

Only return partner businesses created before this timestamp.

created_after

string

Only return partner businesses created after this timestamp.

first_sale_before

string

Only return partner businesses whose first paid sale above zero happened before this timestamp.

first_sale_after

string

Only return partner businesses whose first paid sale above zero happened after this timestamp. Combined with first_sale_before, this is the net new set: businesses that processed their first $1 inside the window.

referred_user_id

string

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_username

string

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

tier

enum<string>

Filter to referrals from a single tier: first, second, or blueprint.

Available options:

first,

second,

blueprint

business_prefix_query

string

Case-insensitive business-name prefix, or an exact biz_ account ID. Surrounding whitespace is ignored; blank values apply no filter.

Response

partner businesses listed

data

object[]

required

Show child attributes

page_info

object

required

Show child attributes

Introduction

Reference

Core Resources

Payments

Money

Commerce

Websites

Ads

Analytics

Communication

Partners

Workforce

Media

Developer

List Referred Businesses

Authorizations

Headers

Query Parameters

Response