Skip to main content
GET
Get booking settings

Path Parameters

organisationId
string
required

Response

200 - application/json
notesEnabled
boolean
required

True if clients can add notes to the booking

Example:

true

cancellationFeeEnabled
boolean
required

True if clients will be charged for missed appointments

Example:

true

cancellationFeeAutoChargeEnabled
boolean
required

True if clients will be charged for missed appointments

Example:

true

paymentDetailsRequired
boolean
required

True if clients must provide payment details in the booking form

Example:

true

bookingNotificationsEnabled
boolean
required

True if booking notifications (confirmations, reminders, andcancellations) are enabled

Example:

true

providerBookingNotificationsEnabled
boolean
required

True if provider booking notifications (confirmations, reminders, andcancellations) are enabled

Example:

true

healthFundCardCollectionEnabled
boolean
required

True if health fund card collection is enabled in the booking form

Example:

true

pricesEnabled
boolean
default:true
required

True if prices should be shown in the booking form

Example:

true

cancellationFeeAmount
number | null

The amount to charge for missed appointments

Example:

100

cancellationFeePercent
number | null

The percentage of the service price to charge for missed appointments

Example:

10

cancellationNoFeeBeforeHours
number

The number of hours before the appointment to cancel without a fee

Example:

24

googleTagManagerContainerId
string

The Google Tag Manager container ID used to track events

Example:

"GTM-123456"