List referrals

Returns a list of your referrals. The referrals are returned sorted by creation date, with the most recent referrals appearing first.

Request

Method	URL
GET	https://api.getrewardful.com/v1/referrals

Optional

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	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.
updated_until	Show only referrals updated before the requested timestamp formatted as ISO 8601. Use alone or with updated_since to fetch referrals within a specified time range.
updated_since	Show only referrals updated after the requested timestamp formatted as ISO 8601. Use alone or with updated_until to fetch referrals within a specified time range.

Expandable objects

Parameter	Description
affiliate	Includes the full affiliate object as a nested object for each referral in the list.

Examples

List all referrals

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

List all referrals and include nested affiliate object

curl --request GET \
  --url https://api.getrewardful.com/v1/referrals?expand[]=affiliate \
  -u YOUR_API_SECRET:

List referrals for a specific affiliate

curl --request GET \
  --url https://api.getrewardful.com/v1/referrals?affiliate_id=b533bfca-7c70-4dec-9691-e136a8d9a26c \
  -u YOUR_API_SECRET:

List referrals with a "lead" conversion state

curl --request GET \
  --url https://api.getrewardful.com/v1/referrals?conversion_state=lead \
  -u YOUR_API_SECRET:

List referrals with a "lead" or "conversion" conversion state

curl --request GET \
  --url https://api.getrewardful.com/v1/referrals?conversion_state[]=lead&conversion_state[]=conversion \
  -u YOUR_API_SECRET:

List referrals updated before a specific timestamp

curl --request GET \
  --url https://api.getrewardful.com/v1/referrals?updated_until=2024-12-04T13:02:57+02:00 \
  -u YOUR_API_SECRET:

List referrals updated after a specific timestamp

curl --request GET \
  --url https://api.getrewardful.com/v1/referrals?updated_since=2024-12-04T13:02:57+02:00 \
  -u YOUR_API_SECRET:

Pagination: request page 3 with 50 results per page

curl --request GET \
  --url https://api.getrewardful.com/v1/referrals?page=3&limit=50
  -u YOUR_API_SECRET: