GET - Get calendar list

Purpose

This API is used to get the list of all calendars or list of calendars based on a specific category/entity of a given user.

Request URL

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

OAuth Scope

scope=ZohoCalendar.calendar.ALL

(or)

scope=ZohoCalendar.calendar.READ

​

ALL - Full access to calendars

READ - Gets list of calendars

Parameters

  • Categorystring

    Get calendars based on a particular category. Calendar category values are:

    • own
    • group
    • app
    • others
    • all

    Note: If the category is not mentioned, you will get all your own calendars.

  • showhiddencalboolean

    Choose whether the hidden calendars need to be shown.

    • True - to show the hidden calendar
    • False - to skip the hidden calendar (default)

Sample Request

Copiedhttp://calendar.zoho.com/api/v1/calendars

Sample Input

Copiedhttps://calendar.zoho.com/api/v1/calendars?category=own&showhiddencal=true

Sample Response

Copied{
    "calendars": [
        {
            "reminders": [
                {
                    "minutes": "-15",
                    "action": "email"
                }
            ],
            "color": "#8cbf40",
            "timezone": "Asia/Calcutta",
            "textcolor": "#FFFFFF",
            "description": "",
            "privilege": "owner",
            "type": 0,
            "calemptiedtime": "20230316T052733Z",
            "uid": "1683be4ab6c74d2ab02e6450a0b34d4a",
            "canSendMail": true,
            "modifiedtime": 1663320706496,
            "alarm": [
                {
                    "action": "email",
                    "trigger": "-900000"
                }
            ],
            "isdefault": true,
            "calendar_modifiedtime": 1663320706496,
            "id": "310935000000002003",
            "order": 0,
            "lastmodifiedtime": "20230316T092945Z",
            "owner": "70421274",
            "visibility": true,
            "include_infreebusy": true,
            "createdtime": 1663320706496,
            "calendar_createdtime": 1663320706496,
            "name": "user",
            "ctag": 1678958985948,
            "category": "own",
            "status": true,
            "caltype": "own"
        },
        {
            "color": "#EB0000",
            "timezone": "Asia/Calcutta",
            "textcolor": "#FFFFFF",
            "description": "",
            "privilege": "owner",
            "type": 0,
            "uid": "8941441f4e3140e8b48bdf9bb3a1f7af",
            "canSendMail": true,
            "modifiedtime": 1674117865556,
            "isdefault": false,
            "calendar_modifiedtime": 1674117865556,
            "id": "310935000000052005",
            "order": 1,
            "lastmodifiedtime": "20230306T092323Z",
            "owner": "70421274",
            "visibility": true,
            "include_infreebusy": false,
            "createdtime": 1671083856866,
            "calendar_createdtime": 1671083856866,
            "name": "new calendar",
            "ctag": 1678094603679,
            "category": "own",
            "status": true,
            "caltype": "own"
        },
        {
            "color": "#8cbf40",
            "timezone": "Asia/Calcutta",
            "textcolor": "#FFFFFF",
            "description": "",
            "privilege": "owner",
            "type": 0,
            "uid": "66e82e905c81428aa843006f4385f592",
            "canSendMail": true,
            "modifiedtime": 1674116995358,
            "isdefault": false,
            "calendar_modifiedtime": 1674116995358,
            "id": "310935000000078001",
            "order": 2,
            "lastmodifiedtime": "20230120T052451Z",
            "owner": "70423274",
            "visibility": true,
            "include_infreebusy": false,
            "createdtime": 1674116962474,
            "calendar_createdtime": 1674116962474,
            "name": "new 2 edited",
            "ctag": 1674192291367,
            "category": "own",
            "status": true,
            "caltype": "own"
        },
        {
            "color": "#A514D8",
            "timezone": "Asia/Calcutta",
            "textcolor": "#FFFFFF",
            "description": "",
            "privilege": "owner",
            "type": 0,
            "uid": "d7c153468f5c4ba19b6926796fdef9e4",
            "canSendMail": true,
            "modifiedtime": 1674473723258,
            "isdefault": false,
            "calendar_modifiedtime": 1674473723258,
            "id": "310935000000082005",
            "order": 3,
            "lastmodifiedtime": "20230214T055837Z",
            "owner": "70423274",
            "visibility": true,
            "include_infreebusy": false,
            "createdtime": 1674473668980,
            "calendar_createdtime": 1674473668980,
            "name": "Test Subscribe private",
            "ctag": 1676354317170,
            "category": "own",
            "status": true,
            "caltype": "own"
        },
        {
            "color": "#8cbf40",
            "timezone": "Asia/Calcutta",
            "textcolor": "#FFFFFF",
            "description": "",
            "privilege": "owner",
            "type": 0,
            "uid": "46d3aef248384773b1649360152a44eb",
            "canSendMail": true,
            "modifiedtime": 1678946331370,
            "isdefault": false,
            "calendar_modifiedtime": 1678946331370,
            "id": "310935000000136011",
            "order": 5,
            "lastmodifiedtime": "20230214T055915Z",
            "owner": "70421274",
            "visibility": false,
            "include_infreebusy": false,
            "createdtime": 1678946331370,
            "calendar_createdtime": 1678946331370,
            "name": "Hidden calendar",
            "ctag": 1676354355042,
            "category": "own",
            "status": true,
            "caltype": "own"
        }
    ]
}