ZenotiHelp

Queue API endpoints

ZTZenoti Docs Team Updated September 12, 2026 2 min readGuide

Use the queue API endpoints to integrate external systems with Zenoti's queue functionality, enabling programmatic access to appointment slots, wait times, and booking operations.

Before you begin

  • Your organization must have the queue feature enabled.
  • You need one of the following permissions:

Permission: Add Appointment (under Appointments) β€” Required to create queue bookings via API.

Permission: Edit Appointment (under Appointments) β€” Required to modify queue appointments via API.

Permission: View Appointment (under Appointments) β€” Required to retrieve queue information via API.

  • API endpoints support both staff authentication and guest token access for kiosk integration.
  • Maximum of 50 center IDs can be queried in a single request for wait times.

Steps

Get available appointment slots

Use the available times endpoint to retrieve open slots for queue booking.

  1. Send a POST request to v1/queue/available_times.
  2. Include the following parameters in your request:
  • Center ID β€” The center where you want to check availability.
  • Service ID β€” The service for which you need available slots.
  • Date range β€” Start and end dates for availability search.
  1. Review the response data:
  • Provider details β€” Information about available providers for each slot.
  • Slot time β€” Appointment time displayed in the center's timezone.
  • Wait time β€” Estimated wait time in minutes (optional).

Check center wait times

Use the wait times endpoint to retrieve current wait times across multiple centers.

  1. Send a POST request to v1/queue/center_wait_times.
  2. Choose one of these query methods:
  • Center ID list β€” Provide up to 50 specific center IDs.
  • Geolocation search β€” Include latitude, longitude, and search distance (0-50 km, default 20 km).
  1. Review the response for each center:
  • Center status β€” "Open", "Busy", or "Closed".
  • Current wait time β€” Estimated wait time in minutes.
  • Center details β€” Basic center information and contact details.

Create queue bookings

Use the bookings endpoint to reserve and confirm appointment slots in a single operation.

  1. Send a POST request to v1/queue/bookings.
  2. Include the required booking details:
  • Guest information β€” Guest ID or new guest details.
  • Service details β€” Service ID, provider preference, and appointment time.
  • Center ID β€” The center where the appointment will take place.
  1. Configure optional settings:
  • DoReprocess flag β€” Set to true to trigger automatic queue reprocessing after booking.
  • Appointment reminders β€” Enable automatic reminder notifications.

Note: The system automatically:

  • Creates the invoice for the appointment.
  • Triggers appointment creation events.
  • Sends real-time notifications to queue displays.
  • Adds the appointment to the center's queue.

Retrieve current queue status

Use the queue endpoint to get the current queue for a center.

  1. Send a GET request to v1/queue.
  2. Include the center ID as a parameter.
  3. Apply optional filters:
  • Guest ID filter β€” Show appointments for a specific guest only.
  • Group booking expansion β€” Include related appointments in group bookings.
  1. Review the filtered results:
  • Excludes appointments with Break or NotSpecified status.
  • Filters out orphaned add-on appointments.
  • Shows current queue position and estimated wait times.

Tips

  • Use the DoReprocess flag when creating bookings to ensure accurate wait time calculations for subsequent API calls.
  • For kiosk integration, guest tokens provide limited access without requiring staff authentication.
  • Geolocation-based wait time queries help guests find the nearest center with the shortest wait.
  • The available times endpoint considers provider schedules, existing appointments, and queue capacity when calculating availability.
Was this article helpful?
Your feedback helps us improve our documentation.