Notes
Get Notes Summary
Retrieve only the summary of an appointment’s notes
GET
Overview
Retrieve just the summary of the notes for a specific appointment. This returns only thesummary field, providing a quick overview without the full clinical content. Use Get Notes by Appointment to retrieve the complete notes.
This operation is scoped to the owning doctor. The appointment identified by
{id} must belong to the authenticated user. A request for an appointment you do not own returns 403 Forbidden, and an unknown appointment returns 404 Appointment not found.Authentication
Bearer token for authenticated access. The doctor (user) identity is taken from the JWT.
401 with a message field. See Error Responses.
Path Parameters
Appointment ID (MongoDB ObjectId, 24 hex characters) whose notes summary to retrieve. Must be owned by the authenticated doctor.
Response
Indicates whether the operation succeeded.
Object containing the summary.
Error message (only present when
success is false).Example Request
Example Response
Error Responses
Behavior Notes
- The endpoint first verifies the appointment exists and is owned by the caller, then looks up its notes.
- There are two distinct
404cases: the appointment does not exist (Appointment not found), or the appointment exists but has no notes (Notes not found).
Status Codes
- 200 — Summary retrieved successfully.
- 401 — Missing, invalid, or revoked authentication token.
- 403 — Authenticated user does not own the appointment.
- 404 — Appointment not found, or no notes exist for the appointment.