Product Affiliates

List Product Affiliates

Changed on

Lists affiliate enrollments for an account's products, newest first, including affiliates who have not made a referral. Requires affiliate:basic:read on the account. Email addresses and email search also require member:email:read.

get/product_affiliates

Request

  • Base URL: https://api.whop.com/api/v1
  • URL: https://api.whop.com/api/v1/product_affiliates
  • Auth: HTTP bearer

Query parameters

account_idstring required

Account whose product affiliates are listed (biz_ tag).

querystring

Matches the start of the affiliate's username or of any word in their name, or their exact email (with member:email:read).

status'active' | 'archived'

Only product affiliates with this status.

product_idsstring[]

Only product affiliates of these products.

[
  "prod_xxxxxxxxxxxxxx"
]
created_afterstring date-time

Only signups at or after this ISO 8601 timestamp.

created_beforestring date-time

Only signups before this ISO 8601 timestamp.

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

product affiliates listed

total_countinteger nullable required

Matching product affiliates, or null past 10,000.

Example response

{
  "data": [
    {
      "created_at": "2026-01-01T12:00:00.000Z",
      "id": "apaf_xxxxxxxxxxxxxx",
      "product": {
        "id": "prod_xxxxxxxxxxxxxx",
        "title": "Ceramic Coating Package"
      },
      "referred_users_count": 3,
      "status": "active",
      "total_reward_amount_usd": {
        "amount": "-1234.56",
        "currency": "usd",
        "decimals": 2,
        "display_decimals": 2
      },
      "user": {
        "email": "marcus@shinetime.example",
        "id": "user_xxxxxxxxxxxxxx",
        "name": "Jack Sharkey the 2nd",
        "profile_picture": {
          "url": "https://ui-avatars.com/api/"
        },
        "username": "random-username-2-xxxxxxxx"
      }
    }
  ],
  "page_info": {
    "start_cursor": "WyJjdXJzb3IiLDFd"
  },
  "total_count": 2
}

Changes