Events Object

---

id

string

REQUIRED · 

The unique identifier of the event.

calendar

object

The calendar associated with the event.

id

string

The unique identifier of the calendar.

name

string

The name of the calendar.

title

string

REQUIRED · 

The title of the event.

description

string

The description of the event.

location

object

The location of the event.

id

string

The unique identifier of the location.

name

string

The name of the location.

address

object

street_1

string

The first line of the street address.

street_2

string

The second line of the street address.

city

string

The city of the address.

state

string

The state of the address.

country

string

The country of the address.

postal_code

string

The postal code of the address.

url

string

The URL of the location.

coordinates

object

latitude

number

The latitude of the location.

longitude

number

The longitude of the location.

timezone

string

The timezone of the event.

start_time

string · date-time

REQUIRED · 

The date and time when the event starts.

end_time

string · date-time

The date and time when the event ends.

status

string

The status of the event.

All possible enum values:

• confirmed
• tentative
• cancelled
• draft

attendees

object[]

The attendees associated with the event.

person

object

The person associated with the attendee.

id

string

The unique identifier of the person.

name

string

The name of the person.

emails

object[]

The emails of the person.

email

string

The email of the person.

type

string

The type of the email.

is_optional

boolean

Indicates if the attendance is optional.

is_self

boolean

Indicates if the attendee is the authenticated user.

is_organizer

boolean

Indicates if the attendee is the organizer of the event.

response

object

The response of the attendee.

status

string

The status of the response.

All possible enum values:

• needs_action
• declined
• tentative
• accepted

comment

string

The comment of the response.

created_by

object

The person who created the event.

id

string

The unique identifier of the person.

name

string

The name of the person.

emails

object[]

The emails of the person.

email

string

The email of the person.

type

string

The type of the email.

organized_by

object

The person who created the event.

id

string

The unique identifier of the person.

name

string

The name of the person.

emails

object[]

The emails of the person.

email

string

The email of the person.

type

string

The type of the email.

type

string

The type of the event.

All possible enum values:

• default
• out_of_office
• focus_time
• working_location

availability

string

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

All possible enum values:

• busy
• free

visibility

string

The visibility of the event.

All possible enum values:

• calendar_default
• public
• private

identifiers

object

The identifiers associated with the event.

ical_uid

string

The iCalendar UID of the event.

ical_sequence

string

The iCalendar sequence of the event.

is_locked

boolean

Indicates if the event is locked and cannot be modified.

urls

object

The URLs associated with the event.

url

string

The URL of the event.

type

string

The type of the URL.

is_recurring

boolean

Indicates if the event is recurring.

recurrence

string[]

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

parent_event

object

The parent event of a recurring event.

id

string

The unique identifier of the parent event.

has_attachments

boolean

Indicates if the event has attachments.

attachments

object[]

The attachments associated with the event.

id

string

The unique identifier of the attachment.

name

string

The name of the attachment.

mime_type

string

The MIME type of the attachment.

url

string

The URL of the attachment.

created_at

string · date-time

The date when the attachment was created.

updated_at

string · date-time

The date when the attachment was updated.

guests_can_invite_others

boolean

Indicates if guests can invite others to the event.

guests_can_modify

boolean

Indicates if guests can modify the event.

guests_can_see_other_guests

boolean

Indicates if guests can see other guests of the event.

event_type

object

The event type object associated with the event.

id

string

The unique identifier of the event type.

created_at

string · date-time

The date when the event was created.

updated_at

string · date-time

The date when the event was updated.

remote_data

object

Raw data returned from the remote API call.