GET - Get all resources

Purpose

This API retrieves the details of all the resources available in resource booking. To pick the resources you should provide either the branch id, building id, or floor id. You can also provide all three IDs. The IDs can be fetched using the GET branch API.

Request URL

https://calendar.zoho.com/api/v1/resources

OAuth Scope

scope=ZohoCalendar.resources.ALL

or

scope=ZohoCalendar.resources.READ

 

ALL - Access to all resources

READ - Gets details of all resources

Request Parameters

  • branchIdlong, mandatory
    • The branch ID can be fetched by using the Get Branch list API.
  • buildingIdlong, mandatory
    • The building ID can be fetched by using the Get Branch list/ Get Branch info API.
  • floorIdlong, mandatory
    • The floor ID can be fetched by using the Get Branch info API.
  • showHiddenboolean, optional
    • The boolean value true/ false should be given to fetch the hidden/ available resources.
    • Use the value:
      • true - To fetch the hidden resources.
      • false - To fetch the unhidden/ available resources.
    • This parameter is not required if you want to fetch all the resources.
  • isCurTimeboolean, optional
    • The boolean value true/ false should be given to fetch/ not fetch the real-time data at which the resource details are fetched.
    • The current time data will be fetched in the format of yyyyMMddHHmm (yyyy - Year, MM - Month, dd - Date, HH - Hours, mm - Minutes)

​Note: Any one of the parameters marked mandatory must be given to fetch the resource detail.

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/resources?branchId=1587539132390000001&showHidden=false&isCurTime=true

Sample Response

Copied{
"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":13,
      "is_available":true,
      "image_name":"Room.jpg",
      "has_image":true,
      "branch_id":"1587539132390000001",
      "qr_code_id":"1666247426668000002",
      "resource_id":"1591704355298000001",
      "location":"Ground Floor,Building 1,Trichy",
      "floor_id":"1587539132413000003",
      "resource_name":"Single booking",
      "category":0,
      "image_id":"1666247426603000001"
    }
  ],
"current_time":"202210201201"
}

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/resources?branchId=1587539132390000001&showHidden=false

Sample Response

Copied[
  {
  "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":13,
  "is_available":true,
  "image_name":"Room.jpg",
  "has_image":true,
  "branch_id":"1587539132390000001",
  "qr_code_id":"1666247426668000002",
  "resource_id":"1591704355298000001",
  "location":"Ground Floor,Building 1,Trichy",
  "floor_id":"1587539132413000003",
  "resource_name":"Single booking",
  "category":0,
  "image_id":"1666247426603000001"
  }
]