Skip to content

Properties

idstring
required·

The unique identifier of the event.

start_timestring · date-time
required·

The date and time when the event starts.

titlestring
required·

The title of the event.

attachmentsobject[]

The attachments associated with the event.

created_atstring · date-time

The date when the attachment was created.

idstring

The unique identifier of the attachment.

mime_typestring

The MIME type of the attachment.

namestring

The name of the attachment.

updated_atstring · date-time

The date when the attachment was updated.

urlstring

The URL of the attachment.

attendeesobject[]

The attendees associated with the event.

is_optionalboolean

Indicates if the attendance is optional.

is_organizerboolean

Indicates if the attendee is the organizer of the event.

is_selfboolean

Indicates if the attendee is the authenticated user.

personobject

The person associated with the attendee.

3 properties
emailsobject[]

The emails of the person.

2 properties
emailstring

The email of the person.

typestring

The type of the email.

idstring

The unique identifier of the person.

namestring

The name of the person.

responseobject

The response of the attendee.

2 properties
commentstring

The comment of the response.

statusstring

The status of the response.

Possible values:
needs_actiondeclinedtentativeaccepted
availabilitystring

The availability of the user during the time period of the event.

Possible values:
busyfree
calendarobject

The calendar associated with the event.

idstring

The unique identifier of the calendar.

namestring

The name of the calendar.

created_atstring · date-time

The date when the event was created.

created_byobject

The person who created the event.

emailsobject[]

The emails of the person.

2 properties
emailstring

The email of the person.

typestring

The type of the email.

idstring

The unique identifier of the person.

namestring

The name of the person.

descriptionstring

The description of the event.

end_timestring · date-time

The date and time when the event ends.

event_typeobject

The event type object associated with the event.

idstring

The unique identifier of the event type.

guests_can_invite_othersboolean

Indicates if guests can invite others to the event.

guests_can_modifyboolean

Indicates if guests can modify the event.

guests_can_see_other_guestsboolean

Indicates if guests can see other guests of the event.

has_attachmentsboolean

Indicates if the event has attachments.

identifiersobject

The identifiers associated with the event.

ical_sequencestring

The iCalendar sequence of the event.

ical_uidstring

The iCalendar UID of the event.

is_lockedboolean

Indicates if the event is locked and cannot be modified.

is_recurringboolean

Indicates if the event is recurring.

locationobject

The location of the event.

addressobject
6 properties
citystring

The city of the address.

countrystring

The country of the address.

postal_codestring

The postal code of the address.

statestring

The state of the address.

street_1string

The first line of the street address.

street_2string

The second line of the street address.

coordinatesobject
2 properties
latitudenumber

The latitude of the location.

longitudenumber

The longitude of the location.

idstring

The unique identifier of the location.

namestring

The name of the location.

urlstring

The URL of the location.

organized_byobject

The person who created the event.

emailsobject[]

The emails of the person.

2 properties
emailstring

The email of the person.

typestring

The type of the email.

idstring

The unique identifier of the person.

namestring

The name of the person.

parent_eventobject

The parent event of a recurring event.

idstring

The unique identifier of the parent event.

recurrencestring[]

The recurrence of the event. List of RRULE, EXRULE, RDATE and EXDATE lines for a recurring event, as specified in RFC5545.

remote_dataRecord<string, any>

Raw data returned from the remote API call.

statusstring

The status of the event.

Possible values:
confirmedtentativecancelleddraft
timezonestring

The timezone of the event.

typestring

The type of the event.

Possible values:
defaultout_of_officefocus_timeworking_location
updated_atstring · date-time

The date when the event was updated.

urlsobject

The URLs associated with the event.

typestring

The type of the URL.

urlstring

The URL of the event.

visibilitystring

The visibility of the event.

Possible values:
calendar_defaultpublicprivate