Get booking references

Required membership role: team admin. PBAC permission: booking.readTeamBookings. Learn more about API access control at https://cal.com/docs/api-reference/v2/access-control. If accessed using an OAuth access token, the TEAM_BOOKING_READ scope is required.

GET /v2/organizations/{orgId}/teams/{teamId}/bookings/{bookingUid}/references

Get booking references

cURL

curl --request GET \
  --url https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/bookings/{bookingUid}/references

import requests

url = "https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/bookings/{bookingUid}/references"

response = requests.get(url)

print(response.text)

const options = {method: 'GET'};

fetch('https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/bookings/{bookingUid}/references', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/bookings/{bookingUid}/references",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/bookings/{bookingUid}/references"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/bookings/{bookingUid}/references")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.cal.com/v2/organizations/{orgId}/teams/{teamId}/bookings/{bookingUid}/references")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

200

{
  "status": "success",
  "data": [
    {
      "type": "<string>",
      "eventUid": "<string>",
      "destinationCalendarId": "<string>",
      "id": 123
    }
  ]
}

Headers

Authorization · string

For non-platform customers - value must be Bearer <token> where <token> is api key prefixed with cal_

x-cal-secret-key · string

For platform customers - OAuth client secret key

x-cal-client-id · string

For platform customers - OAuth client ID

Path Parameters

bookingUid · string · required

teamId · number · required

orgId · number · required

Query Parameters

type · enum<string>

Filter booking references by type

Available options: google_calendar, office365_calendar, daily_video, google_video, office365_video, zoom_video

Example:

"google_calendar"

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

Booking References

Show child attributes