Create an OAuth client
curl --request POST \
--url https://api.cal.com/v2/oauth-clients \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"redirectUris": [
"<string>"
],
"permissions": [],
"logo": "<string>",
"bookingRedirectUri": "<string>",
"bookingCancelRedirectUri": "<string>",
"bookingRescheduleRedirectUri": "<string>",
"areEmailsEnabled": true,
"areDefaultEventTypesEnabled": false,
"areCalendarEventsEnabled": true
}
'import requests
url = "https://api.cal.com/v2/oauth-clients"
payload = {
"name": "<string>",
"redirectUris": ["<string>"],
"permissions": [],
"logo": "<string>",
"bookingRedirectUri": "<string>",
"bookingCancelRedirectUri": "<string>",
"bookingRescheduleRedirectUri": "<string>",
"areEmailsEnabled": True,
"areDefaultEventTypesEnabled": False,
"areCalendarEventsEnabled": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
redirectUris: ['<string>'],
permissions: [],
logo: '<string>',
bookingRedirectUri: '<string>',
bookingCancelRedirectUri: '<string>',
bookingRescheduleRedirectUri: '<string>',
areEmailsEnabled: true,
areDefaultEventTypesEnabled: false,
areCalendarEventsEnabled: true
})
};
fetch('https://api.cal.com/v2/oauth-clients', 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/oauth-clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'redirectUris' => [
'<string>'
],
'permissions' => [
],
'logo' => '<string>',
'bookingRedirectUri' => '<string>',
'bookingCancelRedirectUri' => '<string>',
'bookingRescheduleRedirectUri' => '<string>',
'areEmailsEnabled' => true,
'areDefaultEventTypesEnabled' => false,
'areCalendarEventsEnabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cal.com/v2/oauth-clients"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"permissions\": [],\n \"logo\": \"<string>\",\n \"bookingRedirectUri\": \"<string>\",\n \"bookingCancelRedirectUri\": \"<string>\",\n \"bookingRescheduleRedirectUri\": \"<string>\",\n \"areEmailsEnabled\": true,\n \"areDefaultEventTypesEnabled\": false,\n \"areCalendarEventsEnabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cal.com/v2/oauth-clients")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"permissions\": [],\n \"logo\": \"<string>\",\n \"bookingRedirectUri\": \"<string>\",\n \"bookingCancelRedirectUri\": \"<string>\",\n \"bookingRescheduleRedirectUri\": \"<string>\",\n \"areEmailsEnabled\": true,\n \"areDefaultEventTypesEnabled\": false,\n \"areCalendarEventsEnabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/oauth-clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"permissions\": [],\n \"logo\": \"<string>\",\n \"bookingRedirectUri\": \"<string>\",\n \"bookingCancelRedirectUri\": \"<string>\",\n \"bookingRescheduleRedirectUri\": \"<string>\",\n \"areEmailsEnabled\": true,\n \"areDefaultEventTypesEnabled\": false,\n \"areCalendarEventsEnabled\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"clientId": "clsx38nbl0001vkhlwin9fmt0",
"clientSecret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoib2F1dGgtY2xpZW50Iiwi"
}
}Platform OAuth Clients
Create an OAuth client
These endpoints are deprecated and will be removed in the future.
POST
/
v2
/
oauth-clients
Create an OAuth client
curl --request POST \
--url https://api.cal.com/v2/oauth-clients \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"redirectUris": [
"<string>"
],
"permissions": [],
"logo": "<string>",
"bookingRedirectUri": "<string>",
"bookingCancelRedirectUri": "<string>",
"bookingRescheduleRedirectUri": "<string>",
"areEmailsEnabled": true,
"areDefaultEventTypesEnabled": false,
"areCalendarEventsEnabled": true
}
'import requests
url = "https://api.cal.com/v2/oauth-clients"
payload = {
"name": "<string>",
"redirectUris": ["<string>"],
"permissions": [],
"logo": "<string>",
"bookingRedirectUri": "<string>",
"bookingCancelRedirectUri": "<string>",
"bookingRescheduleRedirectUri": "<string>",
"areEmailsEnabled": True,
"areDefaultEventTypesEnabled": False,
"areCalendarEventsEnabled": True
}
headers = {
"Authorization": "<authorization>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
redirectUris: ['<string>'],
permissions: [],
logo: '<string>',
bookingRedirectUri: '<string>',
bookingCancelRedirectUri: '<string>',
bookingRescheduleRedirectUri: '<string>',
areEmailsEnabled: true,
areDefaultEventTypesEnabled: false,
areCalendarEventsEnabled: true
})
};
fetch('https://api.cal.com/v2/oauth-clients', 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/oauth-clients",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'redirectUris' => [
'<string>'
],
'permissions' => [
],
'logo' => '<string>',
'bookingRedirectUri' => '<string>',
'bookingCancelRedirectUri' => '<string>',
'bookingRescheduleRedirectUri' => '<string>',
'areEmailsEnabled' => true,
'areDefaultEventTypesEnabled' => false,
'areCalendarEventsEnabled' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <authorization>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.cal.com/v2/oauth-clients"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"permissions\": [],\n \"logo\": \"<string>\",\n \"bookingRedirectUri\": \"<string>\",\n \"bookingCancelRedirectUri\": \"<string>\",\n \"bookingRescheduleRedirectUri\": \"<string>\",\n \"areEmailsEnabled\": true,\n \"areDefaultEventTypesEnabled\": false,\n \"areCalendarEventsEnabled\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<authorization>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.cal.com/v2/oauth-clients")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"permissions\": [],\n \"logo\": \"<string>\",\n \"bookingRedirectUri\": \"<string>\",\n \"bookingCancelRedirectUri\": \"<string>\",\n \"bookingRescheduleRedirectUri\": \"<string>\",\n \"areEmailsEnabled\": true,\n \"areDefaultEventTypesEnabled\": false,\n \"areCalendarEventsEnabled\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/oauth-clients")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"redirectUris\": [\n \"<string>\"\n ],\n \"permissions\": [],\n \"logo\": \"<string>\",\n \"bookingRedirectUri\": \"<string>\",\n \"bookingCancelRedirectUri\": \"<string>\",\n \"bookingRescheduleRedirectUri\": \"<string>\",\n \"areEmailsEnabled\": true,\n \"areDefaultEventTypesEnabled\": false,\n \"areCalendarEventsEnabled\": true\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"clientId": "clsx38nbl0001vkhlwin9fmt0",
"clientSecret": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJuYW1lIjoib2F1dGgtY2xpZW50Iiwi"
}
}Headers
value must be Bearer <token> where <token> is api key prefixed with cal_
Body
application/json
Array of permission keys like ["BOOKING_READ", "BOOKING_WRITE"]. Use ["*"] to grant all permissions.
Available options:
EVENT_TYPE_READ, EVENT_TYPE_WRITE, BOOKING_READ, BOOKING_WRITE, SCHEDULE_READ, SCHEDULE_WRITE, APPS_READ, APPS_WRITE, PROFILE_READ, PROFILE_WRITE, * If true, when creating a managed user the managed user will have 4 default event types: 30 and 60 minutes without Cal video, 30 and 60 minutes with Cal video. Set this as false if you want to create a managed user and then manually create event types for the user.
If true and if managed user has calendar connected, calendar events will be created. Disable it if you manually create calendar events. Default to true.
Response
201 - application/json
Create an OAuth client
Was this page helpful?
⌘I