GET - Get resource free busy detail

Purpose

This API retrieves the free/ busy detail of a particular resource. The free/ busy detail of the resource denotes the availability of the resource to book at a particular period of time.

Request URL

https://calendar.zoho.com/api/v1/resources/<resourceuid>/freebusy

OAuth Scope

scope=ZohoCalendar.resources.ALL

or

scope=ZohoCalendar.resources.READ

 

ALL - Access all features.

READ - Gets free/ busy detail of a resource

Path Parameters

  • resourceuIdlong, mandatory
    • It is a unique ID that's assigned to each feature when you add them to resource booking.
    • It is the value of "auto_gen_name" in add/ get resource response.

Request Parameters

  • start_datestring, mandatory
    • The start date string denotes the starting date from when you want the free-busy data.
    • Supported date format - MM/dd/yyyy
  • end_datestring, mandatory
    • The end date string denotes the ending date until when you want the free-busy data.
    • Supported date format - MM/dd/yyyy
  • timezonestring, optional
    • The timezone in which the branch is located.

Note: The time difference between the start and end date should not exceed the "Booking duration" set in Resource booking settings by the Admin.

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/resources/6877cf8fb6c14a73931284fff462e2a4/freebusy?start_date=05/01/2022&end_date=07/01/2022&timezone=Asia/Kolkata

Sample Response

Copied{
   "range":"20220501_20220701","1599569701214000001":
   {
      "20220505":
      [
         {
            "end_date":"20220505",
            "start_time":"1415",
            "timezone":"Asia/Kolkata",
            "all_day":false,
            "end_time":"1430",
            "start_date":"20220505"
         },
         {
            "end_date":"20220505",
            "start_time":"1245",
            "timezone":"Asia/Kolkata",
            "all_day":false,
            "end_time":"1300",
            "start_date":"20220505"
         }
      ],
      "20220504":
         [
            {
               "end_date":"20220504",
               "start_time":"2215",
               "timezone":"Asia/Kolkata",
               "all_day":false,
               "end_time":"2230",
               "start_date":"20220504"
              }
           ]
      }
}