Skip to content
Coritan Docs

Organization API: Customer Portal: Referrals

The 1 Organization API operations for referrals.

View as Markdown

Part of Customer Portal.

Method Path Summary
GET /api/v1/orgs/{org_slug}/portal/referrals My referrals

GET /api/v1/orgs/{org_slug}/portal/referrals

The customer's referral code and link, what a referral earns, and how their referrals stand.

Needs the customer's sign-in. enabled is false while the organization has the program off, and then there is no code or link and none is made. The first time the program is on, the customer's own code (8 letters and digits) is made, and it never changes. link is the storefront address with ?ref=<code>: a visitor who opens it and later pays a first invoice that reaches threshold_amount earns the customer reward_amount in wallet credit (currency) after hold_days, and the visitor referee_reward_amount as a welcome credit when it is above 0. stats counts the customer's pending, qualified and credited referrals and earned, the wallet credit paid so far. referrals lists the last 50, newest first, each with the referred customer's first name (Someone when there is none, never an email address), its status (qualified while it waits out its hold, credited, void) and its dates. A support session that signed in as the customer reads the page but does not make a code.

Name In Type Required
org_slug path string yes
Status Meaning
200 Success.
422 The request is not valid. detail lists each problem.