Get Affiliate(s)
Returns a single affiliate when id or email is supplied, or every affiliate in the program when neither is. Looking up an affiliate that does not exist returns null with a 200, not a 404.
Each affiliate includes an affiliateLinks array holding every referral link slug they own — this is the source of truth for links. The legacy link field is deprecated and is usually null; use the affiliate link endpoints to manage links.
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Identifies one affiliate. Accepts the affiliate's UUID, one of their affiliate link slugs, or a numeric click ID (the click's affiliate is returned).
The email address of the affiliate to retrieve. Ignored when id is set.
Response
A single affiliate when filtering by id or email (null if no match), otherwise every affiliate in the program.
- object
- object[]
The affiliate ID
First name of the affiliate
Last name of the affiliate
Full name of the affiliate (optional)
Email of the affiliate
Hashed Password of the affiliate (optional)
Flag to indicate if the email has been verified
Profile image URL of the affiliate
Flag to indicate if affiliate details are complete
The program ID that the affiliate is associated with
Email to be used for payouts
Payment method for the affiliate (e.g., WISE)
Commission rate for the affiliate (0 - 100)
Deprecated legacy field and almost always null. Read affiliateLinks instead.
All affiliate link records for this affiliate. This is the source of truth for referral link slugs.
Affiliate status. INACTIVE is shown as Pending in the dashboard and is kept for backwards compatibility.
ACTIVE, INACTIVE, INVITED, DECLINED, DEACTIVATED, BANNED Timestamp when the affiliate was created
Timestamp when the affiliate was last updated
Number of users referred by the affiliate
Number of clicks generated by the affiliate
Total commission earned by the affiliate
How the affiliate joined. Affiliates created through this API have API.
The commission plan assigned to this affiliate, if any
The affiliate group this affiliate belongs to, if any