Back to Appointments

Appointments API examples

Explore selected endpoints with Scalar. Examples use demonstration data. Requests are disabled here; download the contract to use it in your own tools.

Download the OpenAPI contract

Read a published location schedule

GET /api/Organization/{OrganizationId}/Location/{LocationId}/Appointment

Retrieve published business hours, recurring holidays, services, locations and existing availability. Our website uses BusinessHours, Holidays and the location Timezone to calculate office availability.

Authentication: Public read-only endpoint.

Response: JSON. Published booking data.

Check whether booking is read-only

GET /api/service-mode

Clients can explain a temporary read-only state before someone completes a booking form.

Authentication: Public read-only endpoint.

Response: JSON. Current service mode.