The purpose of this API is to get the list of all upcoming events in a Zoho Connect network.
| Request URL: | https://connect.zoho.com/pulse/api/upcomingEvents |
OAuth Scope: | zohopulse.events.READ |
Request Method: | GET |
| Mandatory Header: | Header name: Authorization Header Value: Zoho-oauthtoken d92d401c803988c5cb849d0b4215f52 |
Parameters
| Name | Description | Required |
| scopeID | ID of the network the events are in. You can get this from the Network list API. | Required |
| selectedPartIds | Group IDs separated by a comma. | Required (if partitionId is not given) |
| partitionId | Group ID | Required (if selectedPartIds are not given) |
| startTime | Fetch data from the specified time. Time should be mentioned in milliseconds eg) | Optional |
| endTime | Fetch data till the specified time. Time should be mentioned in milliseconds eg) | Optional |
| sharedWithMe | Get only events that the user has been invited to. Set this as either true or false. | Optional |
| partitionType | If partitionId or selectedPartIds is not given, then this field has to be specified: (GROUP | DEFAULT) | Required (if partitionId/selectedPartIds is not given) |
| partitionUrl | If partitionId or selectedPartIds is not given, then this field has to be specified. Specify the URL of the Group. | Required (if partitionId/selectedPartIds is not given) |
Sample URL
Copiedhttps://connect.zoho.com/pulse/api/upcomingEvents?scopeID=929000000015001&selectedPartIds=929000000295001,929000000439015Sample Response
Copied{
"upcomingEvents": {
"events": [
{
"title": "Test Event",
"isExpired": "true",
"type": "EVENT",
"streamId": "929000000688005",
"invitedUserList": [
{
"status": "Pending",
"invitedUser": {
"zuid": "2060557",
"id": "2060557",
"name": "Eduardo Vargas",
"canFollow": "true",
"type": "C"
}
}
],
"invitedUserCount": "1",
"participants": {
"invitedGroups": [
{
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
],
"yesUsers": [],
"maybeUsers": [],
"noUsers": [],
"pendingUsers": [
{
"zuid": "2060557",
"id": "2060557",
"name": "Eduardo Vargas",
"canFollow": "true",
"type": "C"
}
]
},
"eventInvitedCount": "2",
"pvtEventMemberList": ",2060557,929000000439015,",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"url": "https://connect.zoho.com/portal/zillum/stream/929000000688005",
"googleCalendarUrl": "https://www.google.com/calendar/render?action=TEMPLATE&text=Test+Event&dates=20170728/20170729&details=&location=&trp=false&sprop=&sprop=name:",
"startTime": "1501225200618",
"endTime": "1501225200618",
"startDay": "6",
"startDate": "28",
"startMonth": "7",
"startYear": "2017",
"startMin": "0",
"startHour": "0",
"dateComFormatStr": "28-Jul-2017",
"endDay": "6",
"endDate": "28",
"endMonth": "7",
"endYear": "2017",
"endMin": "0",
"endHour": "0",
"canEdit": "true",
"canDelete": "true",
"isAllDay": "true",
"canAddRepetition": "true",
"date": "20170728",
"partition": {
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
},
{
"title": "Test Event",
"isExpired": "true",
"type": "EVENT",
"streamId": "929000000772001",
"participants": {
"invitedGroups": [
{
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
],
"yesUsers": [],
"maybeUsers": [],
"noUsers": [],
"pendingUsers": []
},
"eventInvitedCount": "1",
"pvtEventMemberList": ",929000000439015,",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"url": "https://connect.zoho.com/portal/zillum/stream/929000000772001",
"googleCalendarUrl": "https://www.google.com/calendar/render?action=TEMPLATE&text=Test+Event&dates=20171114T033000Z/20171114T043000Z&details=&location=&trp=false&sprop=&sprop=name:",
"formattedStartTime": "04:30 PM",
"fullformattedStartTime": "November 14, 2017 04:30 PM",
"startTime": "1510716600986",
"endTime": "1510720200986",
"startDay": "3",
"startDate": "14",
"startMonth": "11",
"startYear": "2017",
"startMin": "30",
"startHour": "16",
"dateComFormatStr": "14-Nov-2017",
"formattedEndTime": "05:30 PM",
"fullformattedEndTime": "November 14, 2017 05:30 PM",
"endDay": "3",
"endDate": "14",
"endMonth": "11",
"endYear": "2017",
"endMin": "30",
"endHour": "17",
"canEdit": "true",
"canDelete": "true",
"canAddRepetition": "true",
"date": "20171114",
"partition": {
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
},
{
"title": "Test Event",
"isExpired": "true",
"type": "EVENT",
"streamId": "929000000797030",
"participants": {
"invitedGroups": [
{
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
],
"yesUsers": [],
"maybeUsers": [],
"noUsers": [],
"pendingUsers": []
},
"eventInvitedCount": "1",
"pvtEventMemberList": ",929000000439015,",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"url": "https://connect.zoho.com/portal/zillum/stream/929000000797030",
"googleCalendarUrl": "https://www.google.com/calendar/render?action=TEMPLATE&text=Test+Event&dates=20171220T033000Z/20171220T043000Z&details=&location=&trp=false&sprop=&sprop=name:",
"formattedStartTime": "04:30 PM",
"fullformattedStartTime": "December 20, 2017 04:30 PM",
"startTime": "1513827000000",
"endTime": "1513830600000",
"startDay": "4",
"startDate": "20",
"startMonth": "12",
"startYear": "2017",
"startMin": "30",
"startHour": "16",
"dateComFormatStr": "20-Dec-2017",
"formattedEndTime": "05:30 PM",
"fullformattedEndTime": "December 20, 2017 05:30 PM",
"endDay": "4",
"endDate": "20",
"endMonth": "12",
"endYear": "2017",
"endMin": "30",
"endHour": "17",
"canEdit": "true",
"canDelete": "true",
"canAddRepetition": "true",
"date": "20171220",
"partition": {
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
},
{
"title": "Alumni new year party",
"isExpired": "true",
"type": "EVENT",
"streamId": "929000000805005",
"participants": {
"invitedGroups": [
{
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
],
"yesUsers": [],
"maybeUsers": [],
"noUsers": [],
"pendingUsers": []
},
"eventInvitedCount": "1",
"pvtEventMemberList": ",929000000439015,",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"url": "https://connect.zoho.com/portal/zillum/stream/929000000805005",
"googleCalendarUrl": "https://www.google.com/calendar/render?action=TEMPLATE&text=Alumni+new+year+party&dates=20171230T033000Z/20171230T043000Z&details=&location=&trp=false&sprop=&sprop=name:",
"formattedStartTime": "04:30 PM",
"fullformattedStartTime": "December 30, 2017 04:30 PM",
"startTime": "1514691000000",
"endTime": "1514694600000",
"startDay": "7",
"startDate": "30",
"startMonth": "12",
"startYear": "2017",
"startMin": "30",
"startHour": "16",
"dateComFormatStr": "30-Dec-2017",
"formattedEndTime": "05:30 PM",
"fullformattedEndTime": "December 30, 2017 05:30 PM",
"endDay": "7",
"endDate": "30",
"endMonth": "12",
"endYear": "2017",
"endMin": "30",
"endHour": "17",
"canEdit": "true",
"canDelete": "true",
"canAddRepetition": "true",
"date": "20171230",
"partition": {
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
},
{
"title": "Test Event",
"isExpired": "true",
"type": "EVENT",
"streamId": "929000000812005",
"participants": {
"invitedGroups": [
{
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
],
"yesUsers": [],
"maybeUsers": [],
"noUsers": [],
"pendingUsers": []
},
"eventInvitedCount": "1",
"pvtEventMemberList": ",929000000439015,",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"url": "https://connect.zoho.com/portal/zillum/stream/929000000812005",
"googleCalendarUrl": "https://www.google.com/calendar/render?action=TEMPLATE&text=Test+Event&dates=20180103T073000Z/20180103T083000Z&details=&location=&trp=false&sprop=&sprop=name:",
"formattedStartTime": "08:30 PM",
"fullformattedStartTime": "January 03, 2018 08:30 PM",
"startTime": "1515051000578",
"endTime": "1515054600578",
"startDay": "4",
"startDate": "3",
"startMonth": "1",
"startYear": "2018",
"startMin": "30",
"startHour": "20",
"dateComFormatStr": "03-Jan-2018",
"formattedEndTime": "09:30 PM",
"fullformattedEndTime": "January 03, 2018 09:30 PM",
"endDay": "4",
"endDate": "3",
"endMonth": "1",
"endYear": "2018",
"endMin": "30",
"endHour": "21",
"canEdit": "true",
"canDelete": "true",
"hasReminder": "true",
"intervalMinute": "0",
"canAddRepetition": "true",
"date": "20180103",
"partition": {
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
},
{
"title": "Engineering event",
"isExpired": "true",
"type": "EVENT",
"streamId": "929000000825001",
"participants": {
"invitedGroups": [
{
"id": "929000000295001",
"name": "Engineering",
"partitionUrl": "engineering",
"url": "engineering",
"isPrivate": "true",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
],
"yesUsers": [],
"maybeUsers": [],
"noUsers": [],
"pendingUsers": []
},
"eventInvitedCount": "1",
"pvtEventMemberList": ",929000000295001,",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"url": "https://connect.zoho.com/portal/zillum/stream/929000000825001",
"googleCalendarUrl": "https://www.google.com/calendar/render?action=TEMPLATE&text=Engineering+event&dates=20180121T033000Z/20180121T043000Z&details=&location=&trp=false&sprop=&sprop=name:",
"formattedStartTime": "04:30 PM",
"fullformattedStartTime": "January 21, 2018 04:30 PM",
"startTime": "1516591800000",
"endTime": "1516595400000",
"startDay": "1",
"startDate": "21",
"startMonth": "1",
"startYear": "2018",
"startMin": "30",
"startHour": "16",
"dateComFormatStr": "21-Jan-2018",
"formattedEndTime": "05:30 PM",
"fullformattedEndTime": "January 21, 2018 05:30 PM",
"endDay": "1",
"endDate": "21",
"endMonth": "1",
"endYear": "2018",
"endMin": "30",
"endHour": "17",
"canEdit": "true",
"canDelete": "true",
"canAddRepetition": "true",
"date": "20180121",
"partition": {
"id": "929000000295001",
"name": "Engineering",
"partitionUrl": "engineering",
"url": "engineering",
"isPrivate": "true",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
},
{
"title": "Innovation meetup",
"type": "EVENT",
"streamId": "929000000856621",
"participants": {
"invitedGroups": [
{
"id": "929000000295001",
"name": "Engineering",
"partitionUrl": "engineering",
"url": "engineering",
"isPrivate": "true",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
],
"yesUsers": [],
"maybeUsers": [],
"noUsers": [],
"pendingUsers": []
},
"eventInvitedCount": "1",
"pvtEventMemberList": ",929000000295001,",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"url": "https://connect.zoho.com/portal/zillum/stream/929000000856621",
"googleCalendarUrl": "https://www.google.com/calendar/render?action=TEMPLATE&text=Innovation+meetup&dates=20180322T200000Z/20180322T210000Z&details=&location=&trp=false&sprop=&sprop=name:",
"formattedStartTime": "09:00 AM",
"fullformattedStartTime": "March 22, 2018 09:00 AM",
"startTime": "1521748800000",
"endTime": "1521752400000",
"startDay": "5",
"startDate": "22",
"startMonth": "3",
"startYear": "2018",
"startMin": "0",
"startHour": "9",
"dateComFormatStr": "22-Mar-2018",
"formattedEndTime": "10:00 AM",
"fullformattedEndTime": "March 22, 2018 10:00 AM",
"endDay": "5",
"endDate": "22",
"endMonth": "3",
"endYear": "2018",
"endMin": "0",
"endHour": "10",
"canEdit": "true",
"canDelete": "true",
"canAddRepetition": "true",
"date": "20180322",
"partition": {
"id": "929000000295001",
"name": "Engineering",
"partitionUrl": "engineering",
"url": "engineering",
"isPrivate": "true",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
},
{
"title": "Freshers Meetup",
"type": "EVENT",
"streamId": "929000000856634",
"participants": {
"invitedGroups": [
{
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
],
"yesUsers": [],
"maybeUsers": [],
"noUsers": [],
"pendingUsers": []
},
"eventInvitedCount": "1",
"pvtEventMemberList": ",929000000439015,",
"userDetails": {
"zuid": "2060758",
"id": "2060758",
"name": "Patricia Boyle",
"canFollow": "true"
},
"url": "https://connect.zoho.com/portal/zillum/stream/929000000856634",
"googleCalendarUrl": "https://www.google.com/calendar/render?action=TEMPLATE&text=Freshers+Meetup&dates=20180323T073000Z/20180323T083000Z&details=&location=&trp=false&sprop=&sprop=name:",
"formattedStartTime": "08:30 PM",
"fullformattedStartTime": "March 23, 2018 08:30 PM",
"startTime": "1521876600000",
"endTime": "1521880200000",
"startDay": "6",
"startDate": "23",
"startMonth": "3",
"startYear": "2018",
"startMin": "30",
"startHour": "20",
"dateComFormatStr": "23-Mar-2018",
"formattedEndTime": "09:30 PM",
"fullformattedEndTime": "March 23, 2018 09:30 PM",
"endDay": "6",
"endDate": "23",
"endMonth": "3",
"endYear": "2018",
"endMin": "30",
"endHour": "21",
"canEdit": "true",
"canDelete": "true",
"canAddRepetition": "true",
"date": "20180323",
"partition": {
"id": "929000000439015",
"name": "Creative team",
"partitionUrl": "creative-team",
"url": "creative-team",
"status": "ACTIVE",
"isAdmin": "true",
"type": "GROUP",
"typeOrd": "2",
"isUserFollow": "false"
}
}
]
}
}Show full
Show less