Skip to content
campaiDeveloper
campai.com

Booking · Settings

GET/{organizationId}/booking/settingsReads only

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.read permission 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'

Response

200 Successful response

Content-Type: application/json

  • retentionobject
    1 property
    • anonymizeAfterMonthsintegernullable

      1–120

  • waitlistobjectnullable
    2 properties
    • modestring
      ordered random manual
    • 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.