Sign in

v1

latestOpenAPI 3.0.02026-07-249301.3 MB
Calendars

Retrieve an event

Retrieve the details of a calendar event.

get/api/v1/calendars/{calendar_id}/events/{event_id}

Path parameters

event_idstring required

The id of the wanted event.

calendar_idstring required

The id of calendar of the wanted event.

Query parameters

account_idstring required

The id of the account to use.

Response

OK

object'CalendarEvent' required
idstring required

The ID of the calendar event.

ical_uidstring

The iCalendar UID of the event, as defined in RFC5545.

master_event_idstring

If event instance, the ID of the master event.

calendar_idstring required

The ID of the calendar the event belongs to.

created_atstring required

The date the event was created. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).

updated_atstring required

The date the event was last updated. Uses ISO 8601 UTC datetime (YYYY-MM-DDTHH:MM:SS.sssZ).

titlestring required

The title of the event.

bodystring

The body of the event.

locationstring

The location of the event.

is_cancelledboolean required

Is the event cancelled.

is_all_dayboolean required

Is the event all day.

is_attendees_list_hiddenboolean required

Is the attendees list hidden for attendees.

recurrencestring[]

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

event_typestring required

The type of the event (birthday, fromGmail, outOfOffice...)

guests_can_modifyboolean

If true, allow guests to modify the event. <br> Outlook Calendar: Not supported, this parameter will always be false.