Introduction

Core resources

Attribute options
Attributes
Booking details
Booking updates
Bookings
Calendar event notes
Calendar event tasks
Calendar event updates
Calendar events
Capacities
Capacity group dependencies
Capacity groups
Contact bookings
Contacts
Coupon products
Coupon services
Coupon uses
Coupons
Email events
Email templates
Emails
External calendars
Invoices
Line item taxes
Line items
Members
Payments
Permissions
Product attribute options
Product calendar logs
Product configurations
Product email templates
Product reply to addresses
Product services
Product tasks
Products
Reply to addresses
Seasons
Service deposit moments
Service discounts
Service payment moments
Service taxes
Services
Site listings
Site nav items
Site pages
Site views
Sites
Taxes
User profiles
Webhook notifications
Webhooks
Widget listings
Widget views
Widgets

Administration

Invite member
Revoke member
Create product
Delete product

Booking flow

Query availability
Search availability
Book

Widgets

Embeddable widgets

Endpoints
GET/widgetsPOST/widgetsDELETE/widgetsPATCH/widgets

The widget object

Attributes

iduuid

Unique identifier

organization_iduuid

Identifier of the organization this widget is defined in

created_attimestamp with time zone

Creation timestamp

updated_attimestamp with time zone

Last modification timestamp

autocomplete_date_selectionboolean

Whether to autocomplete the date selection when only one date is available

currencytext | null

Currency of the widget

date_visibilitytext

Visible dates in the calendar. Either all or available

fonttext | null

Font of the widget

ftstsvector | null

Full text search index

initial_datetext

Initial date shown in the calendar

interactiontext | null

Interaction type, either "book", "forward" or null

localetext

Language of the widget

redirect_urltext | null

URL to redirect to after submitting a booking

settingsjsonb

Settings of the widget

show_booked_astext
show_bookingmood_brandingboolean

Whether to show the Bookingmood branding

show_closed_astext
show_pastboolean

Whether to show past dates in the calendar

show_pending_as"CANCELLED" | "TENTATIVE" | "CONFIRMED"
show_reviewsboolean
stay_expandedboolean

Whether the date-selection section should stay expanded after selecting dates

titletext

Title of the widget

typetext

Type of the widget, either calendar, timeline, inventory or search.

visible_monthsboolean[] | null

List of months that are visible in the calendar (deprecated).

The widget object
{
"id": "00000000-0000-0000-0000-000000000000",
"organization_id": "00000000-0000-0000-0000-000000000000",
"created_at": "2024-10-22T21:17:14.499Z",
"updated_at": "2024-10-22T21:17:14.499Z",
"autocomplete_date_selection": false,
"currency": "",
"date_visibility": "all",
"font": "",
"initial_date": "today",
"interaction": "",
"locale": "en-US",
"redirect_url": "",
"settings": {},
"show_booked_as": "unavailable",
"show_bookingmood_branding": true,
"show_closed_as": "unavailable",
"show_past": false,
"show_pending_as": "TENTATIVE",
"show_reviews": false,
"stay_expanded": false,
"title": "",
"type": "calendar",
"visible_months": [
false
]
}

List widgets

Filters

idFilter<>

Unique identifier

organization_idFilter<>

Identifier of the organization this widget is defined in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

autocomplete_date_selectionFilter<>

Whether to autocomplete the date selection when only one date is available

currencyFilter<>

Currency of the widget

date_visibilityFilter<>

Visible dates in the calendar. Either all or available

fontFilter<>

Font of the widget

ftsFilter<>

Full text search index

initial_dateFilter<>

Initial date shown in the calendar

interactionFilter<>

Interaction type, either "book", "forward" or null

localeFilter<>

Language of the widget

redirect_urlFilter<>

URL to redirect to after submitting a booking

settingsFilter<>

Settings of the widget

show_booked_asFilter<>
show_bookingmood_brandingFilter<>

Whether to show the Bookingmood branding

show_closed_asFilter<>
show_pastFilter<>

Whether to show past dates in the calendar

show_pending_asFilter<>
show_reviewsFilter<>
stay_expandedFilter<>

Whether the date-selection section should stay expanded after selecting dates

titleFilter<>

Title of the widget

typeFilter<>

Type of the widget, either calendar, timeline, inventory or search.

visible_monthsFilter<>

List of months that are visible in the calendar (deprecated).

Responses

200

A list of widgets with the selected columns

206

Partial Content

GET/widgets
curl -X GET "https://api.bookingmood.com/v1/widgets?select=*" \
  -H "Authorization: Bearer YOUR_API_KEY"

Create widgets

Body

Partial<Widget>
| Array<Partial<Widget>>

Responses

201

The newly created widgets with the selected columns

POST/widgets
curl -X POST "https://api.bookingmood.com/v1/widgets" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '[]'

Delete widgets

Filters

idFilter<>

Unique identifier

organization_idFilter<>

Identifier of the organization this widget is defined in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

autocomplete_date_selectionFilter<>

Whether to autocomplete the date selection when only one date is available

currencyFilter<>

Currency of the widget

date_visibilityFilter<>

Visible dates in the calendar. Either all or available

fontFilter<>

Font of the widget

ftsFilter<>

Full text search index

initial_dateFilter<>

Initial date shown in the calendar

interactionFilter<>

Interaction type, either "book", "forward" or null

localeFilter<>

Language of the widget

redirect_urlFilter<>

URL to redirect to after submitting a booking

settingsFilter<>

Settings of the widget

show_booked_asFilter<>
show_bookingmood_brandingFilter<>

Whether to show the Bookingmood branding

show_closed_asFilter<>
show_pastFilter<>

Whether to show past dates in the calendar

show_pending_asFilter<>
show_reviewsFilter<>
stay_expandedFilter<>

Whether the date-selection section should stay expanded after selecting dates

titleFilter<>

Title of the widget

typeFilter<>

Type of the widget, either calendar, timeline, inventory or search.

visible_monthsFilter<>

List of months that are visible in the calendar (deprecated).

Responses

204

The deleted widgets with the selected columns

DELETE/widgets
curl -X DELETE "https://api.bookingmood.com/v1/widgets" \
  -H "Authorization: Bearer YOUR_API_KEY"

Update widgets

Filters

idFilter<>

Unique identifier

organization_idFilter<>

Identifier of the organization this widget is defined in

created_atFilter<>

Creation timestamp

updated_atFilter<>

Last modification timestamp

autocomplete_date_selectionFilter<>

Whether to autocomplete the date selection when only one date is available

currencyFilter<>

Currency of the widget

date_visibilityFilter<>

Visible dates in the calendar. Either all or available

fontFilter<>

Font of the widget

ftsFilter<>

Full text search index

initial_dateFilter<>

Initial date shown in the calendar

interactionFilter<>

Interaction type, either "book", "forward" or null

localeFilter<>

Language of the widget

redirect_urlFilter<>

URL to redirect to after submitting a booking

settingsFilter<>

Settings of the widget

show_booked_asFilter<>
show_bookingmood_brandingFilter<>

Whether to show the Bookingmood branding

show_closed_asFilter<>
show_pastFilter<>

Whether to show past dates in the calendar

show_pending_asFilter<>
show_reviewsFilter<>
stay_expandedFilter<>

Whether the date-selection section should stay expanded after selecting dates

titleFilter<>

Title of the widget

typeFilter<>

Type of the widget, either calendar, timeline, inventory or search.

visible_monthsFilter<>

List of months that are visible in the calendar (deprecated).

Body

Partial<Widget>

Responses

204

The updated widgets with the selected columns

PATCH/widgets
curl -X PATCH "https://api.bookingmood.com/v1/widgets" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'