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.

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.

If accessed using an OAuth access token, the BOOKING_READ scope is required.

GET /v2/bookings/{bookingUid}/calendar-links

Get 'Add to Calendar' links for a booking

cURL

curl --request GET \
  --url https://api.cal.com/v2/bookings/{bookingUid}/calendar-links \
  --header 'Authorization: <authorization>' \
  --header 'cal-api-version: <cal-api-version>'

200

{
  "status": "success",
  "data": [
    {
      "label": "<string>",
      "link": "<string>"
    }
  ]
}

Headers

cal-api-version · string · default: 2026-02-25 · required

Must be set to 2026-02-25.

Authorization · string · required

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

Path Parameters

bookingUid · string · required

Response

200 - application/json

status · enum<string> · required

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

Available options: success, error

Example:

"success"

data · object[] · required

Calendar links for the booking

Show child attributes