Sign in
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 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"
      },
      "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
      },
      "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

Changed in 65 of the 74 revisions of this API.12139

  • 78e1ed7366cd2See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 73dd0533cd812See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 86b97292852d2See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • c1dceb26e5052See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 7fcefabddb0a2See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 140d015b99662See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 35edb053220a2See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • ac2b9b1c6a002See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • a88353507eac2See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

  • 51933d70d7f52See the full diff
    • ○

      the security scope partner:basic:read was added to the endpoint's security scheme bearerAuth

      api-security-scope-added

    • ○

      the security scope referral:basic:read was removed from the endpoint's security scheme bearerAuth

      api-security-scope-removed

Of the 74 revisions, 1 has no diff computed.