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

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

Changes