v1
latestOpenAPI 3.0.12026-08-062532117.6 KBGet 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.
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.