Booking API

List booking resources

List schedulable people, sites, rooms, and equipment in the current workspace.

GET/v1/booking/resources

capability booking.resources.list · v1operational dataserver-scoped workspace

Request

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

kind"person" | "site" | "room" | "equipment"
query
status"active" | "inactive"
query

Response

Successful responses use Dawn's data envelope.

dataBookingResourceListrequired
- idstring<uuid>required
- workspaceIdstring<uuid>required
- namestringrequired
  min length 1max length 120
- kind"person" | "site" | "room" | "equipment"required
- status"active" | "inactive"required
- practitionerIdstring<uuid> | nullrequired
- parentResourceIdstring<uuid> | nullrequired
- scheduleIdstring<uuid> | nullrequired
- createdAtstring<date-time>required
- updatedAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

403Scheduling is disabled.
422The booking resource query is invalid.
503Booking resources are temporarily unavailable.

Request

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

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

const result = await dawn.capabilities["booking.resources.list"]({
  "kind": "person",
  "status": "active",
});

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",
      "name": "string",
      "kind": "person",
      "status": "active",
      "practitionerId": null,
      "parentResourceId": null,
      "scheduleId": null,
      "createdAt": "2026-08-01T09:00:00.000Z",
      "updatedAt": "2026-08-01T09:00:00.000Z"
    }
  ],
  "meta": {}
}