# List all affiliates ``` GET https://api.freemius.com/v1/products/{product_id}/aff/{affiliate_program_id}/affiliates.json ``` #### Auth:Bearer TokenSCOPE: PRODUCT Product-scoped API tokens allow you to operate on the product itself. This token usually allows read-only access to the product configuration and write access to several operations on subscriptions, customers, payments, and more. For most SaaS or app integrations, this is the token you will need. 1. Go to the [Freemius Developer Dashboard](https://dashboard.freemius.com/). 2. Open the Settings page of the relevant product. 3. Click the API & Keys tab. 4. Copy the API Bearer Authorization Token from the UI. *** Retrieve the affiliates collection associated with the product affiliate program. ## Request[​](#request "Direct link to request") ### Path Parameters * **product\_id** integer\[](#param-property-affiliates-list-param-path-product-id "Direct link to product_id")required The ID of the product. **Possible values:** `>= 1` **Example: **`1234` **affiliate\_program\_id** integer\[](#param-property-affiliates-list-param-path-affiliate-program-id "Direct link to affiliate_program_id")required The ID of the affiliate program. **Possible values:** `>= 1` **Example: **`1234` ### Query Parameters * **count** integer[](#param-property-affiliates-list-param-query-count "Direct link to count") **Default value: **`25` The number of records to return. **Possible values:** `>= 1` and `<= 50` **Example: **`10` **offset** integer[](#param-property-affiliates-list-param-query-offset "Direct link to offset") **Default value: **`0` The number of records to skip before starting to return records. Default is 0. **Possible values:** `>= 0` **Example: **`10` **filter** string[](#param-property-affiliates-list-param-query-filter "Direct link to filter") Filter affiliates by status. **Possible values:** \[`all`, `active`, `pending`] **Example: **`all` **search** string[](#param-property-affiliates-list-param-query-search "Direct link to search") Search affiliates by user ID, affiliate ID, or partial name/email address. > **Caution**: An email address needs to be URL-encoded. **Example: **`12345` **sort** string[](#param-property-affiliates-list-param-query-sort "Direct link to sort") Sort affiliates by criteria. **Possible values:** \[`newest`, `highest_gross`] **Example: **`newest` ## Responses[​](#responses "Direct link to Responses") * 200 * 400 * 401 * 402 The collection of affiliates associated with the product affiliate program. All affiliates are listed under the `affiliates` key. application/json **Schema** **affiliates** object\[] * Array \[ **id**string\[](#schema-property-affiliates-list-response-schema-id-string-int64 "Direct link to id") The unique identifier of the entity. **Possible values:** `>= 1` **Example: **`123456` **created**string\[](#schema-property-affiliates-list-response-schema-created-string-date-time "Direct link to created") The date and time the entity was created, under UTC timezone. **Example: **`2025-01-01 00:00:00` **updated**string\[](#schema-property-affiliates-list-response-schema-updated-string-date-time "Direct link to updated")nullable The date and time the entity was updated, under UTC timezone. If `null` then the entity was never updated since its creation. **Example: **`2025-01-01 00:00:00` **user\_id**string\[](#schema-property-affiliates-list-response-schema-user-id-string-int64 "Direct link to user_id") The ID of the user the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **ip**string\[](#schema-property-affiliates-list-response-schema-ip-string-ipv4-ipv6 "Direct link to ip") The IP address associated with the entity. **Example: **`0.0.0.0` **paypal\_email**string[](#schema-property-affiliates-list-response-schema-paypal-email-string "Direct link to paypal_email") The PayPal email for payout purposes. **Example: **`foo@freemius.com` **plugin\_id**string\[](#schema-property-affiliates-list-response-schema-plugin-id-string-int64 "Direct link to plugin_id") The ID of the product the entity belongs to. **Possible values:** `>= 1` **Example: **`123456` **affiliate\_terms\_id**string\[](#schema-property-affiliates-list-response-schema-affiliate-terms-id-string-int64 "Direct link to affiliate_terms_id") The ID of the affiliate terms. **Possible values:** `>= 1` **Example: **`1234` **custom\_affiliate\_terms\_id**string\[](#schema-property-affiliates-list-response-schema-custom-affiliate-terms-id-string-int64 "Direct link to custom_affiliate_terms_id") The ID of the custom affiliate terms. **Possible values:** `>= 1` **Example: **`1234` **is\_using\_custom\_terms**boolean[](#schema-property-affiliates-list-response-schema-is-using-custom-terms-boolean "Direct link to is_using_custom_terms") Whether the affiliate is using custom terms. **rewards\_terms\_id**integer[](#schema-property-affiliates-list-response-schema-rewards-terms-id-integer "Direct link to rewards_terms_id")nullable The ID of the rewards terms. **Possible values:** `>= 0` **Example: **`1234` **status**string[](#schema-property-affiliates-list-response-schema-status-string "Direct link to status") **Default value: **`pending` The status of the affiliate signup. **Possible values:** \[`pending`, `active`, `blocked`, `rejected`, `suspended`] **domain**string[](#schema-property-affiliates-list-response-schema-domain-string "Direct link to domain") The domain of the affiliate. **Example: **`https://awesome-products.com` **earnings**number\[](#schema-property-affiliates-list-response-schema-earnings-number-float "Direct link to earnings") The earnings of the affiliate from sales. **Possible values:** `>= 0` **Example: **`2000.45` **pending\_referrals**number[](#schema-property-affiliates-list-response-schema-pending-referrals-number "Direct link to pending_referrals") The number of unapproved/pending referrals. **Possible values:** `>= 1` **Example: **`1234` **referrals**integer[](#schema-property-affiliates-list-response-schema-referrals-integer "Direct link to referrals") The number of approved referrals. **Possible values:** `>= 0` **Example: **`1234` **visits**integer[](#schema-property-affiliates-list-response-schema-visits-integer "Direct link to visits") The number of visits through the affiliate link. **Possible values:** `>= 0` **Example: **`1234` **unique\_visits**integer[](#schema-property-affiliates-list-response-schema-unique-visits-integer "Direct link to unique_visits") The number of unique visits through the affiliate link. **Possible values:** `>= 1` **Example: **`1234` **email**string[](#schema-property-affiliates-list-response-schema-email-string "Direct link to email") Associated user's email. **Example: **`jane@example.com` **first**string[](#schema-property-affiliates-list-response-schema-first-string "Direct link to first") Associated user's first name. **Example: **`Jane` **last**string[](#schema-property-affiliates-list-response-schema-last-string "Direct link to last") Associated user's last name. **Example: **`Doe` **picture**string[](#schema-property-affiliates-list-response-schema-picture-string "Direct link to picture") Associated user's profile picture. **Example: **`https://example.com/profile-picture.jpg` * ] Bad request. The request could not be understood by the server due to malformed syntax or arguments. application/json **Schema** **path**string[](#schema-property-affiliates-list-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-affiliates-list-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-affiliates-list-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-affiliates-list-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-affiliates-list-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-affiliates-list-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-affiliates-list-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` Unauthorized access error. The request requires [authentication](https://freemius.com/help/api/#bearer-token-authentication) but was not provided or the provided authentication does not satisfy the required permissions. application/json **Schema** **path**string[](#schema-property-affiliates-list-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-affiliates-list-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-affiliates-list-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-affiliates-list-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-affiliates-list-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-affiliates-list-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-affiliates-list-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}` The request is missing the specified argument. application/json **Schema** **path**string[](#schema-property-affiliates-list-response-schema-path-string "Direct link to path") The API request path. **Example: **`:/products/product_id/users.json` **error** object This object contains the error details. **type**string[](#schema-property-affiliates-list-response-schema-type-string "Direct link to type") The type of the error encountered by the server. **Example: **`UnauthorizedAccess` **message**string[](#schema-property-affiliates-list-response-schema-message-string "Direct link to message") The descriptive error message. **Example: **`Some error has occured.` **code**string[](#schema-property-affiliates-list-response-schema-code-string "Direct link to code") The error code. **Example: **`unauthorized_access` **http**integer[](#schema-property-affiliates-list-response-schema-http-integer "Direct link to http") The HTTP status code returned by the server. **Example: **`401` **timestamp**string[](#schema-property-affiliates-list-response-schema-timestamp-string "Direct link to timestamp") Current timestamp. **Example: **`Thu, 11 May 2023 11:45:30 +0000` **request** object This object sends back the request payload as received by the server (both from path and from body or query). **property name\***any[](#schema-property-affiliates-list-response-schema-property-name-any "Direct link to property name*") This object sends back the request payload as received by the server (both from path and from body or query). **Example: **`{"beautify":true,"format":"json"}`