Skip to main content
GET
Get referral link for a user

Authorizations

x-tenant-api-key
string
header
required

Tenant API key for authentication. Keys are scoped to specific environments (LIVE or SANDBOX). Obtain keys from the admin dashboard.

Query Parameters

user_id
string<uuid>
required

The user ID to get the referral link for

Response

Referral link retrieved

user_id
string<uuid>

The MLM user ID

referral_code
string

The user's referral code

referral_url
string<uri>

Fully-qualified referral URL (derived from tenant settings)

is_new
boolean

True if the referral code was newly created for the user