Skip to main content
GET
Retrieve an affiliate

Authorizations

x-api-key
string
header
required

API key for authentication. You can find your API key in the Creem dashboard under Settings > API Keys.

Path Parameters

id
string
required

The unique identifier of the affiliate

Response

Successfully retrieved the affiliate

id
string
required

Unique identifier for the object.

mode
enum<string>
required

String representing the environment.

Available options:
test,
prod,
sandbox
object
string
required

String representing the object's type. Objects of the same type share the same value.

Example:

"affiliate"

email
string
required

The email address the affiliate was invited with.

Example:

"partner@example.com"

status
string
required

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.

Example:

"active"

referral_code
string
required

The affiliate's unique referral code.

Example:

"a1b2c3d4"

The affiliate's shareable referral link. Traffic arriving through it is attributed to this affiliate.

Example:

"https://creem.io/affiliate?code=a1b2c3d4"

clicks
number
required

Total number of clicks recorded on the affiliate’s links.

Example:

128

conversions
number
required

Total number of conversions attributed to the affiliate.

Example:

12

earnings
number
required

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.

Example:

4200

currency
string
required

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.

Example:

"USD"

name
string | null

The display name of the affiliate, if set.

Example:

"Jane Partner"