Skip to content
Hermes Health API
GuidesOpenAPI spec

Endpoints

Patient notes

GET/v0/companies/{company_id}/projects/{project_id}/patients/{patient_id}/notes

List a patient's notes

Returns every note filed on the patient, newest first. Returns 404 when the patient does not exist or is not visible to the caller.

ReturnsSuccess

  • notesobject[]

    The notes, newest first.

  • notes[].idstring

    The note's ID.

  • notes[].createdAtstring

    When the note was written.

  • notes[].userEmailstring

    Email address of the user who wrote the note. Empty when that user can no longer be found.

  • notes[].contentstring

    The note's text.

  • notes[].authoredByAiboolean

    True when the note was authored by the Hermes AI voice agent rather than a human user. Renderers show an automated "AI" badge and skip the human user lookup.

Conditional attributes

  • notes[].updatedAtstring

    When the note was last edited. Null when it has never been edited.

Errors

401404500

POST/v0/companies/{company_id}/projects/{project_id}/patients/{patient_id}/notes

Add a note to a patient

Creates a new note on the patient, authored by the caller. Each call adds another note, so retrying a request that succeeded creates a duplicate. Any webhook endpoints subscribed to patient note events are notified. Returns an empty body on success.

Request bodyapplication/json

  • contentstring

    The new text of the note, replacing the old text.

    Free text. Surrounding whitespace is trimmed, and an empty or whitespace-only value is rejected.

ReturnsSuccess

Errors

401500

DELETE/v0/companies/{company_id}/projects/{project_id}/patients/{patient_id}/notes/{note_id}

Delete a patient note

Deletes the note when it is filed on this patient and the caller authored it. The call succeeds with an empty body even when no matching note exists, so repeating it is safe.

Parameters

  • note_idstringpath, required

    The id of the note to delete, as returned when listing the patient's notes.

ReturnsSuccess

Errors

401500