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

Path Parameters

product_id integer<int64>required
The ID of the product.
Possible values: >= 1
Example: 1234
affiliate_program_id integer<int64>required
The ID of the affiliate program.
Possible values: >= 1
Example: 1234

Query Parameters

count integer
Default value: 25
The number of records to return.
Possible values: >= 1 and <= 50
Example: 10
offset integer
Default value: 0
The number of records to skip before starting to return records. Default is 0.
Possible values: >= 0
Example: 10
filter string
Filter affiliates by status.
Possible values: [all, active, pending]
Example: all
search string
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
Sort affiliates by criteria.
Possible values: [newest, highest_gross]
Example: newest

Responses

200

The collection of affiliates associated with the product affiliate program. All affiliates are listed under the affiliates key.

application/json

Schema

affiliates object[]

Array [

idstring<int64>

The unique identifier of the entity.

Possible values: >= 1

Example: 123456

createdstring<date-time>

The date and time the entity was created, under UTC timezone.

Example: 2025-01-01 00:00:00

updatedstring<date-time>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_idstring<int64>

The ID of the user the entity belongs to.

Possible values: >= 1

Example: 123456

ipstring<ipv4|ipv6>

The IP address associated with the entity.

Example: 0.0.0.0

paypal_emailstring

The PayPal email for payout purposes.

Example: [email protected]

plugin_idstring<int64>

The ID of the product the entity belongs to.

Possible values: >= 1

Example: 123456

affiliate_terms_idstring<int64>

The ID of the affiliate terms.

Possible values: >= 1

Example: 1234

custom_affiliate_terms_idstring<int64>

The ID of the custom affiliate terms.

Possible values: >= 1

Example: 1234

is_using_custom_termsboolean

Whether the affiliate is using custom terms.

rewards_terms_idintegernullable

The ID of the rewards terms.

Possible values: >= 0

Example: 1234

statusstring

Default value: pending

The status of the affiliate signup.

Possible values: [pending, active, blocked, rejected, suspended]

domainstring

The domain of the affiliate.

Example: https://awesome-products.com

earningsnumber<float>

The earnings of the affiliate from sales.

Possible values: >= 0

Example: 2000.45

pending_referralsnumber

The number of unapproved/pending referrals.

Possible values: >= 1

Example: 1234

referralsinteger

The number of approved referrals.

Possible values: >= 0

Example: 1234

visitsinteger

The number of visits through the affiliate link.

Possible values: >= 0

Example: 1234

unique_visitsinteger

The number of unique visits through the affiliate link.

Possible values: >= 1

Example: 1234

emailstring

Associated user's email.

Example: [email protected]

firststring

Associated user's first name.

Example: Jane

laststring

Associated user's last name.

Example: Doe

picturestring

Associated user's profile picture.

Example: https://example.com/profile-picture.jpg

]

400

Bad request. The request could not be understood by the server due to malformed syntax or arguments.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

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

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"}

401

Unauthorized access error. The request requires authentication but was not provided or the provided authentication does not satisfy the required permissions.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

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

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"}

402

The request is missing the specified argument.

application/json

Schema

pathstring

The API request path.

Example: :/products/product_id/users.json

error object

This object contains the error details.

typestring

The type of the error encountered by the server.

Example: UnauthorizedAccess

messagestring

The descriptive error message.

Example: Some error has occured.

codestring

The error code.

Example: unauthorized_access

httpinteger

The HTTP status code returned by the server.

Example: 401

timestampstring

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

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"}