List referrals
Returns a list of your referrals. The referrals are returned sorted by creation date, with the most recent referrals appearing first.
Method | URL |
GET | https://api.getrewardful.com/v1/referrals |
Parameter | Description |
affiliate_id | Show referrals for the specified affiliate. |
conversion_state | Show referrals that are currently in the specified conversion state(s). Pass conversion_state[] to specify multiple conversion states. |
email | Show referrals with the specified email address. |
stripe_customer_id | Show referrals with the specified Stripe customer ID. |
page | |
limit | How many results to return per page. Default is 25, maximum is 100. |
expand |
Parameter | Description |
affiliate |
curl --request GET \
--url https://api.getrewardful.com/v1/referrals \
-u YOUR_API_SECRET:
curl --request GET \
--url https://api.getrewardful.com/v1/referrals?expand[]=affiliate \
-u YOUR_API_SECRET:
curl --request GET \
--url https://api.getrewardful.com/v1/referrals?affiliate_id=b533bfca-7c70-4dec-9691-e136a8d9a26c \
-u YOUR_API_SECRET:
curl --request GET \
--url https://api.getrewardful.com/v1/referrals?conversion_state=lead \
-u YOUR_API_SECRET:
curl --request GET \
--url https://api.getrewardful.com/v1/referrals?conversion_state[]=lead&conversion_state[]=conversion \
-u YOUR_API_SECRET:
curl --request GET \
--url https://api.getrewardful.com/v1/referrals?page=3&limit=50
-u YOUR_API_SECRET:
Last modified 2yr ago