Notes API

List notes

List notes and their resource links in the current workspace.

GET/v1/notes

capability notes.list · v1health dataserver-scoped workspace

Request

Path, query, and JSON body fields accepted by this operation.

searchstring
querymin length 1max length 200
patientIdstring<uuid>
query
appointmentIdstring<uuid>
query
limitinteger
querydefault 100min 1max 200

Response

Successful responses use Dawn's data envelope.

dataNoteListrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- titlestringrequired
  min length 1max length 200
- contentstringrequired
  max length 100000
- linksone of 2 shapes[]required
  max items 50
  - kind"patient"required
  - resourceIdstring<uuid>required
- createdAtstring<date-time>required
- updatedAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

403Notes are disabled or a workspace member is required.
422The note query is invalid.
503Notes are temporarily unavailable.

Request

import { createDawnClient } from "@dawn/api";
import { appointmentIdSchema, patientIdSchema } from "@dawn/domain";

const dawn = createDawnClient({
  baseUrl: "http://localhost:6400",
});

const result = await dawn.capabilities["notes.list"]({
  "search": "string",
  "patientId": patientIdSchema.parse("33333333-3333-4333-8333-333333333333"),
  "appointmentId": appointmentIdSchema.parse("11111111-1111-4111-8111-111111111111"),
  "limit": 100,
});

if (result.isErr()) throw result.error;
console.log(result.value);

Response

Successful response.

{
  "data": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "workspaceId": "22222222-2222-4222-8222-222222222222",
      "title": "Ada Lovelace",
      "content": "string",
      "links": [
        {
          "kind": "patient",
          "resourceId": "11111111-1111-4111-8111-111111111111"
        }
      ],
      "createdAt": "2026-08-01T09:00:00.000Z",
      "updatedAt": "2026-08-01T09:00:00.000Z"
    }
  ],
  "meta": {}
}