Events API

List timeline events

List recorded events relevant to a resource in the current workspace.

GET/v1/events

capability events.list · v1health dataserver-scoped workspace

Request

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

resourceType"appointment" | "patient" | "practitioner"required
query
resourceIdstring<uuid>required
query
limitinteger
querydefault 50min 1max 100

Response

Successful responses use Dawn's data envelope.

dataEventListrequired
- idstring<uuid>required
- version1required
- workspaceIdstring<uuid>required
- memberIdstring<uuid>required
- occurredAtstring<date-time>required
- type"appointment.created"required
- resourceType"appointment"required
- resourceIdstring<uuid>required
metaobject

Errors

Error responses use the shared error envelope.

403Scheduling is disabled for appointment timelines.
422The event query is invalid.
503Timeline events are temporarily unavailable.

Request

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

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

const result = await dawn.capabilities["events.list"]({
  "resourceType": "appointment",
  "resourceId": "11111111-1111-4111-8111-111111111111",
  "limit": 50,
});

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

Response

Successful response.

{
  "data": [
    {
      "id": "11111111-1111-4111-8111-111111111111",
      "version": 1,
      "workspaceId": "22222222-2222-4222-8222-222222222222",
      "memberId": "11111111-1111-4111-8111-111111111111",
      "occurredAt": "2026-08-01T09:00:00.000Z",
      "type": "appointment.created",
      "resourceType": "appointment",
      "resourceId": "11111111-1111-4111-8111-111111111111"
    }
  ],
  "meta": {}
}