calendar.events.get

GET /calendars/{calendarId}/events/{eventId}

Copy endpoint

https://www.googleapis.com/calendar/v3

Returns an event based on its Google Calendar ID. To retrieve an event using its iCalendar ID, call the events.list method using the iCalUID parameter.

Parameters

path Path Parameters

Name	Type
`calendarId` required Calendar identifier. To retrieve calendar IDs call the calendarList.list method. If you want to access the primary calendar of the currently logged in user, use the "primary" keyword.	string
`eventId` required Event identifier.	string

query Query Parameters

Name	Type
`alwaysIncludeEmail` Deprecated and ignored. A value will always be returned in the email field for the organizer, creator and attendees, even if no real email address is available (i.e. a generated, non-working value will be provided).	boolean
`maxAttendees` The maximum number of attendees to include in the response. If there are more than the specified number of attendees, only the participant is returned. Optional.	number
`timeZone` Time zone used in the response. Optional. The default is the time zone of the calendar.	string
`alt` Data format for the response.	"json"
`fields` Selector specifying which fields to include in a partial response.	string
`key` API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.	string
`oauth_token` OAuth 2.0 token for the current user.	string
`prettyPrint` Returns response with indentations and line breaks.	boolean
`quotaUser` An opaque string that represents a user for quota purposes. Must not exceed 40 characters.	string
`userIp` Deprecated. Please use quotaUser instead.	string

Responses

200 */*

Successful response

interface Event {
anyoneCanAddSelf?: boolean;
attachments?:

EventAttachment

interface EventAttachment {
fileId?: string;
fileUrl?: string;
iconLink?: string;
mimeType?: string;
title?: string;
}

[];
attendees?:

EventAttendee

interface EventAttendee {
additionalGuests?: number;
comment?: string;
displayName?: string;
email?: string;
id?: string;
optional?: boolean;
organizer?: boolean;
resource?: boolean;
responseStatus?: string;
self?: boolean;
}

[];
attendeesOmitted?: boolean;
birthdayProperties?:

EventBirthdayProperties

interface EventBirthdayProperties {
contact?: string;
customTypeName?: string;
type?: string;
}

;
colorId?: string;
conferenceData?:

ConferenceData

interface ConferenceData {
parameters?: ConferenceParameters;
conferenceId?: string;
conferenceSolution?: ConferenceSolution;
createRequest?: CreateConferenceRequest;
entryPoints?: EntryPoint[];
notes?: string;
signature?: string;
}

;
created?: string;
creator?: {
displayName?: string;
email?: string;
id?: string;
self?: boolean;
};
description?: string;
end?:

EventDateTime

interface EventDateTime {
date?: string;
dateTime?: string;
timeZone?: string;
}

;
endTimeUnspecified?: boolean;
etag?: string;
eventType?: string;
extendedProperties?: { private?: { };shared?: { }; };
focusTimeProperties?:

EventFocusTimeProperties

interface EventFocusTimeProperties {
autoDeclineMode?: string;
chatStatus?: string;
declineMessage?: string;
}

;
gadget?: {
display?: string;
height?: number;
iconLink?: string;
link?: string;
preferences?: { };
title?: string;
type?: string;
width?: number;
};
guestsCanInviteOthers?: boolean;
guestsCanModify?: boolean;
guestsCanSeeOtherGuests?: boolean;
hangoutLink?: string;
htmlLink?: string;
iCalUID?: string;
id?: string;
kind?: string;
location?: string;
locked?: boolean;
organizer?: {
displayName?: string;
email?: string;
id?: string;
self?: boolean;
};
originalStartTime?:

EventDateTime

interface EventDateTime {
date?: string;
dateTime?: string;
timeZone?: string;
}

;
outOfOfficeProperties?:

EventOutOfOfficeProperties

interface EventOutOfOfficeProperties {
autoDeclineMode?: string;
declineMessage?: string;
}

;
privateCopy?: boolean;
recurrence?: string[];
recurringEventId?: string;
reminders?: { overrides?:

EventReminder

interface EventReminder {
method?: string;
minutes?: number;
}

[];useDefault?: boolean; };
sequence?: number;
source?: { title?: string;url?: string; };
start?:

EventDateTime

interface EventDateTime {
date?: string;
dateTime?: string;
timeZone?: string;
}

;
status?: string;
summary?: string;
transparency?: string;
updated?: string;
visibility?: string;
workingLocationProperties?:

EventWorkingLocationProperties

interface EventWorkingLocationProperties {
customLocation?: { label?: string; };
homeOffice?: unknown;
officeLocation?: {
buildingId?: string;
deskId?: string;
floorId?: string;
floorSectionId?: string;
label?: string;
};
type?: string;
}

;
}