Returns the caller's referral code, share link and the referrals they have made.

GET /v1/referral

Referral → · All API references → · Six flows, four surfaces →


Address	`https://api.hanzo.ai/v1/referral`
Method	`GET`
Operation	`get_referral`
Auth	`Authorization: Bearer $HANZO_API_KEY`

The code is a stable, deterministic function of the org, so the link in this response is the same one every time. Each row carries the referee and the status of that attribution.

IT IS A PURE READ. It advances no referral, grants nothing and deposits nothing — a GET reports state, it never changes it. Qualification is the admin sweep's job (POST /v1/admin/referral/sweep). The one row this handler can write is the caller's OWN code-directory entry (EnsureCode), which materialises a value deriveCode already computes deterministically from the org id so the code has an O(1) reverse lookup; it carries no money, no referral state and no other tenant.

Request

GET /v1/referral takes no parameters and no body — the credential is the whole request.

Response

Status	Body	Meaning
`200`	myReferrals	ok

200 body — 12 fields.

Field	In	Type	Always	Description
`code`	body	string	—	Code is the org's STABLE referral code — a deterministic function of the org id, so it never changes and never has to be stored to be reproduced.
`counts`	body	statusCounts	—
`counts.qualified`	body	integer	—	Qualified is how many referees have made metered spend.
`counts.signup`	body	integer	—	Signup is how many referees have signed up but not yet spent.
`counts.total`	body	integer	—	Total is every referral this org has made.
`link`	body	string	—	Link is the shareable signup link carrying the code, on the brand's own host.
`referrals`	body	myReferralView[]	—	Referrals is one row per org that signed up with this code.
`referrals[].createdAt`	body	integer	—	CreatedAt is when the referral was recorded, as a Unix timestamp.
`referrals[].id`	body	string	—	ID is the referral's handle.
`referrals[].qualifiedAt`	body	integer	—	QualifiedAt is when the referee first made metered spend, as a Unix timestamp; 0 while the referral is still pending.
`referrals[].referee`	body	string	—	Referee is the org that signed up with my code.
`referrals[].status`	body	string	—	Status is the referral's lifecycle state: "signup" until the referee makes metered spend, then "qualified".

Failure carries the platform error shape — see Errors.

Examples

hanzo referrals get

import { Configuration, ReferralApi } from 'hanzoai';

const api = new ReferralApi(new Configuration({ accessToken: process.env.HANZO_API_KEY }));
const { data } = await api.getReferral();

from hanzoai.cloud import ApiClient, Configuration
from hanzoai.cloud.api import ReferralApi

client = ApiClient(Configuration(access_token=os.environ["HANZO_API_KEY"]))
result = ReferralApi(client).get_referral()

cfg := cloud.NewConfiguration()
cfg.AddDefaultHeader("Authorization", "Bearer "+os.Getenv("HANZO_API_KEY"))
client := cloud.NewAPIClient(cfg)

resp, _, err := client.ReferralAPI.GetReferral(context.Background()).Execute()
if err != nil {
	return err
}

use hanzo_cloud::apis::{configuration::Configuration, referral_api};

let mut cfg = Configuration::new();
cfg.bearer_access_token = std::env::var("HANZO_API_KEY").ok();

let result = referral_api::get_referral(&cfg, Default::default()).await?;

import ai.hanzo.cloud.ApiClient;
import ai.hanzo.cloud.api.ReferralApi;

ApiClient client = new ApiClient();
client.setRequestInterceptor(b -> b.header("Authorization", "Bearer " + System.getenv("HANZO_API_KEY")));

var result = new ReferralApi(client).getReferral();

The method above is the one at the current release of the document. [email protected] (npm) and [email protected] (PyPI) were generated from an earlier release, where this operation carried a different id, so it spells the method differently — regenerating the clients is what makes the two agree. SDKs →

curl https://api.hanzo.ai/v1/referral \
  -H "Authorization: Bearer $HANZO_API_KEY"

The door reaches referral through the referrals tool, which names its 4 operations with its own verbs — this one among them, under a name only the door declares. describe explains any of them:

curl -X POST https://api.hanzo.ai/v1/mcp \
  -H "Content-Type: application/json" \
  -d '{
       "jsonrpc": "2.0",
       "id": 1,
       "method": "tools/call",
       "params": {
         "name": "describe",
         "arguments": {
           "op": "list_admin_referral_bonuses"
         }
       }
     }'

Referral API · All Hanzo APIs · Interactive reference

Returns the caller's referral code, share link and the referrals they have made.

Request

Response

Examples

On this page