Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the list of all appointments in queue

Purpose: Use this API to list all the appointments in your queue.

You must specify center_id to list all the appointments in a queue for a center. Optionally, you can also add guest_id to show all the appointments in queue for a guest of a center.

Example: GET: http://{apiurl}/v1/queue?CenterId={center_id}&GuestId={guest_id}

get/v1/queue?CenterId={center_id}

Query parameters

center_idstring required

Unique identifier of the center.

guest_idstring

Optional - Unique identifier of the guest.

Response

200

OR
OR

Example response

{
  "queue": [
    {
      "order": 1,
      "preferred_time": "2022-10-05T06:50:00",
      "appointment": {
        "id": "f960b3b1-e21f-4305-bd3b-13d3cfa120e4",
        "booking_type": "SingleBooking",
        "group_id": "44d7ca72-3473-45fe-9aa1-079d891eb255",
        "status": 2,
        "progress": 1,
        "invoice_id": "1032cd7b-54f2-4306-b14e-5e346f825c34",
        "price": 1000,
        "start_time_in_center": "2022-10-05T12:20:00",
        "end_time_in_center": "2022-10-05T12:55:00",
        "checkin_time_in_center": "2022-10-05T12:06:20",
        "actual_start_time_in_center": "2022-10-05T12:06:35.21",
        "service": {
          "id": "25ca3dc0-92cd-4f00-b337-48110ee0916e",
          "name": "Aroma Facial",
          "duration": 35
        }
      },
      "guest": {
        "id": "d73f6551-8b9e-409a-81c8-ba7f2ce7ca84",
        "first_name": "email",
        "last_name": "email",
        "phone": "+91 987654321",
        "email": "swatim@zenoti.com"
      },
      "employee": {
        "id": "ead03cb7-7e2d-4e51-b169-69fe25e318b2",
        "gender": "Any",
        "first_name": "Apurva",
        "last_name": ".",
        "preference_type": "Any"
      }
    }
  ],
  "wait_time_new_guest": "1"
}