API reference

Every endpoint below is generated from Dawn's canonical OpenAPI contract. Request fields, response shapes, status codes, and examples update with the implemented API.

Patients

GETList patients

/v1/patients

POSTCreate a patient

/v1/patients

GETGet a patient

/v1/patients/{patientId}

PATCHUpdate a patient

/v1/patients/{patientId}

DELETEDelete a patient

/v1/patients/{patientId}

GETGet the current patient

/v1/patients/me

Appointments

GETList appointments

/v1/appointments

POSTCreate an appointment

/v1/appointments

GETGet an appointment

/v1/appointments/{appointmentId}

PATCHTransition an appointment

/v1/appointments/{appointmentId}

Catalogue

GETList catalogue items

/v1/catalogue/items

POSTCreate a catalogue item

/v1/catalogue/items

GETGet a catalogue item

/v1/catalogue/items/{itemId}

PATCHUpdate a catalogue item

/v1/catalogue/items/{itemId}

DELETEDelete a catalogue item

/v1/catalogue/items/{itemId}

GETList catalogue prices

/v1/catalogue/items/{itemId}/prices

POSTCreate a catalogue price

/v1/catalogue/items/{itemId}/prices

PATCHUpdate a catalogue price

/v1/catalogue/items/{itemId}/prices/{priceId}

DELETEDelete a catalogue price

/v1/catalogue/items/{itemId}/prices/{priceId}

Events

GETList timeline events

/v1/events

Modules

GETList module readiness and enablement

/v1/modules

Messages

GETList messages

/v1/messages

POSTSend message

/v1/messages

Notes

/v1/notes

/v1/notes

/v1/notes/{noteId}

/v1/notes/{noteId}

/v1/notes/{noteId}

Booking

GETList bookable offerings

/v1/booking/offerings

GETList available booking slots

/v1/booking/slots

GETList booking resources

/v1/booking/resources

POSTCreate a booking resource

/v1/booking/resources

PATCHUpdate a booking resource

/v1/booking/resources/{resourceId}

Practitioners

GETList practitioners

/v1/practitioners

Search

POSTSearch the current workspace

/v1/search

Settings

GETList settings

/v1/settings

POSTCreate a setting

/v1/settings

GETGet a setting

/v1/settings/{settingId}

PATCHUpdate a setting

/v1/settings/{settingId}

DELETEDelete a setting

/v1/settings/{settingId}

Storefront

GETList storefront catalogue

/storefront/v1/{workspaceSlug}/catalogue/items

GETGet storefront item

/storefront/v1/{workspaceSlug}/catalogue/items/{handle}

POSTCalculate a storefront quote

/storefront/v1/{workspaceSlug}/quotes