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 |
|
|
Optional
Parameter | Description |
| Show referrals for the specified affiliate. |
| Show referrals that are currently in the specified conversion state(s). Pass |
| Show referrals with the specified email address. |
| Show referrals with the specified Stripe customer ID. |
| Pagination cursor specifying which page to fetch. |
| How many results to return per page. Default is 25, maximum is 100. |
| Which object(s) to expand in response data. See below for available objects. |
Expandable objects
Parameter | Description |
| Includes the full affiliate object as a nested object for each referral in the list. |
Examples
List all referrals
List all referrals and include nested affiliate object
List referrals for a specific affiliate
List referrals with a "lead" conversion state
List referrals with a "lead" or "conversion" conversion state
Pagination: request page 3 with 50 results per page
Last updated