Get event details
curl --request GET \
--url https://api.default.com/v1/scheduling/events/{event} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.default.com/v1/scheduling/events/{event}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.default.com/v1/scheduling/events/{event}', 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.default.com/v1/scheduling/events/{event}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.default.com/v1/scheduling/events/{event}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.default.com/v1/scheduling/events/{event}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.default.com/v1/scheduling/events/{event}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"schedulerTitle": "<string>",
"schedulerDescription": "<string>",
"duration": -1,
"timeslotIncrement": -1,
"conferencingType": "calendar_default",
"location": "<string>",
"hosts": [
{
"name": "<string>",
"profilePictureUrl": "<string>",
"isQueue": true,
"isPrimary": true
}
],
"questions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "email",
"title": "<string>",
"description": "<string>",
"placeholder": "<string>",
"isRequired": true,
"order": 0,
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"requireWorkEmail": true
}
]
}{
"error": {
"code": "INVALID_REQUEST",
"message": "Request validation failed",
"details": [
"personEmail: Invalid email address"
]
}
}{
"error": {
"code": "INVALID_API_KEY",
"message": "Missing, malformed, or revoked API key"
}
}{
"error": {
"code": "MISSING_SCOPE",
"message": "This API key is missing the required 'scheduling:read' scope"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Event not found"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded for this API key"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}
}Scheduling endpoints
Get event details
Returns booking configuration for one event, addressed by event id or slug (scheduling link ids and slugs also resolve), including all configured hosts.
Requires the scheduling:read scope.
GET
/
v1
/
scheduling
/
events
/
{event}
Get event details
curl --request GET \
--url https://api.default.com/v1/scheduling/events/{event} \
--header 'Authorization: Bearer <token>'import requests
url = "https://api.default.com/v1/scheduling/events/{event}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://api.default.com/v1/scheduling/events/{event}', 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.default.com/v1/scheduling/events/{event}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$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.default.com/v1/scheduling/events/{event}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
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.default.com/v1/scheduling/events/{event}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.default.com/v1/scheduling/events/{event}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"name": "<string>",
"schedulerTitle": "<string>",
"schedulerDescription": "<string>",
"duration": -1,
"timeslotIncrement": -1,
"conferencingType": "calendar_default",
"location": "<string>",
"hosts": [
{
"name": "<string>",
"profilePictureUrl": "<string>",
"isQueue": true,
"isPrimary": true
}
],
"questions": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"type": "email",
"title": "<string>",
"description": "<string>",
"placeholder": "<string>",
"isRequired": true,
"order": 0,
"options": [
{
"value": "<string>",
"label": "<string>"
}
],
"requireWorkEmail": true
}
]
}{
"error": {
"code": "INVALID_REQUEST",
"message": "Request validation failed",
"details": [
"personEmail: Invalid email address"
]
}
}{
"error": {
"code": "INVALID_API_KEY",
"message": "Missing, malformed, or revoked API key"
}
}{
"error": {
"code": "MISSING_SCOPE",
"message": "This API key is missing the required 'scheduling:read' scope"
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Event not found"
}
}{
"error": {
"code": "RATE_LIMITED",
"message": "Rate limit exceeded for this API key"
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Internal server error"
}
}Authorizations
Organization API key, created in workspace settings (Settings → API Keys). Sent as Authorization: Bearer <key>. Shown once at creation; revocable and permission-scoped per key.
Path Parameters
Event id or slug. Scheduling link ids and slugs also resolve and show the hosts configured on the link.
Response
Success
Required range:
-2147483648 <= x <= 2147483647Required range:
-2147483648 <= x <= 2147483647Available options:
calendar_default, zoom, zoom_personal, in_person, phone, gong Show child attributes
Show child attributes
Show child attributes
Show child attributes
Was this page helpful?