Booking · Settings
Get booking settings
Returns organization-wide booking settings for the supplied organizationId. The settings cover anonymization of past booking data, the default waitlist for new events, electronic invoices for businesses, and whether instructors can cancel individual dates in the app.
Permissions
Send an API key of the organization in the path, using the X-API-Key header.
Who may call it
- Organization access is required.
- The
booking.readpermission is required.
Request
Path parameters
-
organizationIdidrequired
Request
curl --fail-with-body --silent --show-error --max-time 30 --globoff \
--request GET 'https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/booking/settings' \
--header 'X-API-Key: YOUR_API_KEY'const response = await fetch("https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/booking/settings", {
method: "GET",
headers: {
"X-API-Key": "YOUR_API_KEY"
},
redirect: 'error',
signal: AbortSignal.timeout(30_000),
});
if (!response.ok) throw new Error(`campai HTTP ${response.status}`);
const text = await response.text();
const result = text ? JSON.parse(text) : null;
console.log(JSON.stringify(result, null, 2));<?php
$context = stream_context_create(['http' => [
'method' => 'GET',
'header' => [
'X-API-Key: YOUR_API_KEY',
],
'timeout' => 30,
'follow_location' => 0,
'ignore_errors' => true,
]]);
$text = @file_get_contents('https://cloud.campai.com/api/YOUR_ORGANIZATION_ID/booking/settings', false, $context);
preg_match('/^HTTP\/\S+ (\d{3})/', $http_response_header[0] ?? '', $match);
$status = (int) ($match[1] ?? 0);
if ($text === false || $status < 200 || $status >= 300) {
throw new RuntimeException("campai HTTP $status (0 means no response)");
}
$result = $text === '' ? null : json_decode($text, true, 512, JSON_THROW_ON_ERROR);
echo json_encode($result, JSON_PRETTY_PRINT | JSON_THROW_ON_ERROR), PHP_EOL;
Response
200 Successful response
Content-Type: application/json
-
retentionobject1 property
-
anonymizeAfterMonthsintegernullable1–120
-
-
waitlistobjectnullable2 properties
-
modestringorderedrandommanual -
offerAvailableHoursnumbernullable
-
-
electronicInvoicesboolean -
instructorsCancelDatesboolean
Response200
{
"retention": {
"anonymizeAfterMonths": 1
},
"waitlist": {
"mode": "ordered",
"offerAvailableHours": 1
},
"electronicInvoices": true,
"instructorsCancelDates": true
}
Errors
No errors of its own are known for this endpoint.
Errors nearly every request can meet are listed under Errors.