Skip to main content
GET
Get the affiliate dashboard summary

Authorizations

X-API-Key
string
header
required

Response

Successful Response

Everything the affiliate dashboard's overview needs in one read.

code
string
required

The minted default code.

display_name
string
required

The full URL to share, using the vanity code when claimed.

profile
AffiliateProfileReadSchema · object
required

The caller's own standing in the affiliate program.

program
AffiliateProgramReadSchema · object
required

What the affiliate program pays right now — the public half of the offer.

stats
AffiliateStatsReadSchema · object
required

The affiliate dashboard's headline numbers.

status
enum<string>
required

Whether an affiliate may earn and be paid.

Available options:
active,
suspended,
banned
vanity_code
string | null
required

The claimed custom code, when one exists.