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/<calendaruid>/events
OAuth Scope
scope=ZohoCalendar.event.ALL
(or)
scope=ZohoCalendar.event.READ
ALL - Full access to events
READ - Gets events
Request Parameters
Parameter | Type | Description |
---|---|---|
calendaruid* | string | Calendar Unique Identifier. The calendar for which the events list should be retrieved. |
lastmodified | string | To get the events which were modified or created after the given "last modified" time.The lastmodified time should be passed in UNIX time format (yyyyMMdd'T'HHmmss'Z') |
entityid | string | To retrieve certain calendars based on the entity, pass the entity id of the calendar. Entity values are:
|
range | JSONObject | When the "range" parameter is passed, the events which 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.
|
showhiddencal | boolean | In case the calendar being retrieved is hidden, the value should be set to true to retrieve the event details in a hidden calendar. The default value is false. If the calendar is hidden, then no events will be retrieved by default. |
byinstance | boolean | In "byinstance", all the instances of repeat eventts will be retrieved as a separate event when it is set as rue. This (byinstance) will work only when RANGE value is set .
Whether the event is a recurring event? True - to show the hidden calendar False - to skip the hidden calendar (default) |
* - Mandatory parameter
Sample Request
Copiedhttps://calendar.zoho.com/api/v1/calendars/w9QSuARmSjO1sEmv91zOaw==/events
Sample Response
Copied{
events: [
{
uid : 5dca5b01f5974686bdbd83e6be2e1b39@zoho.com
etag :1476715187436
organizer :user@domain.com
createdby :user@domain.com
enable_eventmanagement : false
description : event test desctiption of event in calendar
caluid : w9QSuARmSjO1sEmv91zOaw==
repeat: [
{
count: 6
freq: weekly
byday: SU,MO,TU,WE,TH,FR,SA
interval: 1
until: 20170516T023000Z
}
]
modifiedby :user2@domain.com
type :0
title :my friend birthday
lastmodifiedtime :20161017T143947Z
start :20161017T163000
end :20161017T195500
isprivate :false
url: https://www.zoho.com
createdtime :20161017T14Z
color :3
role :organizer
calid :2000000000003
estatus :added
multiday :false
isallday :false
location :chennai
eurlid :2000000007001
group_list :[
{
name : EXAMPLE_GROUP
id :34556841
}
]
attendees: [
{
email: attendee@domain.com
status: NEEDS-ACTION
},
{
email: TestGroup
status: NEEDS-ACTION
},
{
email: user1@domain.com
status: ACCEPTED
}
]
dateandtime: {
timezone : Asia/Calcutta
start : 20161017T163000
end : 20161017T195500
}
reminders: [
{
minutes: -5
action: popup
},
{
minutes: -5
action: email
}
]
calendar_alarm: false
duration: 1800000
rrule: FREQ=WEEKLY;COUNT=6;INTERVAL=1;BYDAY=SU,MO,TU,WE,TH,FR,SA
}
]
}