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

# List patient notes

> Self-scoped.

### Access, effects and retries
**Ownership:** Patient user-filtered rows.

**Prerequisites:** An authenticated patient account is required.

**Effects:** Read only.

**Retries:** Safe read; page content can shift with writes.



## OpenAPI

````yaml /api-reference/openapi.json get /v1/users/journal/notes/
openapi: 3.0.3
info:
  title: Hi Doctor API
  version: 1.0.1
  description: >-
    The patient-facing Hi Doctor API supports account management, consultation
    questionnaires, medical documents, messages and billing. Sign-in requires
    X-Brand-Slug: hi-doctor; authenticated requests use Authorization: Bearer
    <access> with a JWT access token. See
    https://docs.hi-doctor.ai/api-reference/introduction for integration guides.
  contact:
    name: Hi Doctor
    email: hello@hi-doctor.ai
    url: https://docs.hi-doctor.ai
servers:
  - url: https://api.hi-doctor.ai
    description: Production
security: []
tags:
  - name: Account
    description: Register, verify, authenticate and manage the signed-in account.
  - name: Questionnaires
    description: Discover, save and submit consultation questionnaires.
  - name: Consultations
    description: Read consultation state and manage consultation photographs.
  - name: Prescriptions
    description: Retrieve issued prescription documents and request reissue.
  - name: Messages
    description: Read and send messages to the medical team, and download attachments.
  - name: Billing
    description: >-
      Create checkout, manage subscriptions and retrieve
      payments/invoices/credit notes.
  - name: Records
    description: Read orders and manage patient health documents.
  - name: Safety reports
    description: Submit and read suspected side-effect reports; no automated diagnosis.
  - name: Progress
    description: Record and review eligible weight-loss progress.
  - name: Referrals
    description: Read the signed-in account's referral summary and referral activity.
