Skip to main content
The Referral endpoints show the signed-in account’s referral activity: a summary, the people it referred, its referral transactions and monthly totals. They are read-only and only work for an account that has a referral profile. Every other account receives a not-found response, which simply means it has no referral account. Last reviewed: 2026-11-04

Prerequisites

  • A bearer token and X-Brand-Slug: hi-doctor.
  • The account needs a referral profile. A patient without one gets 404 rather than an empty result.

Operations

Boundaries and side effects

  • All four operations are reads.
  • Treat a 404 on these routes as “no referral account”, not as an error to retry.