Check in a guest by scanned QR token
curl --request POST \
--url https://api.cal.com/v2/events/{uuid}/check-ins \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"checkInToken": "<string>"
}
'import requests
url = "https://api.cal.com/v2/events/{uuid}/check-ins"
payload = { "checkInToken": "<string>" }
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({checkInToken: '<string>'})
};
fetch('https://api.cal.com/v2/events/{uuid}/check-ins', 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/events/{uuid}/check-ins",
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([
'checkInToken' => '<string>'
]),
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/events/{uuid}/check-ins"
payload := strings.NewReader("{\n \"checkInToken\": \"<string>\"\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/events/{uuid}/check-ins")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"checkInToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/events/{uuid}/check-ins")
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 \"checkInToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"kind": "checked_in",
"registration": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"status": "PENDING_APPROVAL",
"rsvpResponse": "YES",
"createdAt": "2023-11-07T05:31:56Z",
"phoneNumber": "<string>",
"responses": {},
"locationId": "<string>",
"checkedInAt": "2023-11-07T05:31:56Z",
"checkedInByUserId": 123
},
"checkedInAt": "2023-11-07T05:31:56Z",
"status": "PENDING_APPROVAL"
}
}Events
Check in a guest by scanned QR token
Redeems a scanned check-in QR token. The token is carried in the request body, never the URL, since URLs land in history and access logs. Same access as the by-id check-in; an external co-host may also work the door. PBAC permission for team events: calEvent.update. If accessed using an OAuth access token, the EVENT_WRITE scope is required.
POST
/
v2
/
events
/
{uuid}
/
check-ins
Check in a guest by scanned QR token
curl --request POST \
--url https://api.cal.com/v2/events/{uuid}/check-ins \
--header 'Authorization: <authorization>' \
--header 'Content-Type: application/json' \
--data '
{
"checkInToken": "<string>"
}
'import requests
url = "https://api.cal.com/v2/events/{uuid}/check-ins"
payload = { "checkInToken": "<string>" }
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({checkInToken: '<string>'})
};
fetch('https://api.cal.com/v2/events/{uuid}/check-ins', 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/events/{uuid}/check-ins",
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([
'checkInToken' => '<string>'
]),
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/events/{uuid}/check-ins"
payload := strings.NewReader("{\n \"checkInToken\": \"<string>\"\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/events/{uuid}/check-ins")
.header("Authorization", "<authorization>")
.header("Content-Type", "application/json")
.body("{\n \"checkInToken\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.cal.com/v2/events/{uuid}/check-ins")
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 \"checkInToken\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"status": "success",
"data": {
"kind": "checked_in",
"registration": {
"id": "<string>",
"name": "<string>",
"email": "<string>",
"status": "PENDING_APPROVAL",
"rsvpResponse": "YES",
"createdAt": "2023-11-07T05:31:56Z",
"phoneNumber": "<string>",
"responses": {},
"locationId": "<string>",
"checkedInAt": "2023-11-07T05:31:56Z",
"checkedInByUserId": 123
},
"checkedInAt": "2023-11-07T05:31:56Z",
"status": "PENDING_APPROVAL"
}
}Headers
value must be Bearer <token> where <token> is api key prefixed with cal_, managed user access token, or OAuth access token
Path Parameters
Event UUID. Accepts the canonical UUID (e.g. 018ff5cd-6dc4-7d57-bcbc-374702ca8b38) or its short-uuid (Flickr Base58) form (e.g. 1cbZYoAFoJdwqN4tixezd5).
Body
application/json
The signed check-in token scanned from the guest's QR code.
Required string length:
1 - 256Was this page helpful?