Sign in

v1

latestOpenAPI 3.1.02026-07-2422707.0 MB

Retrieve the list of appointments of a center

This API retrieves the list of all appointments of the specified center between the start date and end date.

You must provide appropriate details for the center_id, start_date, and end_date parameters. Optionally, you can also specify the details for the include_no_show_cancel and therapist_id parameters to filter the results.

The difference between the start_date and end_date cannot be more than seven days. The response also includes block-out times.

get/v1/appointments

Query parameters

center_idstring required

Mandatory Unique 32-character identifier of the center.

start_datestring date required

Mandatory Format: YYYY-MM-DD Retrieves the appointments that have appointment start date as the specified start_date. Note: start_date and end_date must be different. Default appointment start time value: 00:00:00

end_datestring date required

Mandatory Format: YYYY-MM-DD Retrieves the appointments that have appointment start date before the specified end_date (exclusive of end_date). For example, if you specify start_date as 2020-08-03 and end_date as 2020-08-04, this API will retrieve the list of appointments for only Aug 3, 2020. Note: start_date and end_date must be different. Default appointment end time value: 00:00:00

include_no_show_cancelboolean

Optional If true, the API includes the appointments that have status as No Show and Cancel in the response. If it is not passed by default, value will be set as false.

therapist_idstring

Optional Unique identifier of the therapist. If passed, the API retrieves appointments of a particular therapist; else, the API retrieves appointments of all therapists.

Response

200

OR

Example response

[
  {
    "appointment_id": "bcffd302-976b-4c88-878b-835a40093541",
    "appointment_group_id": "f42b502a-2b87-4ea3-863a-99fa2c790651",
    "invoice_id": "e338dd15-ba6e-4dac-a32d-55f8975636cd",
    "service": {
      "id": "151579b2-70f6-42ad-9b83-a2d735fcf645",
      "name": "15 minutes",
      "has_addons": true,
      "business_unit": {
        "guid": "9af1b5a3-d907-4f4a-b410-5e1316f3d5c4",
        "name": "Default",
        "id": 237
      },
      "category": {
        "id": "517ff077-1210-4f17-ad9a-c386e2c701aa",
        "name": "Massages"
      },
      "sub_category": {
        "id": "21077983-1e94-4f46-9a08-c7676819c65b",
        "name": "Feet Massage"
      },
      "override_product_consumption": true,
      "override_default_product_consumption": true
    },
    "start_time": "2019-09-15T05:00:00",
    "start_time_utc": "2019-09-15T09:00:00",
    "end_time": "2019-09-15T05:15:00",
    "end_time_utc": "2019-09-15T09:15:00",
    "guest": {
      "id": "201416e7-add8-4093-968b-a4d878a6842f",
      "first_name": "Kirity",
      "last_name": "Chennai1",
      "mobile": {
        "display_number": "+91 9885517727"
      },
      "email": "kirityg@zenoti.com",
      "indicator": "1@2@0@1@0@0@0@1@1@0@0@0@2@0",
      "lp_tier_info": "0@x"
    },
    "therapist": {
      "id": "0c82f23e-9953-47bb-a587-aa3251c1c8c7",
      "first_name": "Biometric1",
      "last_name": "emp1",
      "email": "be1@em.com",
      "gender": 1
    },
    "service_custom_data_indicator": "1#1#0#0#0#1#1",
    "form_id": "24c77db7-aadf-4cd3-9c1a-b74179a009bb",
    "creation_date": "2019-03-12T03:30:00",
    "creation_date_utc": "2019-03-12T07:30:00",
    "created_by_id": "5b2a4f2a-489b-45bf-9fc7-b2d413c2870b",
    "show_in_calender": 1,
    "selected_time": "0001-01-01T00:00:00"
  }
]