Core resources
Administration
Booking flow
Embeddable widgets
id
uuid
Unique identifier
organization_id
uuid
Identifier of the organization this widget is defined in
created_at
timestamp with time zone
Creation timestamp
updated_at
timestamp with time zone
Last modification timestamp
autocomplete_date_selection
boolean
Whether to autocomplete the date selection when only one date is available
currency
text | null
Currency of the widget
date_visibility
text
Visible dates in the calendar. Either all
or available
font
text | null
Font of the widget
fts
tsvector | null
Full text search index
initial_date
text
Initial date shown in the calendar
interaction
text | null
Interaction type, either "book"
, "forward"
or null
locale
text
Language of the widget
redirect_url
text | null
URL to redirect to after submitting a booking
settings
jsonb
Settings of the widget
show_booked_as
text
show_bookingmood_branding
boolean
Whether to show the Bookingmood branding
show_closed_as
text
show_past
boolean
Whether to show past dates in the calendar
show_pending_as
"CANCELLED" | "TENTATIVE" | "CONFIRMED"
show_reviews
boolean
stay_expanded
boolean
Whether the date-selection section should stay expanded after selecting dates
title
text
Title of the widget
type
text
Type of the widget, either calendar
, timeline
, inventory
or search
.
visible_months
boolean[] | null
List of months that are visible in the calendar (deprecated).
{"id": "00000000-0000-0000-0000-000000000000","organization_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-05-13T01:05:34.694Z","updated_at": "2024-05-13T01:05:34.694Z","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]
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this widget is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
autocomplete_date_selection
Filter<boolean>
Whether to autocomplete the date selection when only one date is available
currency
Filter<text>
Currency of the widget
date_visibility
Filter<text>
Visible dates in the calendar. Either all
or available
font
Filter<text>
Font of the widget
fts
Filter<tsvector>
Full text search index
initial_date
Filter<text>
Initial date shown in the calendar
interaction
Filter<text>
Interaction type, either "book"
, "forward"
or null
locale
Filter<text>
Language of the widget
redirect_url
Filter<text>
URL to redirect to after submitting a booking
settings
Filter<jsonb>
Settings of the widget
show_booked_as
Filter<text>
show_bookingmood_branding
Filter<boolean>
Whether to show the Bookingmood branding
show_closed_as
Filter<text>
show_past
Filter<boolean>
Whether to show past dates in the calendar
show_pending_as
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
show_reviews
Filter<boolean>
stay_expanded
Filter<boolean>
Whether the date-selection section should stay expanded after selecting dates
title
Filter<text>
Title of the widget
type
Filter<text>
Type of the widget, either calendar
, timeline
, inventory
or search
.
visible_months
Filter<boolean[]>
List of months that are visible in the calendar (deprecated).
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"
Partial<Widget>
| Array<Partial<Widget>>
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 '[]'
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this widget is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
autocomplete_date_selection
Filter<boolean>
Whether to autocomplete the date selection when only one date is available
currency
Filter<text>
Currency of the widget
date_visibility
Filter<text>
Visible dates in the calendar. Either all
or available
font
Filter<text>
Font of the widget
fts
Filter<tsvector>
Full text search index
initial_date
Filter<text>
Initial date shown in the calendar
interaction
Filter<text>
Interaction type, either "book"
, "forward"
or null
locale
Filter<text>
Language of the widget
redirect_url
Filter<text>
URL to redirect to after submitting a booking
settings
Filter<jsonb>
Settings of the widget
show_booked_as
Filter<text>
show_bookingmood_branding
Filter<boolean>
Whether to show the Bookingmood branding
show_closed_as
Filter<text>
show_past
Filter<boolean>
Whether to show past dates in the calendar
show_pending_as
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
show_reviews
Filter<boolean>
stay_expanded
Filter<boolean>
Whether the date-selection section should stay expanded after selecting dates
title
Filter<text>
Title of the widget
type
Filter<text>
Type of the widget, either calendar
, timeline
, inventory
or search
.
visible_months
Filter<boolean[]>
List of months that are visible in the calendar (deprecated).
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"
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this widget is defined in
created_at
Filter<timestamp with time zone>
Creation timestamp
updated_at
Filter<timestamp with time zone>
Last modification timestamp
autocomplete_date_selection
Filter<boolean>
Whether to autocomplete the date selection when only one date is available
currency
Filter<text>
Currency of the widget
date_visibility
Filter<text>
Visible dates in the calendar. Either all
or available
font
Filter<text>
Font of the widget
fts
Filter<tsvector>
Full text search index
initial_date
Filter<text>
Initial date shown in the calendar
interaction
Filter<text>
Interaction type, either "book"
, "forward"
or null
locale
Filter<text>
Language of the widget
redirect_url
Filter<text>
URL to redirect to after submitting a booking
settings
Filter<jsonb>
Settings of the widget
show_booked_as
Filter<text>
show_bookingmood_branding
Filter<boolean>
Whether to show the Bookingmood branding
show_closed_as
Filter<text>
show_past
Filter<boolean>
Whether to show past dates in the calendar
show_pending_as
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
show_reviews
Filter<boolean>
stay_expanded
Filter<boolean>
Whether the date-selection section should stay expanded after selecting dates
title
Filter<text>
Title of the widget
type
Filter<text>
Type of the widget, either calendar
, timeline
, inventory
or search
.
visible_months
Filter<boolean[]>
List of months that are visible in the calendar (deprecated).
Partial<Widget>
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 '{}'