List affiliates

Returns a list of your affiliates. The affiliates are returned sorted by creation date, with the most recent affiliates appearing first. The list can also be filtered using various criteria.

Request

Method

URL

GET

https://api.getrewardful.com/v1/affiliates

Optional parameters

Parameter

Description

campaign_id

A filter based on the affiliate's campaign.

email

A filter based on the affiliate's email address.*

stripe_customer_id

A filter based on the affiliate's Stripe customer ID.* (Applies to customer referrers)

page

Pagination cursor specifying which page to fetch.

limit

How many results to return per page. Default is 25, maximum is 100.

expand

Which object(s) to expand in response data. See below for available objects.

*Filtering by email or stripe_customer_id will return a list with one (or zero) items.

Expandable objects

Parameter

Description

campaign

Includes the campaign details as a nested object for each affiliate in the list.

links

Includes an array of the affiliate's links as a nested object for each affiliate in the list.

commission_stats

Include a nested object describing the affiliate's commission stats for each affiliate in the list.

Examples

List all affiliates

curl --request GET \
--url https://api.getrewardful.com/v1/affiliates \
-u YOUR_API_SECRET:

List all affiliates and expand campaign data

curl --request GET \
--url https://api.getrewardful.com/v1/affiliates?expand=campaign \
-u YOUR_API_SECRET:
curl --request GET \
--url https://api.getrewardful.com/v1/affiliates?expand[]=campaign&expand[]=links \
-u YOUR_API_SECRET:

Filter list of affiliates by campaign

curl --request GET \
--url https://api.getrewardful.com/v1/affiliates?campaign_id=c3482343-8680-40c5-af9a-9efa119713b5 \
-u YOUR_API_SECRET:

Filter list of affiliates by email address

curl --request GET \
--url https://api.getrewardful.com/v1/affiliates?email=[email protected] \
-u YOUR_API_SECRET: