affiliate

Get the affiliate dashboard summary

Standing, codes, the shareable link, the headline stats and the program terms: everything the dashboard's overview needs in one read.

get/affiliate/summary/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/affiliate/summary/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Response

Successful Response

codestring required

The minted default code.

display_namestring required
linkstring required

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

status'active' | 'suspended' | 'banned' required

Whether an affiliate may earn and be paid.

vanity_codestring nullable required

The claimed custom code, when one exists.

Changes

No recorded changes to this operation across all 1 revision of this API.