Get Referral(s)
Returns referrals for your program. Supply id to fetch one referral, affiliateId / affiliateEmail to list everything a given affiliate referred, or externalId to look a referral up by the ID it has in your own system. With no parameters, every referral in the program is returned.
A referral that does not exist comes back as null with a 200, not a 404.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The referral's UUID. If no referral has that ID, the value is retried as a referral email address. Returns a single referral.
Return every referral belonging to this affiliate UUID.
Return every referral belonging to the affiliate with this email address.
Return every referral whose referredUserExternalId matches — the ID you gave the referred user in your own database.
Response
A single referral when filtering by id (null if no match), otherwise an array.
- object
- object[]
The referral ID
The affiliate credited with this referral
The affiliate program this referral belongs to
The affiliate link the referral came through
The commission plan applied to this referral
Name of the referred user
Email of the referred user
The ID you maintain for this user in your own system — for example your database user ID or a Stripe customer ID.
Plan the referred user is on. Defaults to N/A when not supplied.
Status of the referral. Referrals created through this API are always ACTIVE.
ACTIVE, SUBMITTED, DECLINED Whether the referral was submitted by hand or captured automatically
MANUAL, AUTOMATIC How the referral was tracked
COUPON, LINK Where the referral came from. Referrals created through this API have API.
UNKNOWN, API, INTEGRATION, MANUAL, IMPORTED, AFFILIATE_SUBMITTED Total revenue attributed to this referral
Total commission generated by this referral
The first page the referred user landed on
Free-text notes on the referral
Arbitrary JSON you can attach to the referral
When the referral was created