Get an affiliate
Returns an affiliate's full profile. Use all as the affiliate ID for program-wide aggregates.
Response — 200 OK
{
"name": "Jane Doe",
"email": "[email protected]",
"avatarSrc": "https://example.com/jane.png",
"isEmailVerified": true,
"affiliateId": "abc123",
"clicks": 160,
"revenue": [{ "amount": 14950, "currency": "usd" }],
"application": {
"status": "approved",
"hasApplicationMessage": false,
"fullName": "Jane Doe",
"email": "[email protected]",
"promotionMethod": "youtube",
"description": "I review developer tools on my channel."
},
"conversion_rate": 312,
"conversions": 5,
"primarySource": "youtube",
"traffic": {
"allTime": { "sources": ["youtube"], "percentages": [100] },
"today": { "sources": [], "percentages": [] }
}
}Field notes
| Field | Notes |
|---|---|
name | Always present; "Unknown Affiliate" when the affiliate never set a name. |
email | The account's email; null when the account has none. |
avatarSrc | The affiliate's avatar, or the default avatar when unset. |
isEmailVerified | Whether the account's email address is verified. |
affiliateId | The affiliate's Rezfiliate id (use it in the other /affiliate/{affiliateId} routes). |
clicks | Total tracked clicks. Returned on every plan. |
revenue | One { amount, currency } entry per currency the affiliate earned. amount is in the currency's smallest unit (14950 = $149.50). |
application | status is not_applied, pending, approved or declined. hasApplicationMessage is true when any application (legacy or structured) exists; the fullName/email/promotionMethod/description details are null until an application is submitted. promotionMethod is one of website_blog, youtube, tiktok, instagram, x_twitter, newsletter_email, paid_advertising, community_forum; email is the contact email supplied with the application (locked to the account's email server-side). |
conversion_rate | Scale plan only. Conversions per 10,000 clicks (312 ≈ 3.12%). |
conversions | Scale plan only. Total attributed conversions. |
primarySource | Scale plan only. The highest-traffic source, or null before any traffic. |
traffic | Scale plan only — all-time and today's traffic sources with their click counts. null on other plans. |
On plans without Scale,
conversion_rate,conversionsandprimarySourceare omitted from the response andtrafficisnull.clicksandrevenueare always returned.
Errors — all { "error": "<message>" }:
| Status | error values |
|---|---|
| 403 | The affiliate must accept the current affiliate legal terms. |
| 404 | Affiliate not found |
