​

GET - Get branch list

Purpose

This API is used to get the list of the branches available in an organization in Resource Booking. The data fetched using this API can be used to update, or delete a branch, or to fetch the details of a particular branch.

Request URL

​https://calendar.zoho.com/api/v1/branches

OAuth Scope

scope=ZohoCalendar.branches.ALL

or

scope=ZohoCalendar.branches.READ

 

ALL - Full access to all branches

READ - Gets the list of branches

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/branches

Sample Response

Copied[
    {
        "work_end_hour": "07:00 pm",
        "branch_id": "1544508945254010001",
        "branch_name": "Estancia India",
        "work_start_day": 1,
        "buildings": [
            {
                "building_id": "1544508945311010002",
                "building_name": "Woodlands",
                "floors": [
                    {
                        "floor_name": "Floor - 1",
                        "floor_order": 2,
                        "floor_id": "1544508945312010004"
                    },
                    {
                        "floor_name": "Floor - 2",
                        "floor_order": 3,
                        "floor_id": "1544508945312010005"
                    },
                    {
                        "floor_name": "Ground Floor",
                        "floor_order": 1,
                        "floor_id": "1544508945311010003"
                    }
                ],
                "branch_id": "1544508945254010001",
                "floor_count": 0
            },
            {
                "building_id": "1544527711824010006",
                "building_name": "Tower",
                "floors": [
                    {
                        "floor_name": "Ground Floor",
                        "floor_order": 1,
                        "floor_id": "1544527711823010001"
                    },
                    {
                        "floor_name": "Floor - 3",
                        "floor_order": 4,
                        "floor_id": "1544527711824010004"
                    },
                    {
                        "floor_name": "Floor - 4",
                        "floor_order": 5,
                        "floor_id": "1544527711824010005"
                    },
                    {
                        "floor_name": "Floor - 2",
                        "floor_order": 3,
                        "floor_id": "1544527711824010003"
                    },
                    {
                        "floor_name": "Floor - 1",
                        "floor_order": 2,
                        "floor_id": "1544527711823010002"
                    }
                ],
                "branch_id": "1544508945254010001",
                "floor_count": 0
            },
            {
                "building_id": "1545111379199010003",
                "building_name": "Plaza block",
                "floors": [
                    {
                        "floor_name": "Floor - 2",
                        "floor_order": 3,
                        "floor_id": "1545122861351010001"
                    },
                    {
                        "floor_name": "Ground Floor",
                        "floor_order": 1,
                        "floor_id": "1545111379198010001"
                    },
                    {
                        "floor_name": "Floor - 1",
                        "floor_order": 2,
                        "floor_id": "1545111379199010002"
                    }
                ],
                "branch_id": "1544508945254010001",
                "floor_count": 0
            }
        ],
        "work_start_hour": "10:00 am",
        "time_zone": "Asia/Calcutta",
        "work_end_day": 5
    }
]