GET - Get Event By Instance

Purpose

This API is used to get all instances of a particular repeat event.

Request URL

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

Headers

Accept - application/json+large ( This is used only when the 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 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 90 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).

Note:

The range cannot exceed 90 days.
This API will work only for repeat event UID.

Sample Request

Copiedhttps://calendar.zoho.com/api/v1/calendars/f39f12662ad84c2eb66c2fce49d52eea/events/bd71f03ebd2142f29ee9ec7a38edf03c@zoho.com/byinstance?range={"start":"20191101","end":"20191103"}

Sample Response

Copied{
 "events":[
  {
   "isprivate":false,
   "enable_eventmanagement":false,
   "role":"organizer",
   "calid":"1000000000003",
   "has_attachment":false,
   "title":"Repeat new ",
   "recurrenceid":"20191101T090000Z",
   "createdtime":"20191031T090338Z",
   "duration":"21300000",
   "uid":"bd71f03ebd2142f29ee9ec7a38edf03c@zoho.com",
   "createdby":"user1@zohocorp.com",
   "organizer":"user1@zohocorp.com",
   "isallday":false,
   "modifiedby":"user1@zohocorp.com",
   "etag":"1572512618377",
   "caluid":"f39f12662ad84c2eb66c2fce49d52eea",
   "multiday":false,
   "dateandtime":{
    "timezone":"Asia/Calcutta",
    "start":"20191101T143000+0530",
    "end":"20191101T202500+0530"
   },
   "lastmodifiedtime":"20191031T090338Z"
  },
  {
   "isprivate":false,
   "enable_eventmanagement":false,
   "role":"organizer",
   "calid":"1000000000003",
   "has_attachment":false,
   "title":"Repeat new ",
   "recurrenceid":"20191102T090000Z",
   "createdtime":"20191031T090338Z",
   "duration":"21300000",
   "uid":"bd71f03ebd2142f29ee9ec7a38edf03c@zoho.com",
   "createdby":"user1@zohocorp.com",
   "organizer":"user1@zohocorp.com",
   "isallday":false,
   "modifiedby":"user1@zohocorp.com",
   "etag":"1572512618377",
   "caluid":"f39f12662ad84c2eb66c2fce49d52eea",
   "multiday":false,
   "dateandtime":{
    "timezone":"Asia/Calcutta",
    "start":"20191102T143000+0530",
    "end":"20191102T202500+0530"
   },
   "lastmodifiedtime":"20191031T090338Z"
  }
 ]
}