Skip to main content
GET
List Product Affiliates

Authorizations

Authorization
string
header
required

An Account API key, an App API key, an account access token, an account-scoped user token, or a user OAuth token. Prepend the key or token with Bearer, for example Bearer ***************************. See Auth & API keys for how to get each one.

Headers

Api-Version-Date
string

Pins the request to a dated API version.

Example:

"2026-09-29"

Query Parameters

account_id
string
required

Account whose product affiliates are listed (biz_ tag).

query
string

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

status
enum<string>

Only product affiliates with this status.

Available options:
active,
archived
product_ids
string[]

Only product affiliates of these products.

created_after
string<date-time>

Only signups at or after this ISO 8601 timestamp.

created_before
string<date-time>

Only signups before this ISO 8601 timestamp.

first
integer
default:20

Number of results to return from the start of the range.

Required range: x <= 100
after
string

Return results after this cursor. Use page_info.end_cursor from the previous response to fetch the next page.

last
integer

Number of results to return from the end of the range.

Required range: x <= 100
before
string

Return results before this cursor. Use page_info.start_cursor from the previous response to fetch the previous page.

Response

product affiliates listed

data
object[]
required
page_info
object
required
total_count
integer | null
required

Matching product affiliates, or null past 10,000.

Example:

2