​

GET - Get bookings list

Purpose

This API is used to retrieve a list of all the bookings.

Request URL

https://calendar.zoho.com/api/v1/bookings/list

OAuth Scope

scope=ZohoCalendar.bookings.ALL

or

scope=ZohoCalendar.bookings.READ

​

ALL - Access to all bookings

READ - Gets the list of all bookings

Request Parameters

  • startDatestring, mandatory
    • The start date from which the bookings should be retrieved. The supported date format is MM/DD/YYY.
  • endDatestring, mandatory
    • The end date up to which the bookings should be retrieved. The supported date format is MM/DD/YYY.
  • branch_idlong, mandatory
    • The branch ID of the branch for which the bookings should be retrieved. The branch id can be fetched using the Get all branches API.
  • resourcesJSONArray, mandatory
    • The rooms available in the particular branch as ZRB_stringarrayJson for which the booking details should be retrieved.
  • timezonestring, optional
    • The time zone of the location where the branch is located.

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/bookings/list?startDate="08/07/2020"&branch_id="1587118394614000006"&resources="["1587118423362000034"]"

Sample Response

Copied{
   "MULTIDAY_BOOKINGS":{},
   "BOOK_CNT_OBJ":
   {
      "20200612_20200612_1591704355298000001":1
   },
      "1591704355298000001":
   {
      "20200612":[
   {
      "end_date":"20200612",
      "isprivate":false,
      "role":"organizer",
      "is_member":true,
      "timezone":"Asia/Calcutta",
      "end_time":"0930",
      "title":"Single booking",
      "booking_id":"1591704373193000001",
      "isbreak":true,
      "start_time":"0900",
      "bookedby_email":"elango@m43.com",
      "booked_by":"61129777",
      "is_own_booking":true,
      "all_day":false,
      "start_date":"20200612"
      }
      ]
   },
   "resources":[
   {
      "building_id":"1587539132404000002",
      "category_name":"Meeting Room",
      "resource_type":0,
      "is_hidden":false,
      "res_email_id":"d55b2f2457ed4d05ad1cddf6576bf107@m43.com",
      "resource_approval":false,
      "auto_gen_name":"d55b2f2457ed4d05ad1cddf6576bf107",
      "capacity":12,"is_available":true,"has_image":false,
      "branch_id":"1587539132390000001",
      "resource_id":"1591704355298000001",
      "floor_id":"1587539132413000003",
      "resource_name":"Single booking",
      "category":0
      }
      ],
      "range":"20200604_20200704"
}