Retrieve affiliate
Retrieves the details of an existing affiliate.
Required permissions:
affiliate:basic:read
Authorizations
A company API key, company scoped JWT, app API key, or user OAuth token. You must prepend your key/token with the word 'Bearer', which will look like Bearer ***************************
Path Parameters
The unique identifier of the affiliate.
"aff_xxxxxxxxxxxxxx"
Response
A successful response
An affiliate tracks a user's referral performance and commission earnings for a company, including retention rates, revenue metrics, and payout configurations.
The total active members of the affiliate
42
The company attached to this affiliate
The datetime the affiliate was created.
"2023-12-01T05:00:00.401Z"
The percentage of referred customers who are still active members
The percentage of referred customers who remained active over the last 90 days
The unique identifier for the affiliate.
"aff_xxxxxxxxxxxxxx"
The monthly recurring revenue generated by this affiliate's referrals, formatted as a USD currency string
The status of the affiliate
active, archived, deleted The total count of all overrides for this affiliate
42
The total commission earnings paid to this affiliate, formatted as a USD currency string
The total referrals of the affiliate
42
The total revenue generated from this affiliate's referrals, formatted as a USD currency string
The datetime the affiliate was last updated.
"2023-12-01T05:00:00.401Z"
The user attached to this affiliate

