Bookings

Get 'Add to Calendar' links for a booking

Retrieve calendar links for a booking that can be used to add the event to various calendar services. Returns links for Google Calendar, Microsoft Office, Microsoft Outlook, and a downloadable ICS file.

  <Note>Please make sure to pass in the cal-api-version header value as mentioned in the Headers section. Not passing the correct value will default to an older version of this endpoint.</Note>
get/v2/bookings/{bookingUid}/calendar-links

Request

  • The document declares no server URL.
  • Auth
    none declared. Required headers: cal-api-version, Authorization

Path parameters

bookingUidstring required

Headers

cal-api-versionstring required

Must be set to 2024-08-13. If not set to this value, the endpoint will default to an older version.

Authorizationstring required

value must be Bearer <token> where <token> is api key prefixed with cal_ or managed user access token

Response

statusobject required

The status of the request, always 'success' for successful responses

Changes

No recorded changes to this operation across all 52 revisions of this API.