GET - Get events list

Purpose

This API is used to get a list of all the events in a particular calendar of the user.

Request URL

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

Headers

Accept - application/json+large ( This is used only when event's description is needed in response )

OAuth Scope

scope=ZohoCalendar.event.ALL

(or)

scope=ZohoCalendar.event.READ

ALL - Full access to events

READ - Gets events

Ensure CRM oauthscope is added for CRM Calendar events.

Request Parameters

rangeJSONObject with keys, mandatory
When the "range" parameter is passed, the events that occur between the given start and end dates are retrieved. The JSON Object should contain the start and end parameters in UNIX date-time format. The range period cannot exceed 31 days.
- start - yyyyMMdd"T"HHmmss"Z" or yyyyMMdd(if it is an all-day event).
- end - yyyyMMdd"T"HHmmss"Z" or yyyyMMdd(if it is an all-day event).
byinstance boolean
In "byinstance", all the instances of repeat events will be retrieved as a separate event when it is set as true. This (byinstance) will work only when RANGE value is set.
timezone
To get date time based on a particular timezone.
crm_event_type
- own
- all

Note:

The range cannot exceed 31 days.

When byinstance is set as true, only minimal information about the event will be provided in the response object.

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/calendars/l9WWZCf_SJWcr3uIuBOq5g==/events?range={"start":"20170717","end":"20170723"}

Sample Response

Copied{
    "events": [
        {
            "isprivate": false,
            "enable_eventmanagement": false,
            "role": "participant",
            "attendees": [
                {
                    "email": "ezilkannan.r@zohocorp.com",
                    "status": "DECLINED"
                }
            ],
            "start": "20170718T205000",
            "calid": "1657000000002003",
            "title": "Teast af",
            "createdtime": "20170713T10Z",
            "calendar_alarm": true,
            "duration": 6900000,
            "uid": "05bc508fac974ba4b99f56390137bcb4@zoho.com",
            "createdby": "ezilzcal@gmail.com",
            "organizer": "ezilzcal@gmail.com",
            "isallday": false,
            "end": "20170718T224500",
            "modifiedby": "ezilzcal@gmail.com",
            "etag": 1500358633876,
            "multiday": false,
            "caluid": "l9WWZCf_SJWcr3uIuBOq5g==",
            "dateandtime": {
                "timezone": "Asia/Calcutta",
                "start": "20170718T205000+0530",
                "end": "20170718T224500+0530"
            },
            "lastmodifiedtime": "20170718T061713Z"
        },
        {
            "reminders": [
                {
                    "minutes": "-10",
                    "action": "popup"
                }
            ],
            "enable_eventmanagement": false,
            "role": "organizer",
            "calid": "1657000000002003",
            "title": "Test endured ",
            "calendar_alarm": false,
            "duration": 3600000,
            "uid": "0355da9f49884db8bef8c8f22c976dfc@zoho.com",
            "rrule": "FREQ=WEEKLY;UNTIL=20170830T100100Z;INTERVAL=1;BYDAY=MO,WE,SA",
            "createdby": "ezilkannan.r@zohocorp.com",
            "repeat": [
                {
                    "freq": "weekly",
                    "byday": "MO,WE,SA",
                    "interval": 1,
                    "until": "20170830T100100Z"
                }
            ],
            "alarm": [
                {
                    "action": "popup",
                    "trigger": -600000
                }
            ],
            "end": "20170715T163000",
            "dateandtime": {
                "timezone": "Asia/Calcutta",
                "start": "20170715T153000+0530",
                "end": "20170715T163000+0530"
            },
            "lastmodifiedtime": "20170717T095723Z",
            "isprivate": false,
            "attendees": [
                {
                    "email": "ezilkannan.r@zohocorp.com",
                    "status": "ACCEPTED"
                },
                {
                    "email": "zaheed.shariff@zohocorp.com",
                    "status": "NEEDS-ACTION"
                }
            ],
            "start": "20170715T153000",
            "createdtime": "20170717T09Z",
            "organizer": "ezilkannan.r@zohocorp.com",
            "isallday": false,
            "modifiedby": "ezilkannan.r@zohocorp.com",
            "etag": 1500285443390,
            "multiday": false,
            "caluid": "l9WWZCf_SJWcr3uIuBOq5g=="
        }
    ]
}

Sample Response(byinstance=true):

Copied{
    "events": [
        {
            "isprivate": false,
            "enable_eventmanagement": false,
            "role": "participant",
            "attendees": [
                {
                    "email": "ezilkannan.r@zohocorp.com",
                    "status": "DECLINED"
                }
            ],
            "start": "20170718T205000",
            "calid": "1657000000002003",
            "title": "Teast af",
            "createdtime": "20170713T10Z",
            "calendar_alarm": true,
            "duration": 6900000,
            "uid": "05bc508fac974ba4b99f56390137bcb4@zoho.com",
            "createdby": "ezilzcal@gmail.com",
            "organizer": "ezilzcal@gmail.com",
            "isallday": false,
            "end": "20170718T224500",
            "modifiedby": "ezilzcal@gmail.com",
            "etag": 1500358633876,
            "multiday": false,
            "caluid": "l9WWZCf_SJWcr3uIuBOq5g==",
            "dateandtime": {
                "timezone": "Asia/Calcutta",
                "start": "20170718T205000+0530",
                "end": "20170718T224500+0530"
            },
            "lastmodifiedtime": "20170718T061713Z"
        },
        {
            "reminders": [
                {
                    "minutes": "-10",
                    "action": "popup"
                }
            ],
            "enable_eventmanagement": false,
            "role": "organizer",
            "calid": "1657000000002003",
            "title": "Test endured ",
            "calendar_alarm": false,
            "duration": 3600000,
            "uid": "0355da9f49884db8bef8c8f22c976dfc@zoho.com",
            "rrule": "FREQ=WEEKLY;UNTIL=20170830T100100Z;INTERVAL=1;BYDAY=MO,WE,SA",
            "createdby": "ezilkannan.r@zohocorp.com",
            "repeat": [
                {
                    "freq": "weekly",
                    "byday": "MO,WE,SA",
                    "interval": 1,
                    "until": "20170830T100100Z"
                }
            ],
            "alarm": [
                {
                    "action": "popup",
                    "trigger": -600000
                }
            ],
            "end": "20170715T163000",
            "dateandtime": {
                "timezone": "Asia/Calcutta",
                "start": "20170715T153000+0530",
                "end": "20170715T163000+0530"
            },
            "lastmodifiedtime": "20170717T095723Z",
            "isprivate": false,
            "attendees": [
                {
                    "email": "ezilkannan.r@zohocorp.com",
                    "status": "ACCEPTED"
                },
                {
                    "email": "zaheed.shariff@zohocorp.com",
                    "status": "NEEDS-ACTION"
                }
            ],
            "start": "20170715T153000",
            "createdtime": "20170717T09Z",
            "organizer": "ezilkannan.r@zohocorp.com",
            "isallday": false,
            "modifiedby": "ezilkannan.r@zohocorp.com",
            "etag": 1500285443390,
            "multiday": false,
            "caluid": "l9WWZCf_SJWcr3uIuBOq5g=="
        }
    ]
}