Messages API

List messages

List messages in a patient's channel.

GET/v1/messages

capability messages.list · v1health dataserver-scoped workspace

Request

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

patientIdstring<uuid>
query
channel"patient_app"
querydefault "patient_app"
limitinteger
querydefault 100min 1max 200

Response

Successful responses use Dawn's data envelope.

dataMessageListrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- patientIdstring<uuid>required
- channel"patient_app"required
- senderone of 2 shapesrequired
  - kind"member"required
  - idstring<uuid>required
- bodystringrequired
  min length 1max length 4000
- createdAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

403Messaging is disabled or the requested patient is unavailable.
422The message query is invalid.
503Messages are temporarily unavailable.

Request

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

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

const result = await dawn.capabilities["messages.list"]({
  "patientId": patientIdSchema.parse("33333333-3333-4333-8333-333333333333"),
  "channel": "patient_app",
  "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",
      "patientId": "33333333-3333-4333-8333-333333333333",
      "channel": "patient_app",
      "sender": {
        "kind": "member",
        "id": "11111111-1111-4111-8111-111111111111"
      },
      "body": "string",
      "createdAt": "2026-08-01T09:00:00.000Z"
    }
  ],
  "meta": {}
}

Patient sessions are always scoped to their own thread. Workspace members can provide patientId for one thread or omit it to list messages across the workspace inbox.