Calendar EventsVersion: v3

Get Calendar Events

GET/calendars/events

Get Calendar Events

Authorizations

Authorizationstringheaderrequired

Bearer authentication header of the form Bearer <token>, where <token> is your access token.

Scope:calendars/events.readonly

Auth methods:OAuthPrivate Integration

Token type:Sub-Account Token

Request

Headers

Versionstringrequired

API Version

Available optionsv3

Example:v3

Query Parameters

locationIdstringrequired

Location Id

Example:0007BWpSzSwfiuSl0tR2

userIdstring

User Id - Owner of an appointment. Either of userId, groupId or calendarId is required

Example:CVokAlI8fgw4WYWoCtQz

calendarIdstring

Either of calendarId, userId or groupId is required

Example:BqTwX8QFwXzpegMve9EQ

groupIdstring

Either of groupId, calendarId or userId is required

Example:ocQHyuzHvysMo5N5VsXc

startTimestringrequired

Start Time (in millis)

Example:1680373800000

endTimestringrequired

End Time (in millis)

Example:1680978599999

Response

application/json

Successful response

eventsobject[]

List of calendar events

events[].idstringrequired

Event Id or Instance id for a recurring event

Example:ocQHyuzHvysMo5N5VsXc

events[].addressstring

Calendar Event address

Example:https://meet.google.com/yqp-gogr-wve

events[].titlestringrequired

Calendar Event title

Example:Appointment with Dev team

events[].calendarIdstringrequired

Calendar ID

Example:BqTwX8QFwXzpegMve9EQ

events[].locationIdstringrequired

Location ID

Example:0007BWpSzSwfiuSl0tR2

events[].contactIdstringrequired

Contact ID

Example:9NkT25Vor1v4aQatFsv2

events[].groupIdstringrequired

Group ID

Example:9NkT25Vor1v4aQatFsv2

events[].appointmentStatusstringrequired

Appointment Status

Example:confirmed

events[].assignedUserIdstringrequired

AssignedUser - the primary owner of an appointment

Example:YlWd2wuCAZQzh2cH1fVZ

events[].usersstring[]required

Users - the secondary owners of an appointment.

Example:["YlWd2wuCAZQzh2cH1fVZ","9NkT25Vor1v4aQatFsv2"]

events[].notesstring

Notes

Example:Some dummy note

events[].descriptionstring

Description

Example:Some dummy description

events[].isRecurringboolean

true if the event is recurring otherwise false

Example:true

events[].rrulestring

RRULE as per the iCalendar (RFC 5545) specification for recurring events. DTSTART is not required, instance ids are calculated on the basis of startTime of the event.

Example:RRULE:FREQ=DAILY;INTERVAL=1;COUNT=5

events[].deletedboolean

Tells if a calendar event has been deleted

Example:false

events[].startTimeobjectrequired

Start Time

Example:2023-09-25T16:00:00+05:30

events[].endTimeobjectrequired

End Time

Example:2023-09-25T16:00:00+05:30

events[].dateAddedobjectrequired

Date Added

Example:2023-09-25T16:00:00+05:30

events[].dateUpdatedobjectrequired

Date Updated

Example:2023-09-25T16:00:00+05:30

events[].assignedResourcesstring[]

Ids of associated resources rooms and/or equipments

Example:["YlWd2wuCAZQzh2cH1fVZ","BqTwX5hA2NLRadBMgR6M"]

events[].createdByobject

Appointment booked by metadata

events[].masterEventIdstring

Master event id for a recurring instance

Example:ocWd2wuBGAQzh2cH1fSZ

events[].rescheduledAtstring<date-time>

Timestamp of when the appointment was last rescheduled. Only present for rescheduled appointments.

Example:2023-09-25T16:00:00+05:30

Get Calendar Events

Authorizations

Request​

Headers

Query Parameters

Response

Request