GET - Get calendar details

Purpose

This API retrieves the details of a particular calendar using the Calendar UID.

Request URL

https://calendar.zoho.com/api/v1/calendars/<CALENDAR_UID>|<default>|<primary>

OAuth Scope

scope=ZohoCalendar.calendar.ALL

(or)

scope=ZohoCalendar.calendar.READ

ALL - Full access to calendars

READ - Gets details of a calendar

Path Parameter

calendaruidstring, mandatory
Calendar unique identifier. Calendar UID of the Calendar for which you want to retrieve the details. The possible values are:
- <CALENDARUID> - If you want to get the details of a particular calendar using calendar UID.
- default - If you want to get the default calendar details.
- primary - If you want to get the default calendar details.

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/calendars/<CALENDAR_UID>

Sample Input

Copiedhttps://calendar.zoho.com/api/v1/calendars/9c63034b12fa4f4093a7f8410c3c8b5b

Sample Response

Copied{
    "calendars": [
        {
            "reminders": [
                {
                    "minutes": "-5",
                    "action": "email"
                },
                {
                    "minutes": "-5",
                    "action": "notification"
                },
                {
                    "minutes": "-5",
                    "action": "popup"
                }
            ],
            "color": "#005DE0",
            "timezone": "Asia/Calcutta",
            "textcolor": "#FFFFFF",
            "description": "",
            "privilege": "owner",
            "type": 0,
            "uid": "9c63034b12fa4f4093a7f8410c3c8b5b",
            "canSendMail": true,
            "modifiedtime": 1596099357449,
            "alarm": [
                {
                    "action": "email",
                    "trigger": "-300000"
                },
                {
                    "action": "notification",
                    "trigger": "-300000"
                },
                {
                    "action": "popup",
                    "trigger": "-300000"
                }
            ],
            "allowed_conference": "zmeeting,zoom",
            "isdefault": true,
            "calendar_modifiedtime": 1596099357449,
            "id": "112748000000002003",
            "order": 0,
            "lastmodifiedtime": "20230303T132059Z",
            "owner": "62793585",
            "visibility": true,
            "include_infreebusy": true,
            "createdtime": 1596099357449,
            "calendar_createdtime": 1596099357449,
            "name": "jashan.s",
            "ctag": 1677849659187,
            "category": "own",
            "status": true,
            "caltype": "own"
        }
    ]
}

Show full

Show less