Documentation Index
Fetch the complete documentation index at: https://orbit-docs.devotel.io/llms.txt
Use this file to discover all available pages before exploring further.
Referrals API
Referral programs that Orbit customers run for their end-users — not Orbit’s own referral program. Define a program, issue per-user referral codes, track conversions, run a leaderboard, and approve payouts. Base path:/v1/referrals
Authentication: API key (X-API-Key) or session JWT.
Programs
| Method | Path | Purpose |
|---|---|---|
POST | /v1/referrals/programs | Create a referral program |
GET | /v1/referrals/programs | List programs |
GET | /v1/referrals/programs/{id} | Get a program |
PUT | /v1/referrals/programs/{id} | Update reward, expiration, rules |
DELETE | /v1/referrals/programs/{id} | Delete a program |
Codes & conversions
| Method | Path | Purpose |
|---|---|---|
POST | /v1/referrals/programs/{id}/codes | Issue a referral code (per referrer) |
GET | /v1/referrals/programs/{id}/leaderboard | Top referrers ranked by conversions |
GET | /v1/referrals/programs/{id}/conversions | List conversions |
POST | /v1/referrals/programs/{id}/conversions/{conversionId}/pay | Approve and mark a conversion as paid |
/r/:code is mounted at the API root (no /api prefix) so referral links can be branded short URLs. It’s not authenticated.