API Reference
Hanzo Referrals API
Per-org viral-loop referral program that grants promo cloud credit (hanzoai/cloud clients/referrals).
Per-org viral-loop referral program that grants promo cloud credit (hanzoai/cloud clients/referrals).
Hanzo Referrals API · All API references →
| Base URL | https://api.hanzo.ai |
| Version | 1.0.0 |
| Operations | 5 |
Authentication
bearerAuth—
All Hanzo APIs share one bearer credential and common error and pagination conventions. See API conventions.
curl -H "Authorization: Bearer $HANZO_API_KEY" https://api.hanzo.aiEndpoints
Admin
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/admin/referrals | List every referral with a fleet summary (global-admin) |
POST | /v1/admin/referrals/sweep | Qualify-check every pending referral (global-admin) |
Health
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/referrals/health | Liveness probe |
Referrals
| Method | Endpoint | Description |
|---|---|---|
GET | /v1/referrals | Get my referral code, link, and referrals |
POST | /v1/referrals/claim | Claim a referral from a ?ref code |
How is this guide?