Partners

List referred businesses

Changed on

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

get/partners/businesses

Request

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

Query parameters

referring_account_idstring

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.

advance_status'projected' | 'available' | 'accepted' | 'funded' | 'clawed_back' | 'completed' | 'expired' | 'withdrawn' | 'offered'

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

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 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.

order'created_at' | 'referral_started_at' | 'referral_expires_at' | 'payout_percentage' | 'volume_usd' | 'volume_30d_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' | 'blueprint'

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

business_prefix_querystring

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

Response

partner businesses listed

Example response

{
  "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"
      },
      "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
        },
        "deadline_at": "2026-01-01T12:00:00.000Z",
        "estimated_amount": {
          "amount": "-1234.56",
          "currency": "usd",
          "decimals": 2,
          "display_decimals": 2
        },
        "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"
      },
      "created_at": "2026-01-01T12:00:00.000Z",
      "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"
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

  • 2595dc1a6c8bRevision 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

  • ac4774bfce4aRevision 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