Booking API

List available booking slots

Resolve available appointment slots and concrete resources for an offering.

GET/v1/booking/slots

capability booking.slots · v1operational dataserver-scoped workspace

Request

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

offeringIdstring<uuid>required
query
fromstring<date-time>required
query
tostring<date-time>required
query

Response

Successful responses use Dawn's data envelope.

dataBookingSlotListrequired
- offeringIdstring<uuid>required
- startsAtstring<date-time>required
- endsAtstring<date-time>required
- assignmentsobject[]required
  min items 1max items 24
  - requirementIdstring<uuid>required
  - resourceIdstring<uuid>required
  - kind"person" | "site" | "room" | "equipment"required
  - practitionerIdstring<uuid> | nullrequired
  - startsAtstring<date-time>required
  - endsAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

403Scheduling is disabled or unavailable.
404The booking offering could not be found.
422The booking query is invalid.
503Booking availability is temporarily unavailable.

Request

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

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

const result = await dawn.capabilities["booking.slots"]({
  "offeringId": bookingOfferingIdSchema.parse("11111111-1111-4111-8111-111111111111"),
  "from": "2026-08-01T09:00:00.000Z",
  "to": "2026-08-08T17:00:00.000Z",
});

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

Response

Successful response.

{
  "data": [
    {
      "offeringId": "11111111-1111-4111-8111-111111111111",
      "startsAt": "2026-08-01T09:00:00.000Z",
      "endsAt": "2026-08-08T17:00:00.000Z",
      "assignments": [
        {
          "requirementId": "11111111-1111-4111-8111-111111111111",
          "resourceId": "11111111-1111-4111-8111-111111111111",
          "kind": "person",
          "practitionerId": null,
          "startsAt": "2026-08-01T09:00:00.000Z",
          "endsAt": "2026-08-08T17:00:00.000Z"
        }
      ]
    }
  ],
  "meta": {}
}