Use appointment APIs
The appointment APIs let you manage the appointment lifecycle after a booking is confirmed: listing appointments, checking guests in and out, starting and completing services, marking no-shows, and undoing status changes.
For complete endpoint documentation including request/response schemas and code examples, see the individual API reference articles linked below.
On this page
- Before you begin
- List and retrieve appointments
- Check-in and check-out
- Appointment progress
- No-show and confirmation
- Related articles
Before you begin
- You need a valid API key or access token. See Set up API authentication.
- Appointments must be created through the service booking workflow before they can be managed.
Permission: Manage API Keys (under Administrator) -- Required to access Zenoti APIs.
List and retrieve appointments
List all appointments of a center
GET /v1/appointments
Retrieves all appointments for a center within a date range. Date range cannot exceed 7 days. Results include blockout times.
| Parameter | Type | Required | Description |
|---|---|---|---|
| center_id | guid | Yes | Center identifier |
| start_date | datetime | Yes | Start date (max 7-day range) |
| end_date | datetime | Yes | End date |
| include_no_show_cancel | boolean | No | Include no-show and cancelled appointments |
| therapist_id | guid | No | Filter by therapist |
Response: Array of appointments with guest (name, contact, gender, loyalty tier), appointment_id, appointment_group_id, invoice_id, start_time, end_time, status, progress, source, service (name, category, add-ons), therapist, room, equipment, notes, and check-in and completion timestamps.
Retrieve appointment details
GET /v1/appointments/{appointment_id}
Retrieves full details of a specific appointment.
| Parameter | Type | Required | Description |
|---|---|---|---|
| appointment_id | guid | Yes | Appointment identifier |
Response: Full appointment details including service, guest, therapist, room, status, progress, notes, checkin_time, and created_by_id.
Check-in and check-out
Check in an appointment
PUT /v1/appointments/{appointment_group_id}/check_in
Marks an appointment as checked in when the guest arrives. Supports self check-in from consumer mobile apps and custom webstores.
| Parameter | Type | Required | Description |
|---|---|---|---|
| appointment_group_id | string | Yes | Appointment group identifier |
Response: success (boolean).
Undo check-in
PUT /v1/appointments/{appointment_group_id}/undo_check_in
Reverses a checked-in appointment back to its previous status.
| Parameter | Type | Required | Description |
|---|---|---|---|
| appointment_group_id | string | Yes | Appointment group identifier |
Response: success (boolean).
Appointment progress
Update appointment progress
PUT /v1/appointments/{appointment_id}/progress
Updates the progress of an appointment to start, open, or complete.
| Parameter | Type | Required | Description |
|---|---|---|---|
| appointment_id | string | Yes | Appointment identifier |
| progress | string | Yes | start, open, or complete |
Use this endpoint to:
- Start a service when the therapist begins
- Complete a service when the therapist finishes
- Undo complete by setting progress back to
openorstart
No-show and confirmation
Mark as no-show
PUT /v1/appointments/{appointment_group_id}/no_show
Marks a scheduled appointment as no-show when a guest fails to appear.
| Parameter | Type | Required | Description |
|---|---|---|---|
| appointment_group_id | string | Yes | Appointment group identifier |
| comments | string | No | Reason for no-show |
Response: success, is_charge_applied (whether a no-show fee was assessed).
Confirm or undo confirm a visit
PUT /v1/invoices/{invoice_id}/confirm
Confirms an appointment visit or undoes a previous confirmation.
| Parameter | Type | Required | Description |
|---|---|---|---|
| invoice_id | string | Yes | Invoice identifier |
| undo_confirm | boolean | No | Set to true to undo confirmation |