Calendar EventsVersion: v3

Get Appointment

GET/calendars/events/appointments/{eventId}

Get appointment by ID

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

Path Parameters

eventIdstringrequired

Event Id or Instance id. For recurring appointments send masterEventId to modify original series.

Example:ocQHyuzHvysMo5N5VsXc

Response

application/json

Successful response

eventobject

Calendar event object

event.idstringrequired

Event Id or Instance id for a recurring event

Example:ocQHyuzHvysMo5N5VsXc

event.addressstring

Calendar Event address

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

event.titlestringrequired

Calendar Event title

Example:Appointment with Dev team

event.calendarIdstringrequired

Calendar ID

Example:BqTwX8QFwXzpegMve9EQ

event.locationIdstringrequired

Location ID

Example:0007BWpSzSwfiuSl0tR2

event.contactIdstringrequired

Contact ID

Example:9NkT25Vor1v4aQatFsv2

event.groupIdstringrequired

Group ID

Example:9NkT25Vor1v4aQatFsv2

event.appointmentStatusstringrequired

Appointment Status

Example:confirmed

event.assignedUserIdstringrequired

AssignedUser - the primary owner of an appointment

Example:YlWd2wuCAZQzh2cH1fVZ

event.usersstring[]required

Users - the secondary owners of an appointment.

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

event.notesstring

Notes

Example:Some dummy note

event.descriptionstring

Description

Example:Some dummy description

event.isRecurringboolean

true if the event is recurring otherwise false

Example:true

event.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

event.deletedboolean

Tells if a calendar event has been deleted

Example:false

event.startTimeobjectrequired

Start Time

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

event.endTimeobjectrequired

End Time

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

event.dateAddedobjectrequired

Date Added

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

event.dateUpdatedobjectrequired

Date Updated

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

event.assignedResourcesstring[]

Ids of associated resources rooms and/or equipments

Example:["YlWd2wuCAZQzh2cH1fVZ","BqTwX5hA2NLRadBMgR6M"]

event.createdByobject

Appointment booked by metadata

event.masterEventIdstring

Master event id for a recurring instance

Example:ocWd2wuBGAQzh2cH1fSZ

event.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 Appointment

Authorizations

Request​

Headers

Path Parameters

Response

Request