Introduction

Core resources

Administration

Invite member

Revoke member

Booking flow

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-05-12T03:22:44.258Z",
"updated_at": "2024-05-12T03:22:44.258Z",
"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<uuid>

Unique identifier

organization_idFilter<uuid>

Identifier of the organization this widget is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

autocomplete_date_selectionFilter<boolean>

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

currencyFilter<text>

Currency of the widget

date_visibilityFilter<text>

Visible dates in the calendar. Either all or available

fontFilter<text>

Font of the widget

ftsFilter<tsvector>

Full text search index

initial_dateFilter<text>

Initial date shown in the calendar

interactionFilter<text>

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

localeFilter<text>

Language of the widget

redirect_urlFilter<text>

URL to redirect to after submitting a booking

settingsFilter<jsonb>

Settings of the widget

show_booked_asFilter<text>

show_bookingmood_brandingFilter<boolean>

Whether to show the Bookingmood branding

show_closed_asFilter<text>

show_pastFilter<boolean>

Whether to show past dates in the calendar

show_pending_asFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">

show_reviewsFilter<boolean>

stay_expandedFilter<boolean>

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

titleFilter<text>

Title of the widget

typeFilter<text>

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

visible_monthsFilter<boolean[]>

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<uuid>

Unique identifier

organization_idFilter<uuid>

Identifier of the organization this widget is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

autocomplete_date_selectionFilter<boolean>

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

currencyFilter<text>

Currency of the widget

date_visibilityFilter<text>

Visible dates in the calendar. Either all or available

fontFilter<text>

Font of the widget

ftsFilter<tsvector>

Full text search index

initial_dateFilter<text>

Initial date shown in the calendar

interactionFilter<text>

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

localeFilter<text>

Language of the widget

redirect_urlFilter<text>

URL to redirect to after submitting a booking

settingsFilter<jsonb>

Settings of the widget

show_booked_asFilter<text>

show_bookingmood_brandingFilter<boolean>

Whether to show the Bookingmood branding

show_closed_asFilter<text>

show_pastFilter<boolean>

Whether to show past dates in the calendar

show_pending_asFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">

show_reviewsFilter<boolean>

stay_expandedFilter<boolean>

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

titleFilter<text>

Title of the widget

typeFilter<text>

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

visible_monthsFilter<boolean[]>

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<uuid>

Unique identifier

organization_idFilter<uuid>

Identifier of the organization this widget is defined in

created_atFilter<timestamp with time zone>

Creation timestamp

updated_atFilter<timestamp with time zone>

Last modification timestamp

autocomplete_date_selectionFilter<boolean>

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

currencyFilter<text>

Currency of the widget

date_visibilityFilter<text>

Visible dates in the calendar. Either all or available

fontFilter<text>

Font of the widget

ftsFilter<tsvector>

Full text search index

initial_dateFilter<text>

Initial date shown in the calendar

interactionFilter<text>

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

localeFilter<text>

Language of the widget

redirect_urlFilter<text>

URL to redirect to after submitting a booking

settingsFilter<jsonb>

Settings of the widget

show_booked_asFilter<text>

show_bookingmood_brandingFilter<boolean>

Whether to show the Bookingmood branding

show_closed_asFilter<text>

show_pastFilter<boolean>

Whether to show past dates in the calendar

show_pending_asFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">

show_reviewsFilter<boolean>

stay_expandedFilter<boolean>

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

titleFilter<text>

Title of the widget

typeFilter<text>

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

visible_monthsFilter<boolean[]>

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 '{}'