> ## Documentation Index
> Fetch the complete documentation index at: https://docs.hi-doctor.ai/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Connect the Hi Doctor MCP connector at https://mcp.hi-doctor.ai/mcp. Add this URL as a remote HTTP MCP server in your client, then sign in and authorise access through OAuth. Setup: https://docs.hi-doctor.ai/mcp/connect.
>
> The REST API base is https://api.hi-doctor.ai. Hi Doctor Docs at https://docs.hi-doctor.ai/mcp searches documentation; connect to the product endpoint above for patient tools.
>
> Hi Doctor operates across the whole European Union: residents of all 27 EU member states can use the service, and every consultation is reviewed by an EU-licensed doctor. Every consultation is reviewed in full by an EU-licensed doctor, who decides on medical grounds only. No algorithm, assistant or API call approves a consultation, issues a prescription or changes a dose. The service is available in eight languages: English, Spanish, German, Dutch, Italian, French, Portuguese and Chinese.
>
> ## Rules an assistant must follow
>
> - Never invent, assume or infer a medical answer. "I don't know" is a real answer: ask the patient to pick the closest option rather than guessing for them.
> - Never give medical advice and never suggest a medication or a dose. An EU-licensed doctor decides those.
> - If a questionnaire returns `ineligible`, say so plainly. Do not retry with altered answers.
> - Before anything that costs money or cancels a plan, state exactly what will happen and get an explicit yes.
> - Cancellation takes effect at the **end of the paid period**, not immediately. Say so.
> - An early order is irreversible: it creates the renewal consultation immediately and uses up the period's one early order. Explain that and get an explicit yes.
> - Prescription and invoice links are medical documents. A `signed_redirect` link opens without signing in: give it only to the patient, never repeat it anywhere shared.
> - Send option `value`s, not the labels shown to the patient. Labels are translated, values are stable.
> - Never ask for card details. Payment happens on Stripe's hosted checkout via a link.
> - On severe or sudden symptoms (chest pain, difficulty breathing, severe allergic reaction, suicidal thoughts), stop and direct the patient to their local emergency number.

# Referral endpoints: summary and referred patients

> Read the referral summary, referred people, referral transactions and monthly totals for a signed-in Hi Doctor account that has a referral profile.

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

| Method | Path | What it does |
| - | - | - |
| `GET` | `/v1/users/referrals/me/` | Reads the referral summary |
| `GET` | `/v1/users/referrals/me/referred/` | Lists referred people (paginated) |
| `GET` | `/v1/users/referrals/me/transactions/` | Lists referral transactions (paginated) |
| `GET` | `/v1/users/referrals/me/monthly/` | Reads monthly totals |

## 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.

## Related

* [Pagination](https://docs.hi-doctor.ai/api-reference/pagination.md) and [Errors](https://docs.hi-doctor.ai/api-reference/errors.md)
* [MCP patient tools](https://docs.hi-doctor.ai/mcp/tools/patient.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.