​

GET - Get all user settings

Purpose

This API fetches all the users' settings available in Resource Booking. This API can be used only by the organization admin.

Request URL

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

OAuth Scope

scope=ZohoCalendar.usersettings.ALL

or

scope=ZohoCalendar.usersettings.READ

 

ALL - Access to all user settings

READ - Gets details of user settings

Request Parameters

  • branchIdlong, optional
    • The branch ID can be fetched by using the Get Branch list API.
  • buildingIdlong, optional
    • The building ID can be fetched by using the Get Branch list/ Get Branch info API.
  • floorIdlong, optional
    • The floor ID can be fetched by using the Get Branch info API.

Note: Any one of the parameters is mandatory while fetching the users' settings.

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/users?branchId=1587118394609000002

Sample Response

Copied{
   "users":
   [
      { 
      "building_id":"1587118394618000011",
      "branch_id":"1587118394609000002",
      "add_to_cal":false,
      "view_in_tz":false,
      "floor_id":"1587118394619000012",
      "any_time":true,
      "default_view":0,
      "show_week_ends":true,
      "email":"cal1@m43.com",
      "zuid":"61130355"
      },
      {
         "building_id":"1587118394618000011",
         "branch_id":"1587118394609000002",
         "add_to_cal":true,
         "view_in_tz":false,
         "floor_id":"1587118394619000012",
         "any_time":true,
         "default_view":0,
         "show_week_ends":true,
         "email":"cal11@m43.com",
         "zuid":"61382769"
      }
   ]
}