Cancel an appointment
/api/v1/appointments/{id}/cancelCancels on the guest's behalf, recorded as cancelled by the guest. The row is kept, the guest gets the venue's usual cancellation notice, and a paid deposit is settled by the venue's own refund window: depositOutcome says whether it was refunded, forfeited, none, or failed (the booking IS cancelled; the money needs a person). Only a confirmed or pending booking can be cancelled.
Authorization
bearerApiKey appointments:writeBuild with a test key (sk_test_...): it works only in your API sandbox and never emails or texts anyone. Scopes, errors and limits.
In: header
Scope: appointments:write
Path Parameters
Appointment id.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/v1/appointments/string/cancel"{ "data": {}}Change an appointmentPATCH
A new time (or, for a table, a new party size) goes through the same change function as the guest's own change on their manage link: the venue's allocator, layouts, locks, hours and every other booking, leaving this booking out of its own way, then the deposit for the new time and party size; the booking window binds a new time. A change never takes money: one that would owe a deposit or a card the booking does not hold (a new time's service-period deposit, or a bigger party crossing the venue's deposit or card rule) is a `409 payment_required`. A party size change on a booking that already holds a deposit or a card is refused outright, for the venue to settle. The guest is told about a new time with the venue's usual change notice. Only a `confirmed` or `pending` booking that has not started can change. Send only the fields you are changing. The service and team member stay as booked.
List reservationsGET
The hospitality engine's table reservations. The mirror of `GET /api/v1/appointments` (same envelope, same paging, same filters), and deliberately not the same endpoint with a flag: the two engines share plumbing, never booking logic. Engine-guarded: a key from an appointments organization gets `403 wrong_vertical` before its scope is even checked. Newest first; use `from` and `to` for a service, a day or a week. `holdExpiresAt` is exposed because a `hold` whose hold has expired is not a booking, and a program reading reservations has to be able to tell. **Three clocks in one object, and they are not interchangeable.** `startsAt` and `endsAt` are the venue's wall clock wearing a `+00` suffix; `holdExpiresAt` and `createdAt` are true UTC instants. All four serialise identically, so a caller that parses them alike is wrong about some of them by the venue's entire UTC offset. The sharpest edge is `holdExpiresAt`, the one field here meant to be compared against the current real instant. `from` and `to` filter on the same wall clock `startsAt` does. Read the venue's zone from `timezone` on `GET /api/v1/organization`, which needs the separate `organization:read` scope. Three fields are deliberately withheld: the guest's manage token (the whole credential for their self-service link), the venue's private internal note, and the payment processor's identifier.