Get Referral(s)
Returns a list of referrals based on the affiliate program, filtered by optional referral ID, affiliate ID, affiliate email, or external ID
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
The ID of the referral to retrieve
The affiliate ID associated with the referral
The email of the affiliate associated with the referral
The external ID of the referred user
Response
The referral ID
The affiliate ID associated with the referral
Name of the referred user
Email of the referred user
The external ID of the referred user. This will be an ID you actively maintain that identifies the user on your server (for example, the User ID in your database, or Stripe Customer ID)
The plan associated with the referred user
Status of the referral (active/inactive)