Booking API

List available booking slots

List available appointment slots for a practitioner.

GET/v1/booking/slots

capability booking.slots · v1operational dataserver-scoped workspace

Request

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

practitionerIdstring<uuid>required
query
fromstring<date-time>required
query
tostring<date-time>required
query
durationMinutesinteger
querydefault 30min 5max 480
intervalMinutesinteger
querydefault 15min 5max 120

Response

Successful responses use Dawn's data envelope.

dataBookingSlotListrequired
- practitionerIdstring<uuid>required
- startsAtstring<date-time>required
- endsAtstring<date-time>required
metaobject

Errors

Error responses use the shared error envelope.

403Scheduling is disabled or unavailable.
422The booking query is invalid.
503Booking availability is temporarily unavailable.

Request

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

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

const result = await dawn.capabilities["booking.slots"]({
  "practitionerId": practitionerIdSchema.parse("44444444-4444-4444-8444-444444444444"),
  "from": "2026-08-01T09:00:00.000Z",
  "to": "2026-08-08T17:00:00.000Z",
  "durationMinutes": 30,
  "intervalMinutes": 15,
});

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

Response

Successful response.

{
  "data": [
    {
      "practitionerId": "44444444-4444-4444-8444-444444444444",
      "startsAt": "2026-08-01T09:00:00.000Z",
      "endsAt": "2026-08-08T17:00:00.000Z"
    }
  ],
  "meta": {}
}