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 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' | 'blueprint'

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

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",
        "settled": "40.00"
      }
    }
  ],
  "page_info": {
    "end_cursor": "WyJjdXJzb3IiLDFd",
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 35 of the 43 revisions of this API.1276

  • 4ddae15b5de82See 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

  • 9e320991dd2f2See 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

  • 1b5d50d094792See 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

  • 4da7133b2de72See 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

  • 85786e675f3b4See 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

    • ○

      added the required property data/items/blueprint_partner to the response with the 200 status

      response-required-property-added

    • ○

      added the required property data/items/owner/email to the response with the 200 status

      response-required-property-added

  • 16c82685be3513See the full diff
    • ●

      added the new blueprint enum value to the data/items/my_partner_tier response property for the response status 200

      response-property-enum-value-added

    • ○

      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

    • ○

      added the new enum value blueprint to the query request parameter tier

      request-parameter-enum-value-added

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

  • 86d0a97abfe52See 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 42 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 621705ee8f4a2See 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 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

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

  • 42ce5c13e53b2See 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

Of the 43 revisions, 1 has no diff computed.