Skip to main content
GET
Get the workspace's referral summary

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Successful Response

Everything the referrals page needs before it lists anything.

code
string
required

The workspace's permanent referral code.

conversion_reward_credits
integer
required

Whole credits paid to BOTH sides when a referred workspace starts its first paid plan.

The full URL to share. Assembled server-side so the client never has to know which domain the program currently points at.

signup_reward_credits
integer
required

Whole credits paid to BOTH sides when a referred workspace signs up.

stats
ReferralStatsSchema · object
required

The three headline numbers on the referrals page.