Sign in
Partners

List the users the caller referred

Lists the users the caller referred onto Whop (newest first), each with the second-tier earnings the caller has made from that user's businesses.

get/partners/referred_users

Query parameters

querystring

Search referred users by name or username.

has_businessesboolean

When true, only referred users who brought at least one business onto Whop.

has_earning_businessesboolean

When true, only referred users with at least one business that has generated earnings.

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.

Response

referred users listed

Example response

{
  "data": [
    {
      "business_count": 1,
      "earnings": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "joined_at": "2026-01-01T12:00:00.000Z",
      "total_earnings_usd": "10.00",
      "total_volume_usd": "100.00",
      "user": {
        "city": "Austin",
        "country": "US",
        "email": "marcus@shinetime.example",
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Tanya Cole",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "tanyacole"
      },
      "volume_30d": {
        "amount": "-2.50",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  }
}

Changes

Changed in 63 of the 74 revisions of this API.133

  • 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

  • c1dceb26e5057See 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 new optional query request parameter query

      new-optional-request-parameter

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

    • ○

      added the required property // to the response with the status

      response-required-property-added

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