Retrieve an affiliate
Retrieve a single affiliate by ID, including referral link, click and conversion counts, and lifetime commission.
Authorizations
API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.
Path Parameters
The unique identifier of the affiliate
Response
Successfully retrieved the affiliate
Unique identifier for the object.
String representing the environment.
test, prod, sandbox String representing the object's type. Objects of the same type share the same value.
"affiliate"
The email address the affiliate was invited with.
"partner@example.com"
The affiliate's status within your program, reflecting their membership standing: active, pending (awaiting approval), rejected, suspended, or inactive (left or removed). Invited-but-not-yet-joined affiliates are not returned by this endpoint.
"active"
The affiliate's unique referral code.
"a1b2c3d4"
The affiliate's shareable referral link. Traffic arriving through it is attributed to this affiliate.
"https://creem.io/affiliate?code=a1b2c3d4"
Total number of clicks recorded on the affiliateās links.
128
Total number of conversions attributed to the affiliate.
12
Lifetime commission earned by the affiliate, in cents (1000 = $10.00), reported in a single primary currency (see currency). Affiliates earning in multiple currencies show only their highest-earning currency here; use the affiliate's commissions endpoint for the full per-currency breakdown.
4200
Three-letter ISO currency code, in uppercase, for the earnings amount. This is the affiliate's primary (highest-earning) currency; commissions in other currencies are listed individually on the commissions endpoint.
"USD"
The display name of the affiliate, if set.
"Jane Partner"