v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

List all appointments of a guest

Provide unique identifier of the guest as guest_id and this api will retrieve the appointment history of the respective guest.

This API also allows guests to view the appointment details of other guests, provided they have a relationship defined in Zenoti. Also, only a host guest token can view another guest's appointment details.

get/v1/guests/{guest_id}/appointments?page={page}&size={size}&start_date={start_date}&end_date={end_date}

Path parameters

guest_idstring required

Unique 32-character identifier of the guest.

Query parameters

pageinteger

Results page containing all appointments of the guest.

sizeinteger

Number of records to be displayed on a page. Default value is 10.

start_datestring date

end_datestring date

Response

200

Example response

{
  "appointments": [
    {
      "appointment_group_id": "f4ffc350-f433-47be-bdee-6798bb5a5ebd",
      "no_of_guests": 1,
      "invoice_id": "f0d17b47-aee6-477d-ae92-e160280e8d89",
      "invoice_status": 4,
      "is_rebooking": true,
      "center_id": "03ff6a3b-0bf9-48b7-b01d-cc1a02cfa97c",
      "appointment_services": [
        {
          "appointment_id": "3a546747-4d2e-4c81-ab19-2ea1800d9567",
          "invoice_item_id": "a29a1373-a049-452f-aaae-7800fa26a0df",
          "cart_item_id": "88f95004-63d8-4d9d-af43-940d3a4cd5d0",
          "service": {
            "id": "2a4f932e-d3fd-41c8-9c4e-79cfb73e7413",
            "name": "Hair cut 1",
            "duration": 30
          },
          "start_time": "2019-08-29T10:45:00",
          "end_time": "2019-08-29T11:15:00",
          "appointment_status": 1,
          "requested_therapist_id": "b171bef9-c73b-49ca-8e34-a67b32739ec9",
          "service_custom_data_indicator": "1#1#0#0#0#1#0#0",
          "has_service_form": true
        }
      ],
      "is_feedback_submitted": true
    }
  ],
  "page_info": {
    "total": 7,
    "page": 1,
    "size": 10
  }
}