Get Appointment
Table of Contents
Purpose
To get details of an appointment.
Request URL
https://www.zohoapis.com/bookings/v1/json/getappointment
Headers
| Parameter Name | Description |
|---|---|
| Authorization | Zoho-oauthtoken {{accesstoken}} |
Note: The access token can be generated from the developer console.
Request Method
GET
Parameters
Parameters to be passed with the request URL are,
| Parameter Name | Description |
|---|---|
| booking_id * | The unique id of the previously booked appointment |
Note: fields marked * are mandatory.
Response Type
JSON
API Limits
| Zoho Bookings Plan/Edition | Number of API calls/day |
| Free | 250/per user |
| Basic | 1000/per user |
| Premium | 3000/per user |
| Zoho One | 3000/per user |
Note: The API limits are excluding the authorization requests. API counts are calculated between 00:00 and 23:59 hours in the respective time zones.
Related Links
Sample Request
Copiedcurl --location --request GET 'https://www.zohoapis.com/bookings/v1/json/getappointment?booking_id=#AN-00014' \
--header 'Authorization: Zoho-oauthtoken 1000.7b3610d1XXXXXXXXXXXXXXXX087cc3.6282226f615637c467bee7209ce1c0a1'Sample Response
Copied{
"response": {
"returnvalue": {
"staff_name": "Staff 1",
"customer_more_info": {},
"customer_booking_start_time": "2019-05-28 13:00:00",
"customer_contact_no": "123456",
"booked_on": "2019-05-28 10:47:03",
"booking_id": "#AN-00014",
"workspace_id": "3848021000000027004",
"duration": "30 mins",
"service_id": "3848021000000027083",
"staff_id": "3848021000000027052",
"cost_paid": "0.00",
"currency": "INR",
"workspace_name": "Chennai",
"cost": "0.00",
"service_name": "Meeting",
"time_zone": "Asia/Calcutta",
"start_time": "28-May-2019 13:00:00",
"due": "0.0",
"customer_email": "john@zylker.com",
"booking_type": "appointment",
"customer_name": "Anu",
"summary_url": "https://john.zohobookings.com/#/customer/john/invoice/LI8VujFVTFsz9q2o3sh1I%2Bep1hxEFxhfH9Lr2CsEesFXLc%2FxHtB1tBapl4Qp5Cf5",
"customer_booking_time_zone": "Asia/Calcutta",
"status": "upcoming"
},
"logMessage": [],
"status": "success"
}
}
A Collective booking response will also include the following parameters:
"co_hosts": [
{
"staff_name": "Ryan",
"staff_contact_number": "9222222222",
"staff_email": "ryan.jones@zylker.com"
},
{
"staff_name": "Ashton",
"staff_contact_number": "9111111111",
"staff_email": "ashton.prince@zylker.com"
}
]