Core resources
Administration
Booking flow
Websites, either single-unit or catalog sites.
iduuid Unique identifier
organization_iduuid Identifier of the organization this site 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
color_backgroundtext Background color of the site
color_bookedtext color_closedtext color_errortext Error color of the site
color_headertext color_infotext color_primarytext Primary color of the site
color_texttext Text color of the site
color_unavailabletext color_warningtext covertext | nullURL of the cover image
currencytext Currency of the site
custom_domaintext | nullCustom domain of the site
date_visibilitytext Visible dates in the calendar. Either all or available
filterstext[] Filters to show in the search bar
first_week_contains_datesmallint | nullFirst week of the year. Either 1 (first week with a Thursday) or 4 (first week with a Monday)
fonttext | nullFont of the site
icontext | nullURL of the icon image
initial_datetext Initial date shown in the calendar
interval_wrap_styletext Style of the interval when wrapping weeks
logotext | nullURL of the logo image
logo_alttext | nullAlt text of the logo image
namejsonb Localized name
password_hashtext | nullHash of the password required to access the site
pricing_versiontext rate_locationtext Location where rates are shown in the calendar. Either inline or tooltip
rate_visibilitytext Visibility of rates in the calendar. Either all, available or none
related_listingsinteger | nullNumber of related listings to show on detail pages
show_booked_astext show_brandingboolean Whether to show the Bookingmood branding
show_closed_astext show_legendboolean Whether to show a legend in the calendar
show_organization_description_sectionboolean Whether to show the organization description section
show_pending_as"CANCELLED" | "TENTATIVE" | "CONFIRMED" show_pricingboolean show_totalsboolean Whether to show totals in the calendar
show_unavailable_resultsboolean subdomaintext Subdomain of the site
typetext Type of the site, either single-unit-site or listing-site
week_starts_onsmallint | nullFirst day of the week. Either 1 or 0
{"id": "00000000-0000-0000-0000-000000000000","organization_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-12-21T16:09:43.779Z","updated_at": "2024-12-21T16:09:43.779Z","autocomplete_date_selection": false,"color_background": "#fff","color_booked": "#faa5a5","color_closed": "#f5f5f5","color_error": "#faa5a5","color_header": "#000","color_info": "#2463eb","color_primary": "#22c55e","color_text": "#000","color_unavailable": "#faa5a5","color_warning": "#a75c03","cover": "","currency": "USD","custom_domain": "","date_visibility": "all","filters": [""],"first_week_contains_date": 0,"font": "","icon": "","initial_date": "today","interval_wrap_style": "square","logo": "","logo_alt": "","name": {},"password_hash": "","pricing_version": "V0","rate_location": "inline","rate_visibility": "available","related_listings": 6,"show_booked_as": "unavailable","show_branding": true,"show_closed_as": "closed","show_legend": true,"show_organization_description_section": true,"show_pending_as": "TENTATIVE","show_pricing": true,"show_totals": true,"show_unavailable_results": true,"subdomain": "","type": "listing-site","week_starts_on": 0}
idFilter<>Unique identifier
organization_idFilter<>Identifier of the organization this site 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
color_backgroundFilter<>Background color of the site
color_bookedFilter<>color_closedFilter<>color_errorFilter<>Error color of the site
color_headerFilter<>color_infoFilter<>color_primaryFilter<>Primary color of the site
color_textFilter<>Text color of the site
color_unavailableFilter<>color_warningFilter<>coverFilter<>URL of the cover image
currencyFilter<>Currency of the site
custom_domainFilter<>Custom domain of the site
date_visibilityFilter<>Visible dates in the calendar. Either all or available
filtersFilter<>Filters to show in the search bar
first_week_contains_dateFilter<>First week of the year. Either 1 (first week with a Thursday) or 4 (first week with a Monday)
fontFilter<>Font of the site
iconFilter<>URL of the icon image
initial_dateFilter<>Initial date shown in the calendar
interval_wrap_styleFilter<>Style of the interval when wrapping weeks
logoFilter<>URL of the logo image
logo_altFilter<>Alt text of the logo image
nameFilter<>Localized name
password_hashFilter<>Hash of the password required to access the site
pricing_versionFilter<>rate_locationFilter<>Location where rates are shown in the calendar. Either inline or tooltip
rate_visibilityFilter<>Visibility of rates in the calendar. Either all, available or none
related_listingsFilter<>Number of related listings to show on detail pages
show_booked_asFilter<>show_brandingFilter<>Whether to show the Bookingmood branding
show_closed_asFilter<>show_legendFilter<>Whether to show a legend in the calendar
show_organization_description_sectionFilter<>Whether to show the organization description section
show_pending_asFilter<>show_pricingFilter<>show_totalsFilter<>Whether to show totals in the calendar
show_unavailable_resultsFilter<>subdomainFilter<>Subdomain of the site
typeFilter<>Type of the site, either single-unit-site or listing-site
week_starts_onFilter<>First day of the week. Either 1 or 0
200A list of sites with the selected columns
206Partial Content
GET/sitescurl -X GET "https://api.bookingmood.com/v1/sites?select=*" \ -H "Authorization: Bearer YOUR_API_KEY"
idFilter<>Unique identifier
organization_idFilter<>Identifier of the organization this site 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
color_backgroundFilter<>Background color of the site
color_bookedFilter<>color_closedFilter<>color_errorFilter<>Error color of the site
color_headerFilter<>color_infoFilter<>color_primaryFilter<>Primary color of the site
color_textFilter<>Text color of the site
color_unavailableFilter<>color_warningFilter<>coverFilter<>URL of the cover image
currencyFilter<>Currency of the site
custom_domainFilter<>Custom domain of the site
date_visibilityFilter<>Visible dates in the calendar. Either all or available
filtersFilter<>Filters to show in the search bar
first_week_contains_dateFilter<>First week of the year. Either 1 (first week with a Thursday) or 4 (first week with a Monday)
fontFilter<>Font of the site
iconFilter<>URL of the icon image
initial_dateFilter<>Initial date shown in the calendar
interval_wrap_styleFilter<>Style of the interval when wrapping weeks
logoFilter<>URL of the logo image
logo_altFilter<>Alt text of the logo image
nameFilter<>Localized name
password_hashFilter<>Hash of the password required to access the site
pricing_versionFilter<>rate_locationFilter<>Location where rates are shown in the calendar. Either inline or tooltip
rate_visibilityFilter<>Visibility of rates in the calendar. Either all, available or none
related_listingsFilter<>Number of related listings to show on detail pages
show_booked_asFilter<>show_brandingFilter<>Whether to show the Bookingmood branding
show_closed_asFilter<>show_legendFilter<>Whether to show a legend in the calendar
show_organization_description_sectionFilter<>Whether to show the organization description section
show_pending_asFilter<>show_pricingFilter<>show_totalsFilter<>Whether to show totals in the calendar
show_unavailable_resultsFilter<>subdomainFilter<>Subdomain of the site
typeFilter<>Type of the site, either single-unit-site or listing-site
week_starts_onFilter<>First day of the week. Either 1 or 0
Partial<Site>204The updated sites with the selected columns
PATCH/sitescurl -X PATCH "https://api.bookingmood.com/v1/sites" \
-H "Authorization: Bearer YOUR_API_KEY" \
-d '{}'