paths:
  /v1/users/journal/notes/:
    get:
      tags:
        - Progress
      summary: List patient notes
      description: |-
        Self-scoped.

        ### Access, effects and retries
        **Ownership:** Patient user-filtered rows.

        **Prerequisites:** An authenticated patient account is required.

        **Effects:** Read only.

        **Retries:** Safe read; page content can shift with writes.
      operationId: users_journal_notes_list
      parameters:
        - name: ordering
          required: false
          in: query
          description: Which field to use when ordering the results.
          schema:
            type: string
          example: synthetic
        - name: limit
          required: false
          in: query
          description: Number of results to return per page.
          schema:
            type: integer
          example: 1
        - name: offset
          required: false
          in: query
          description: The initial index from which to return the results.
          schema:
            type: integer
          example: 1
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedJournalNoteList'
              examples:
                example-1:
                  summary: Illustrative response example
                  value:
                    count: 0
                    next: null
                    previous: null
                    results: []
                example-2:
                  summary: Illustrative response example
                  value:
                    count: 2
                    next: >-
                      https://api.hi-doctor.ai/v1/users/journal/notes/?limit=1&offset=1
                    previous: null
                    results:
                      - id: 0431dab0-cdb7-5436-a7f2-09a03879048b
                        created_at: '2026-10-05T17:48:36.331137Z'
                        updated_at: '2026-10-05T17:48:38.043789Z'
                        content: Synthetic example
                        mood: 3
                        entry_date: '2026-10-04'
                example-3:
                  summary: Illustrative response example
                  value:
                    count: 2
                    next: null
                    previous: https://api.hi-doctor.ai/v1/users/journal/notes/?limit=1
                    results:
                      - id: 3ab033ef-0fa6-5c3d-a01c-d1fb6ca98a56
                        created_at: '2026-10-05T17:48:36.638611Z'
                        updated_at: '2026-10-05T17:48:36.638627Z'
                        content: Synthetic example
                        mood: 3
                        entry_date: '2026-10-03'
                example-4:
                  summary: Illustrative response example
                  value:
                    count: 0
                    next: null
                    previous: null
                    results: []
                example-5:
                  summary: Illustrative response example
                  value:
                    count: 0
                    next: null
                    previous: null
                    results: []
                example-6:
                  summary: Captured response example
                  value:
                    count: 1
                    next: null
                    previous: >-
                      https://api.hi-doctor.ai/v1/users/journal/notes/?limit=1&offset=999999
                    results: []
                example-7:
                  summary: Captured response example
                  value:
                    count: 1
                    next: null
                    previous: null
                    results:
                      - id: a3e6728f-944d-5290-906e-24a17ca22a32
                        created_at: '2026-10-05T18:21:50.858473Z'
                        updated_at: '2026-10-05T18:21:50.858489Z'
                        content: Synthetic example
                        mood: 3
                        entry_date: '2026-10-04'
                example-8:
                  summary: Captured response example
                  value:
                    count: 1
                    next: null
                    previous: null
                    results:
                      - id: a3e6728f-944d-5290-906e-24a17ca22a32
                        created_at: '2026-10-05T18:21:50.858473Z'
                        updated_at: '2026-10-05T18:21:50.858489Z'
                        content: Synthetic example
                        mood: 3
                        entry_date: '2026-10-04'
          description: Successful list notes.
        '401':
          description: >-
            No bearer token, or a token that is expired or malformed.
            Re-authenticate; do not retry the same token.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Error envelope emitted by the source branch or DRF validation.
                  `detail`, `error` and `code` depend on the branch; field
                  validation uses lists keyed by request field.
                additionalProperties: {}
              examples:
                example-1:
                  summary: Illustrative response example
                  value:
                    detail: Authentication credentials were not provided.
        '403':
          description: The account lacks permission for this operation.
          content:
            application/json:
              schema:
                type: object
                description: >-
                  Error envelope emitted by the source branch or DRF validation.
                  `detail`, `error` and `code` depend on the branch; field
                  validation uses lists keyed by request field.
                additionalProperties: {}
              examples:
                example-1:
                  summary: Illustrative response example
                  value:
                    detail: You do not have permission to perform this action.
        '429':
          description: Source-defined error response; inspect the envelope and retry rules.
          content:
            application/json:
              schema:
                type: object
                additionalProperties: {}
                description: >-
                  Endpoint/DRF error envelope; field validation is keyed by
                  request field.
              examples:
                example-1:
                  summary: Illustrative response example
                  value:
                    detail: Request was throttled.
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: Shell
          label: curl
          source: >
            set -eu

            umask 077

            # Path values must be URL-encoded; query string excludes the leading
            question mark.

            url="${HD_BASE_URL:?Set API
            origin}/v1/users/journal/notes/${HD_QUERY_STRING:+?${HD_QUERY_STRING}}"

            printf 'X-Brand-Slug: hi-doctor\nAccept: application/json\n' >
            "${HD_REQUEST_HEADERS_FILE:?Private header file}"

            printf 'Authorization: Bearer %s\n' "${HD_ACCESS_TOKEN:?Set backend
            JWT}" >> "$HD_REQUEST_HEADERS_FILE"

            curl --silent --show-error --max-time 30 --request GET \
              --header "@$HD_REQUEST_HEADERS_FILE" \
              --dump-header "${HD_HEADERS_FILE:?Private response header file}" \
              --output "${HD_RESPONSE_FILE:?Private response file}" \
              --write-out '%{http_code}\n%{content_type}\n' \
              "$url"
        - lang: Python
          label: requests
          source: >
            import os, json

            from pathlib import Path

            from urllib.parse import quote

            import requests

            os.umask(0o077)

            url = os.environ["HD_BASE_URL"].rstrip("/") +
            '/v1/users/journal/notes/'

            if os.environ.get("HD_QUERY_STRING"): url += "?" +
            os.environ["HD_QUERY_STRING"]

            headers = {"X-Brand-Slug": "hi-doctor", "Accept":
            'application/json'}

            headers["Authorization"] = "Bearer " + os.environ["HD_ACCESS_TOKEN"]

            kwargs = {}

            response = requests.request('GET', url, headers=headers, timeout=30,
            allow_redirects=False, **kwargs)

            Path(os.environ["HD_RESPONSE_FILE"]).write_bytes(response.content)

            Path(os.environ["HD_HEADERS_FILE"]).write_text(json.dumps(dict(response.headers)))

            print(response.status_code)

            print(response.headers.get("Content-Type", ""))
        - lang: JavaScript
          label: fetch
          source: >
            import { readFileSync, writeFileSync } from "node:fs";

            const env = process.env;

            let url = env.HD_BASE_URL.replace(/\/$/, "") +
            "/v1/users/journal/notes/";

            if (env.HD_QUERY_STRING) url += "?" + env.HD_QUERY_STRING;

            const headers = { "X-Brand-Slug": "hi-doctor", "Accept":
            "application/json" };

            headers.Authorization = "Bearer " + env.HD_ACCESS_TOKEN;

            const options = { method: "GET", headers, redirect: "manual",
            signal: AbortSignal.timeout(30000) };

            const response = await fetch(url, options);

            writeFileSync(env.HD_RESPONSE_FILE, Buffer.from(await
            response.arrayBuffer()), {mode: 0o600});

            writeFileSync(env.HD_HEADERS_FILE,
            JSON.stringify(Object.fromEntries(response.headers)), {mode:
            0o600});

            console.log(response.status);

            console.log(response.headers.get("content-type") ?? "");
components:
  schemas:
    PaginatedJournalNoteList:
      type: object
      required:
        - count
        - results
      properties:
        count:
          type: integer
          example: 123
          description: Total matching records before pagination.
        next:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
          description: >-
            URL of the next page, or null after the last page. May be null when
            unavailable.
        previous:
          type: string
          nullable: true
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
          description: >-
            URL of the previous page, or null on the first page. May be null
            when unavailable.
        results:
          type: array
          items:
            $ref: '#/components/schemas/JournalNote'
          description: Records in this page, in the documented collection order.
    JournalNote:
      type: object
      properties:
        id:
          type: string
          format: uuid
          readOnly: true
          description: >-
            Unique identifier of this resource. Returned by the server; not
            writable.
        created_at:
          type: string
          format: date-time
          readOnly: true
          description: >-
            Created at timestamp in ISO 8601 format. Returned by the server; not
            writable.
        updated_at:
          type: string
          format: date-time
          readOnly: true
          description: >-
            Updated at timestamp in ISO 8601 format. Returned by the server; not
            writable.
        content:
          type: string
          description: Text content of the resource.
        mood:
          type: integer
          maximum: 5
          minimum: 1
          nullable: true
          description: Mood for this journal note. May be null when unavailable.
        entry_date:
          type: string
          format: date
          description: Entry date as an ISO 8601 calendar date.
      required:
        - content
        - created_at
        - id
        - updated_at
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````

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