v2

latestOpenAPI 3.0.0Commercial2026-07-2649110209.4 KB

Affiliates

Retrieve an affiliate

Retrieve a single affiliate by ID, including referral link, click and conversion counts, and lifetime commission.

get/v1/affiliates/{id}

Path parameters

idstring required

The unique identifier of the affiliate

Response

Successfully retrieved the affiliate

idstring required

Unique identifier for the object.

mode'test' | 'prod' | 'sandbox' required

String representing the environment.

objectstring required

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

emailstring required

The email address the affiliate was invited with.

namestring nullable

The display name of the affiliate, if set.

statusstring 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.

referral_codestring required

The affiliate's unique referral code.

referral_linkstring required

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

clicksnumber required

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

conversionsnumber required

Total number of conversions attributed to the affiliate.

earningsnumber 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.

currencystring 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 response

{
  "object": "affiliate",
  "email": "partner@example.com",
  "name": "Jane Partner",
  "status": "active",
  "referral_code": "a1b2c3d4",
  "referral_link": "https://creem.io/affiliate?code=a1b2c3d4",
  "clicks": 128,
  "conversions": 12,
  "earnings": 4200,
  "currency": "USD"
}