---
title: "GET /calendars/{calendarId}/events/{eventId}"
method: GET
path: "/calendars/{calendarId}/events/{eventId}"
tags: ["events"]
---

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

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

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.

## Path parameters

- `calendarId` string, required
- `eventId` string, required

## Query parameters

- `maxAttendees` integer
- `timeZone` string

## Response `200`

A `gcalendar:Event` if successful, otherwise an error

- Event — Represents an event in Google Calendar
  - `reminders` EventReminders — Information about the event's reminders for the authenticated user
    - `overrides` EventReminder[] — If the event doesn't use the default reminders, this lists the reminders specific to the event, or, if not set, indicates that no reminders are set for this event. The maximum number of override reminders is 5
      - `method` string — The method used by this reminder. Possible values are: - "email" - Reminders are sent via email. - "popup" - Reminders are sent via a UI popup. Required when adding a reminder
      - `minutes` integer — Number of minutes before the start of the event when the reminder should trigger. Valid values are between 0 and 40320 (4 weeks in minutes). Required when adding a reminder
    - `useDefault` boolean — Whether the default reminders of the calendar apply to the event
  - `attachments` EventAttachment[] — File attachments for the event. In order to modify attachments the supportsAttachments request parameter should be set to true. There can be at most 25 attachments per event,
    - `iconLink` string — URL link to the attachment's icon. This field can only be modified for custom third-party attachments
    - `fileUrl` string — URL link to the attachment. For adding Google Drive file attachments use the same format as in alternateLink property of the Files resource in the Drive API. Required when adding an attachment
    - `mimeType` string — Internet media type (MIME type) of the attachment
    - `title` string — Attachment title
    - `fileId` string — ID of the attached file. Read-only. For Google Drive files, this is the ID of the corresponding Files resource entry in the Drive API
  - `workingLocationProperties` EventWorkingLocationProperties — Conveys information about the working location of a user during an event
    - `officeLocation` EventWorkingLocationPropertiesOfficeLocation — If present, specifies that the user is working from an office
      - `floorId` string — An optional floor identifier
      - `floorSectionId` string — An optional floor section identifier
      - `label` string — The office name that's displayed in Calendar Web and Mobile clients. We recommend you reference a building name in the organization's Resources database
      - `deskId` string — An optional desk identifier
      - `buildingId` string — An optional building identifier. This should reference a building ID in the organization's Resources database
    - `homeOffice` unknown
    - `customLocation` EventWorkingLocationPropertiesCustomLocation — If present, specifies that the user is working from a custom location
      - `label` string — An optional extra label for additional information
    - `type` string — Type of the working location. Possible values are: - "homeOffice" - The user is working at home. - "officeLocation" - The user is working from an office. - "customLocation" - The user is working from a custom location. Any details are specified in a sub-field of the specified name, but this field may be missing if empty. Any other fields are ignored. Required when adding working location properties
  - `colorId` string — The color of the event. This is an ID referring to an entry in the event section of the colors definition (see the colors endpoint). Optional
  - `hangoutLink` string — An absolute link to the Google Hangout associated with this event. Read-only
  - `attendeesOmitted` boolean — Whether attendees may have been omitted from the event's representation. When retrieving an event, this may be due to a restriction specified by the maxAttendee query parameter. When updating an event, this can be used to only update the participant's response. Optional. The default is False
  - `description` string — Description of the event. Can contain HTML. Optional
  - `source` EventSource — Source from which the event was created. For example, a web page, an email message or any document identifiable by an URL with HTTP or HTTPS scheme. Can only be seen or modified by the creator of the event
    - `title` string — Title of the source; for example a title of a web page or an email subject
    - `url` string — URL of the source pointing to a resource. The URL scheme must be HTTP or HTTPS
  - `extendedProperties` EventExtendedProperties — Extended properties of the event
    - `shared` object — Properties that are shared between copies of the event on other attendees' calendars
    - `private` object — Properties that are private to the copy of the event that appears on this calendar
  - `guestsCanModify` boolean — Whether attendees other than the organizer can modify the event. Optional. The default is False
  - `recurringEventId` string — For an instance of a recurring event, this is the id of the recurring event to which this instance belongs. Immutable
  - `endTimeUnspecified` boolean — Whether the end time is actually unspecified. An end time is still provided for compatibility reasons, even if this attribute is set to True. The default is False
  - `guestsCanSeeOtherGuests` boolean — Whether attendees other than the organizer can see who the event's attendees are. Optional. The default is True
  - `end` EventDateTime — Defines the date, time, and time zone information for events
    - `date` string, date — The date, in the format "yyyy-mm-dd", if this is an all-day event
    - `dateTime` string, date-time — The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone
    - `timeZone` string — The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end
  - `id` string — Opaque identifier of the event. When creating new single or recurring events, you can specify their IDs. Provided IDs must follow these rules: - characters allowed in the ID are those used in base32hex encoding, i.e. lowercase letters a-v and digits 0-9, see section 3.1.2 in RFC2938 - the length of the ID must be between 5 and 1024 characters - the ID must be unique per calendar Due to the globally distributed nature of the system, we cannot guarantee that ID collisions will be detected at event creation time. To minimize the risk of collisions we recommend using an established UUID algorithm such as one described in RFC4122. If you do not specify an ID, it will be automatically generated by the server. Note that the icalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same icalUIDs
  - `locked` boolean — Whether this is a locked event copy where no changes can be made to the main event fields "summary", "description", "location", "start", "end" or "recurrence". The default is False. Read-Only
  - `anyoneCanAddSelf` boolean — Whether anyone can invite themselves to the event (deprecated). Optional. The default is False
  - `summary` string — Title of the event
  - `creator` EventCreator — The creator of the event. Read-only
    - `displayName` string — The creator's name, if available
    - `self` boolean — Whether the creator corresponds to the calendar on which this copy of the event appears. Read-only. The default is False
    - `id` string — The creator's Profile ID, if available
    - `email` string — The creator's email address, if available
  - `privateCopy` boolean — If set to True, Event propagation is disabled. Note that it is not the same thing as Private event properties. Optional. Immutable. The default is False
  - `visibility` string — Visibility of the event. Optional. Possible values are: - "default" - Uses the default visibility for events on the calendar. This is the default value. - "public" - The event is public and event details are visible to all readers of the calendar. - "private" - The event is private and only event attendees may view event details. - "confidential" - The event is private. This value is provided for compatibility reasons
  - `attendees` EventAttendee[] — The attendees of the event. See the Events with attendees guide for more information on scheduling events with other calendar users. Service accounts need to use domain-wide delegation of authority to populate the attendee list
    - `additionalGuests` integer — Number of additional guests. Optional. The default is 0
    - `resource` boolean — Whether the attendee is a resource. Can only be set when the attendee is added to the event for the first time. Subsequent modifications are ignored. Optional. The default is False
    - `displayName` string — The attendee's name, if available. Optional
    - `organizer` boolean — Whether the attendee is the organizer of the event. Read-only. The default is False
    - `self` boolean — Whether this entry represents the calendar on which this copy of the event appears. Read-only. The default is False
    - `comment` string — The attendee's response comment. Optional
    - `optional` boolean — Whether this is an optional attendee. Optional. The default is False
    - `id` string — The attendee's Profile ID, if available
    - `responseStatus` string — The attendee's response status. Possible values are: - "needsAction" - The attendee has not responded to the invitation (recommended for new events). - "declined" - The attendee has declined the invitation. - "tentative" - The attendee has tentatively accepted the invitation. - "accepted" - The attendee has accepted the invitation. Warning: If you add an event using the values declined, tentative, or accepted, attendees with the "Add invitations to my calendar" setting set to "When I respond to invitation in email" won't see an event on their calendar unless they choose to change their invitation response in the event invitation email
    - `email` string — The attendee's email address, if available. This field must be present when adding an attendee. It must be a valid email address as per RFC5322. Required when adding an attendee
  - `created` string, date-time — Creation time of the event (as a RFC3339 timestamp). Read-only
  - `htmlLink` string — An absolute link to this event in the Google Calendar Web UI. Read-only
  - `kind` string — Type of the resource ("calendar#event")
  - `iCalUID` string — Event unique identifier as defined in RFC5545. It is used to uniquely identify events accross calendaring systems and must be supplied when importing events via the import method. Note that the iCalUID and the id are not identical and only one of them should be supplied at event creation time. One difference in their semantics is that in recurring events, all occurrences of one event have different ids while they all share the same iCalUIDs. To retrieve an event using its iCalUID, call the events.list method using the iCalUID parameter. To retrieve an event using its id, call the events.get method
  - `start` EventDateTime — Defines the date, time, and time zone information for events
    - `date` string, date — The date, in the format "yyyy-mm-dd", if this is an all-day event
    - `dateTime` string, date-time — The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone
    - `timeZone` string — The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end
  - `originalStartTime` EventDateTime — Defines the date, time, and time zone information for events
    - `date` string, date — The date, in the format "yyyy-mm-dd", if this is an all-day event
    - `dateTime` string, date-time — The time, as a combined date-time value (formatted according to RFC3339). A time zone offset is required unless a time zone is explicitly specified in timeZone
    - `timeZone` string — The time zone in which the time is specified. (Formatted as an IANA Time Zone Database name, e.g. "Europe/Zurich".) For recurring events this field is required and specifies the time zone in which the recurrence is expanded. For single events this field is optional and indicates a custom time zone for the event start/end
  - `eventType` string — Specific type of the event. This cannot be modified after the event is created. Possible values are: - "default" - A regular event or not further specified. - "outOfOffice" - An out-of-office event. - "focusTime" - A focus-time event. - "workingLocation" - A working location event. Currently, only "default " and "workingLocation" events can be created using the API. Extended support for other event types will be made available in later releases
  - `recurrence` string[] — List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545. Note that DTSTART and DTEND lines are not allowed in this field; event start and end times are specified in the start and end fields. This field is omitted for single events or instances of recurring events
  - `sequence` integer — Sequence number as per iCalendar
  - `organizer` EventOrganizer — The organizer of the event. If the organizer is also an attendee, this is indicated with a separate entry in attendees with the organizer field set to True. To change the organizer, use the move operation. Read-only, except when importing an event
    - `displayName` string — The organizer's name, if available
    - `self` boolean — Whether the organizer corresponds to the calendar on which this copy of the event appears. Read-only. The default is False
    - `id` string — The organizer's Profile ID, if available
    - `email` string — The organizer's email address, if available. It must be a valid email address as per RFC5322
  - `transparency` string — Whether the event blocks time on the calendar. Optional. Possible values are: - "opaque" - Default value. The event does block time on the calendar. This is equivalent to setting Show me as to Busy in the Calendar UI. - "transparent" - The event does not block time on the calendar. This is equivalent to setting Show me as to Available in the Calendar UI
  - `conferenceData` ConferenceData — Represents information about conferences associated with calendar events
    - `entryPoints` EntryPoint[] — Information about individual conference entry points, such as URLs or phone numbers. All of them must belong to the same conference. Either conferenceSolution and at least one entryPoint, or createRequest is required
      - `entryPointFeatures` string[] — Features of the entry point, such as being toll or toll-free. One entry point can have multiple features. However, toll and toll-free cannot be both set on the same entry point
      - `password` string — The password to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional
      - `regionCode` string — The CLDR/ISO 3166 region code for the country associated with this phone access. Example: "SE" for Sweden. Calendar backend will populate this field only for EntryPointType.PHONE
      - `pin` string — The PIN to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional
      - `entryPointType` string — The type of the conference entry point. Possible values are: - "video" - joining a conference over HTTP. A conference can have zero or one video entry point. - "phone" - joining a conference by dialing a phone number. A conference can have zero or more phone entry points. - "sip" - joining a conference over SIP. A conference can have zero or one sip entry point. - "more" - further conference joining instructions, for example additional phone numbers. A conference can have zero or one more entry point. A conference with only a more entry point is not a valid conference
      - `accessCode` string — The access code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional
      - `meetingCode` string — The meeting code to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed. Optional
      - `label` string — The label for the URI. Visible to end users. Not localized. The maximum length is 512 characters. Examples: - for video: meet.google.com/aaa-bbbb-ccc - for phone: +1 123 268 2601 - for sip: 12345678@altostrat.com - for more: should not be filled Optional
      - `uri` string — The URI of the entry point. The maximum length is 1300 characters. Format: - for video, http: or https: schema is required. - for phone, tel: schema is required. The URI should include the entire dial sequence (e.g., tel:+12345678900,,,123456789;1234). - for sip, sip: schema is required, e.g., sip:12345678@myprovider.com. - for more, http: or https: schema is required
      - `passcode` string — The passcode to access the conference. The maximum length is 128 characters. When creating new conference data, populate only the subset of {meetingCode, accessCode, passcode, password, pin} fields that match the terminology that the conference provider uses. Only the populated fields should be displayed
    - `notes` string — Additional notes (such as instructions from the domain administrator, legal notices) to display to the user. Can contain HTML. The maximum length is 2048 characters. Optional
    - `conferenceId` string — The ID of the conference. Can be used by developers to keep track of conferences, should not be displayed to users. The ID value is formed differently for each conference solution type: - eventHangout: ID is not set. (This conference type is deprecated.) - eventNamedHangout: ID is the name of the Hangout. (This conference type is deprecated.) - hangoutsMeet: ID is the 10-letter meeting code, for example aaa-bbbb-ccc. - addOn: ID is defined by the third-party provider. Optional
    - `createRequest` CreateConferenceRequest — Represents the request to create a conference within a calendar event
      - `requestId` string — The client-generated unique ID for this request. Clients should regenerate this ID for every new request. If an ID provided is the same as for the previous request, the request is ignored
      - `conferenceSolutionKey` ConferenceSolutionKey — Represents the key information for a conference solution
        - `type` string — The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are: - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created) - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created) - "hangoutsMeet" for Google Meet (http://meet.google.com) - "addOn" for 3P conference providers
      - `status` ConferenceRequestStatus — Provides information about the current status of a conference create request
        - `statusCode` string — The current status of the conference create request. Read-only. The possible values are: - "pending": the conference create request is still being processed. - "success": the conference create request succeeded, the entry points are populated. - "failure": the conference create request failed, there are no entry points
    - `signature` string — The signature of the conference data. Generated on server side. Unset for a conference with a failed create request. Optional for a conference with a pending create request
    - `conferenceSolution` ConferenceSolution — Represents conference solutions that users can utilize when scheduling or participating in events and meetings
      - `name` string — The user-visible name of this solution. Not localized
      - `iconUri` string — The user-visible icon for this solution
      - `key` ConferenceSolutionKey — Represents the key information for a conference solution
        - `type` string — The conference solution type. If a client encounters an unfamiliar or empty type, it should still be able to display the entry points. However, it should disallow modifications. The possible values are: - "eventHangout" for Hangouts for consumers (deprecated; existing events may show this conference solution type but new conferences cannot be created) - "eventNamedHangout" for classic Hangouts for Google Workspace users (deprecated; existing events may show this conference solution type but new conferences cannot be created) - "hangoutsMeet" for Google Meet (http://meet.google.com) - "addOn" for 3P conference providers
    - `parameters` ConferenceParameters — Represents parameters related to conference settings for events
      - `addOnParameters` ConferenceParametersAddOnParameters — This type is used for adding parameters that control the behavior of a conference
        - `parameters` object
  - `etag` string — ETag of the resource
  - `location` string — Geographic location of the event as free-form text. Optional
  - `guestsCanInviteOthers` boolean — Whether attendees other than the organizer can invite others to the event. Optional. The default is True
  - `updated` string, date-time — Last modification time of the event (as a RFC3339 timestamp). Read-only
  - `status` string — Status of the event. Optional. Possible values are: - "confirmed" - The event is confirmed. This is the default status. - "tentative" - The event is tentatively confirmed. - "cancelled" - The event is cancelled (deleted). The list method returns cancelled events only on incremental sync (when syncToken or updatedMin are specified) or if the showDeleted flag is set to true. The get method always returns them. A cancelled status represents two different states depending on the event type: - Cancelled exceptions of an uncancelled recurring event indicate that this instance should no longer be presented to the user. Clients should store these events for the lifetime of the parent recurring event. Cancelled exceptions are only guaranteed to have values for the id, recurringEventId and originalStartTime fields populated. The other fields might be empty. - All other cancelled events represent deleted events. Clients should remove their locally synced copies. Such cancelled events will eventually disappear, so do not rely on them being available indefinitely. Deleted events are only guaranteed to have the id field populated. On the organizer's calendar, cancelled events continue to expose event details (summary, location, etc.) so that they can be restored (undeleted). Similarly, the events to which the user was invited and that they manually removed continue to provide details. However, incremental sync requests with showDeleted set to false will not return these details. If an event changes its organizer (for example via the move operation) and the original organizer is not on the attendee list, it will leave behind a cancelled event where only the id field is guaranteed to be populated

---

[API](https://skmtc.net/ballerina-platform/apis/calendar-api.md) · [All operations](https://skmtc.net/ballerina-platform/apis/calendar-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ballerina-platform/calendar-api/versions/1f87c6519494/schema)