Skip to navigation
API ReferenceDory

Get Event Calendar Invite

The event for a calendar and a meeting invite, as the console’s Add to calendar gives it: the lines to paste into an invite, links that open Google Calendar’s and Outlook’s new-event pages filled in, and the .ics file, each with the join link and code from getEventJoinLink, never the passcode. An event with no startsAt has the invite text only. In the signed-in person’s language, English for a key. Needs events:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

eventIdstringRequired

Response

This endpoint returns an object.
eventIdstring
codestring
The code attendees can type instead of following the link.
joinUrlstring

The link to hand out, the same one getEventJoinLink gives.

hasPasscodeboolean
Whether attendees must type a passcode as well, to be given to them separately. The passcode itself is never returned.
inviteTextstring

The title, when it runs in the event’s time zone, the join link and the join code, one to a line, to paste into a meeting’s invite or a message. In the signed-in person’s language, English for a key.

startsAtdatetimeOptional
endsAtdatetimeOptional
Absent, a calendar gives the event an hour.
timeZonestringOptional
The event's IANA time zone, which the invite's times are written in.
googleCalendarUrlstringOptional

Opens Google Calendar’s new-event page, filled in. Absent with no startsAt.

outlookUrlstringOptional

The same for Outlook on the web, for work or school accounts. Absent with no startsAt.

outlookComUrlstringOptional

The same for Outlook.com, for personal accounts. Absent with no startsAt.

icsstringOptional

The event as an iCalendar file, for Apple Calendar or any other. Its UID is the event’s, so adding it again updates the copy. Absent with no startsAt: a calendar has nowhere to put it.

Errors

404
Not Found Error
429
Too Many Requests Error