GET
/
affiliates

Authorizations

Authorization
string
headerrequired

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

id
string

The ID of the affiliate to retrieve

email
string

The email of the affiliate to retrieve

Response

200 - application/json
id
string

The affiliate ID

firstName
string

First name of the affiliate

lastName
string

Last name of the affiliate

name
string | null

Full name of the affiliate (optional)

email
string

Email of the affiliate

password
string | null
deprecated

Hashed Password of the affiliate (optional)

emailVerified
boolean | null

Flag to indicate if the email has been verified

image
string | null

Profile image URL of the affiliate

detailsComplete
boolean

Flag to indicate if affiliate details are complete

programId
string

The program ID that the affiliate is associated with

payoutEmail
string

Email to be used for payouts

paymentMethod
string

Payment method for the affiliate (e.g., WISE)

commissionRate
number

Commission rate for the affiliate (0 - 100)

link
string

Affiliate's custom referral link

status
string

Status of the affiliate (active/inactive)

createdAt
string

Timestamp when the affiliate was created

updatedAt
string

Timestamp when the affiliate was last updated

numberOfReferredUsers
integer

Number of users referred by the affiliate

numberOfClicks
integer

Number of clicks generated by the affiliate

totalCommissionEarned
number

Total commission earned by the affiliate

IntroductionCreate an Affiliate