LogoLogo
REST APIWebhooksHelp Center →
  • Introduction
  • JavaScript API
    • Overview
  • REST API
    • Overview
    • Campaigns
      • The campaign object
      • List campaigns
      • Create campaign
      • Retrieve campaign
      • Update campaign
    • Affiliates
      • The affiliate object
      • List affiliates
      • Create affiliate
      • Retrieve affiliate
      • Update affiliate
      • Magic Link (SSO)
    • Affiliate Links
      • The affiliate link object
      • List affiliate links
      • Create affiliate link
      • Retrieve affiliate link
      • Update affiliate link
    • Affiliate Coupons
      • The affiliate coupon object
      • List affiliate coupons
      • Create affiliate coupon
      • Retrieve affiliate coupon
    • Referrals
      • The referral object
      • List referrals
    • Commissions
      • The commission object
      • List commissions
      • Retrieve commission
      • Update commission
      • Delete commission
    • Payouts
      • The payout object
      • List payouts
      • Retrieve a payout
      • Mark a payout as paid
  • Webhooks
    • Overview
    • Endpoints
    • Requests
    • Event types
    • Signed webhooks
  • Links
    • Help Center
    • Sign up
    • Login
    • Learn more about Rewardful
Powered by GitBook
On this page
  • Request
  • Optional
  • Expandable objects
  • Examples

Was this helpful?

Export as PDF
  1. REST API
  2. Referrals

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

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

updated_until

Use alone or with updated_since to fetch referrals within a specified time range.

updated_since

Use alone or with updated_until to fetch referrals within a specified time range.

Expandable objects

Parameter

Description

affiliate

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:
PreviousThe referral objectNextCommissions

Last updated 5 months ago

Was this helpful?

Show referrals that are currently in the specified . Pass conversion_state[] to specify multiple conversion states.

cursor specifying which page to fetch.

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

Show only referrals updated before the requested timestamp formatted as .

Show only referrals updated after the requested timestamp formatted as .

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

conversion state(s)
Pagination
expand
ISO 8601
ISO 8601
affiliate object