Endpoints
Bookings & availability
Appointments, free slots and the service catalog. Writes follow the same availability rules as the in-app Calendar.
Pfade sind relativ zur Basis-URL. Jede Karte zeigt die Berechtigung, die der Aufruf braucht, und jeden Parameter mit Typ und Grenzen.
/bookingsList bookings, newest first.
Query-Parameter
- fromoptionalstring (ISO 8601 date-time with offset)
Bookings that start at or after this time.
- tooptionalstring (ISO 8601 date-time with offset)
Bookings that start at or before this time.
- statusoptionalstring
Comma-separated list of statuses.
Erlaubte Werte:
pendingconfirmedcompletedno_showcancelledpending_completion - contact_idoptionalinteger
Bookings of this contact.
- serviceoptionalstring
Service name (case-insensitive).
- service_idoptionalinteger
Bookings linked to this service.
/bookings/:idRetrieve a booking.
Pfadparameter
- iderforderlichinteger
Booking ID.
/bookingsBook an appointment for a contact.
JSON-Body
- contact_iderforderlichinteger
The customer. Name and phone come from the contact unless you override them.
- date_timeerforderlichstring (ISO 8601 date-time with offset)
Start time.
- duration_minutesoptionalinteger
5–1,440. Defaults to the service duration, else 60.
- service_idoptionalinteger
A service from GET /services.
- service_typeoptionalstring
Service name, up to 200 characters. Defaults to the service title.
- locationoptionalstring
Up to 300 characters.
- location_idoptionalinteger
A business location.
- notesoptionalstring
Up to 5,000 characters. Added to the booking notes.
- statusoptionalenum
Default "pending".
Erlaubte Werte:
pendingconfirmedcompletedno_show - conversation_idoptionalinteger
Link the booking to a conversation.
- customer_nameoptionalstring
Override the contact name, 1–200 characters.
- customer_phoneoptionalstring
Override the contact phone, 3–50 characters.
- slot_tokenoptionalstring
The slot_token of a slot from GET /availability/slots.
- override_availabilityoptionalboolean
Skip the availability check, like a manual entry in the Calendar.
- Answers 201 with the booking.
/bookings/:idChange booking details. A new date_time reschedules it.
Pfadparameter
- iderforderlichinteger
Booking ID.
JSON-Body
- date_timeoptionalstring (ISO 8601 date-time with offset)
New start time.
- duration_minutesoptionalinteger
5–1,440.
- service_idoptionalinteger | null
A service from GET /services.
- service_typeoptionalstring | null
Up to 200 characters.
- locationoptionalstring
Up to 300 characters.
- location_idoptionalinteger
A business location.
- notesoptionalstring
Up to 5,000 characters. Added as a new note.
- statusoptionalenum
New status.
Erlaubte Werte:
pendingconfirmedcompletedno_showcancelled - customer_nameoptionalstring
1–200 characters.
- customer_phoneoptionalstring
3–50 characters.
- slot_tokenoptionalstring
The slot_token of the new slot.
- override_availabilityoptionalboolean
Skip the availability check.
- Send at least one field besides slot_token, override_availability and location_id.
/bookings/:id/cancelCancel a booking. Cancelling an already cancelled booking returns it unchanged.
Pfadparameter
- iderforderlichinteger
Booking ID.
JSON-Body
- reasonoptionalstring
Up to 1,000 characters, saved as a booking note.
/bookings/:id/statusSet the booking status.
Pfadparameter
- iderforderlichinteger
Booking ID.
JSON-Body
- statuserforderlichenum
New status.
Erlaubte Werte:
confirmedcompletedno_showpending
/availability/slotsList bookable slots on one day. Each slot has start, end and slot_token.
Query-Parameter
- dateerforderlichstring (YYYY-MM-DD)
The day to check.
- service_idoptionalinteger
Use this service's duration and rules.
- durationoptionalinteger
Slot length in minutes, 5–1,440.
- location_idoptionalinteger
A business location.
- granularityoptionalinteger
Minutes between slot starts, 5–120.
- exclude_booking_idoptionalinteger
Ignore this booking (when rescheduling it).
/servicesList business services (name, duration, price, category).
/services/:idRetrieve a service.
Pfadparameter
- iderforderlichinteger
Service ID.