Patients API

List patients

List patients in the current workspace.

GET/v1/patients

capability patients.list · v1health dataserver-scoped workspace

Request

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

searchstring
querymin length 1max length 120
status"active" | "inactive" | "archived"
query
limitinteger
querydefault 100min 1max 200

Response

Successful responses use Dawn's data envelope.

dataPatientListrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- firstNamestringrequired
  min length 1max length 80
- lastNamestringrequired
  min length 1max length 80
- emailstring<email> | nullrequired
- phonestring | nullrequired
  min length 5max length 40
- dateOfBirthstring<date> | nullrequired
- status"active" | "inactive" | "archived"required
- notesstring | nullrequired
  max length 50000
- createdAtstring<date-time>required
- updatedAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

422The patient query is invalid.
503Patients are temporarily unavailable.

Request

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

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

const result = await dawn.capabilities["patients.list"]({
  "search": "string",
  "status": "active",
  "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",
      "firstName": "Ada",
      "lastName": "Lovelace",
      "email": null,
      "phone": null,
      "dateOfBirth": null,
      "status": "active",
      "notes": null,
      "createdAt": "2026-08-01T09:00:00.000Z",
      "updatedAt": "2026-08-01T09:00:00.000Z"
    }
  ],
  "meta": {}
}