Get an affiliate

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

FieldNotes
nameAlways present; "Unknown Affiliate" when the affiliate never set a name.
emailThe account's email; null when the account has none.
avatarSrcThe affiliate's avatar, or the default avatar when unset.
isEmailVerifiedWhether the account's email address is verified.
affiliateIdThe affiliate's Rezfiliate id (use it in the other /affiliate/{affiliateId} routes).
clicksTotal tracked clicks. Returned on every plan.
revenueOne { amount, currency } entry per currency the affiliate earned. amount is in the currency's smallest unit (14950 = $149.50).
applicationstatus 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_rateScale plan only. Conversions per 10,000 clicks (312 ≈ 3.12%).
conversionsScale plan only. Total attributed conversions.
primarySourceScale plan only. The highest-traffic source, or null before any traffic.
trafficScale plan only — all-time and today's traffic sources with their click counts. null on other plans.

On plans without Scale, conversion_rate, conversions and primarySource are omitted from the response and traffic is null. clicks and revenue are always returned.

Errors — all { "error": "<message>" }:

Statuserror values
403The affiliate must accept the current affiliate legal terms.
404Affiliate not found