IntroductionAuthenticationSelecting dataFilteringSorting & pagination

Core resources

Api requestsAttribute optionsAttributesBooking detailsBooking updatesBookingsCalendar event notesCalendar event updatesCalendar eventsCapacitiesCapacity group dependenciesCapacity groupsContact bookingsContactsCoupon productsCoupon servicesCoupon usesCouponsExternal calendarsInvoicesLine item taxesLine itemsMembersMessage eventsMessage templatesMessagesOrganization calendar logsOrganizationsPaddle plansPaddle subscriptionsPaymentsPermissionsPrice calendar entriesPricelabs pricingPricing widgetsProduct attribute optionsProduct calendar logsProduct message templatesProduct reply to addressesProduct servicesProductsRefundsReply to addressesReview productsReview widget listingsReview widgetsReviewsSeasonsServicesSite listingsSite nav itemsSite pagesSite viewsSites
The site objectList sitesUpdate sites
Task assigneesTask template assigneesTask templatesTasksTaxesUser profilesWebhook notificationsWebhooksWidget analyticsWidget listingsWidgets

Booking flow

Query availabilitySearch availabilityBook

Sites

Websites, either single-unit or catalog sites.

Endpoints
GET/sitesPATCH/sites

The site object

Attributes

iduuid

Unique identifier

organization_iduuid
organizations.id

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

URL of the cover image

currencyCurrency

Currency of the site

custom_domaintext | null

Custom domain of the site

custom_htmltext
date_visibility"all" | "hide-unavailable" | "hide-closed" | "custom"

Visible dates in the calendar. Either all or available

failure_urltext
filterstext[]

Filters to show in the search bar

first_week_contains_date1 | 4 | null

First week of the year. Either 1 (first week with a Thursday) or 4 (first week with a Monday)

fonttext | null

Font of the site

ftstsvector
icontext | null

URL of the icon image

initial_date"today" | "next-open" | "next-available"

Initial date shown in the calendar

interval_wrap_style"square" | "jagged"

Style of the interval when wrapping weeks

logotext | null

URL of the logo image

logo_alttext | null

Alt text of the logo image

logo_sizeinteger | null
nameMultiLanguageString

Localized name

password_hashtext | null

Hash of the password required to access the site

pricing_versiontext
rate_location"inline" | "tooltip"

Location where rates are shown in the calendar. Either inline or tooltip

rate_visibility"all" | "available" | "none"

Visibility of rates in the calendar. Either all, available or none

redirect_urltext | null
related_productsSiteRelatedProducts | null
show_booked_as"booked" | "unavailable"
show_brandingboolean

Whether to show the Bookingmood branding

show_closed_as"closed" | "unavailable"
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_searchbarboolean
show_totalsboolean

Whether to show totals in the calendar

show_unavailable_resultsboolean
subdomaintext

Subdomain of the site

type"listing-site" | "single-unit-site"

Type of the site, either single-unit-site or listing-site

week_starts_on0 | 1 | null

First day of the week. Either 1 or 0

The site object

JSON

{
  "id": "00000000-0000-0000-0000-000000000000",
  "organization_id": "00000000-0000-0000-0000-000000000000",
  "created_at": "2026-03-12T05:24:09.754Z",
  "updated_at": "2026-03-12T05:24:09.754Z",
  "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": "",
  "custom_html": "",
  "date_visibility": "all",
  "failure_url": "__BOOKING_PAGE__",
  "filters": [
    ""
  ],
  "first_week_contains_date": 0,
  "font": "",
  "icon": "",
  "initial_date": "today",
  "interval_wrap_style": "square",
  "logo": "",
  "logo_alt": "",
  "logo_size": 0,
  "name": {
    "default": "Hello",
    "nl-NL": "Hallo"
  },
  "password_hash": "",
  "pricing_version": "V0",
  "rate_location": "inline",
  "rate_visibility": "available",
  "redirect_url": "",
  "related_products": {
    "count": 3,
    "show_address": true,
    "show_capacity": true,
    "show_price_range": true,
    "show_rating": true
  },
  "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_searchbar": true,
  "show_totals": true,
  "show_unavailable_results": true,
  "subdomain": "",
  "type": "listing-site",
  "week_starts_on": 0
}

List sites

Filters

idFilter<uuid>

Unique identifier

organization_idFilter<uuid>
organizations.id

Identifier of the organization this site 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

color_backgroundFilter<text>

Background color of the site

color_bookedFilter<text>
color_closedFilter<text>
color_errorFilter<text>

Error color of the site

color_headerFilter<text>
color_infoFilter<text>
color_primaryFilter<text>

Primary color of the site

color_textFilter<text>

Text color of the site

color_unavailableFilter<text>
color_warningFilter<text>
coverFilter<text | null>

URL of the cover image

currencyFilter<Currency>

Currency of the site

custom_domainFilter<text | null>

Custom domain of the site

custom_htmlFilter<text>
date_visibilityFilter<"all" | "hide-unavailable" | "hide-closed" | "custom">

Visible dates in the calendar. Either all or available

failure_urlFilter<text>
filtersFilter<text[]>

Filters to show in the search bar

first_week_contains_dateFilter<1 | 4 | null>

First week of the year. Either 1 (first week with a Thursday) or 4 (first week with a Monday)

fontFilter<text | null>

Font of the site

ftsFilter<tsvector>
iconFilter<text | null>

URL of the icon image

initial_dateFilter<"today" | "next-open" | "next-available">

Initial date shown in the calendar

interval_wrap_styleFilter<"square" | "jagged">

Style of the interval when wrapping weeks

logoFilter<text | null>

URL of the logo image

logo_altFilter<text | null>

Alt text of the logo image

logo_sizeFilter<integer | null>
nameFilter<MultiLanguageString>

Localized name

password_hashFilter<text | null>

Hash of the password required to access the site

pricing_versionFilter<text>
rate_locationFilter<"inline" | "tooltip">

Location where rates are shown in the calendar. Either inline or tooltip

rate_visibilityFilter<"all" | "available" | "none">

Visibility of rates in the calendar. Either all, available or none

redirect_urlFilter<text | null>
related_productsFilter<SiteRelatedProducts | null>
show_booked_asFilter<"booked" | "unavailable">
show_brandingFilter<boolean>

Whether to show the Bookingmood branding

show_closed_asFilter<"closed" | "unavailable">
show_legendFilter<boolean>

Whether to show a legend in the calendar

show_organization_description_sectionFilter<boolean>

Whether to show the organization description section

show_pending_asFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
show_pricingFilter<boolean>
show_searchbarFilter<boolean>
show_totalsFilter<boolean>

Whether to show totals in the calendar

show_unavailable_resultsFilter<boolean>
subdomainFilter<text>

Subdomain of the site

typeFilter<"listing-site" | "single-unit-site">

Type of the site, either single-unit-site or listing-site

week_starts_onFilter<0 | 1 | null>

First day of the week. Either 1 or 0

Responses

200

A list of sites with the selected columns

206

Partial Content

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

Update sites

Filters

idFilter<uuid>

Unique identifier

organization_idFilter<uuid>
organizations.id

Identifier of the organization this site 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

color_backgroundFilter<text>

Background color of the site

color_bookedFilter<text>
color_closedFilter<text>
color_errorFilter<text>

Error color of the site

color_headerFilter<text>
color_infoFilter<text>
color_primaryFilter<text>

Primary color of the site

color_textFilter<text>

Text color of the site

color_unavailableFilter<text>
color_warningFilter<text>
coverFilter<text | null>

URL of the cover image

currencyFilter<Currency>

Currency of the site

custom_domainFilter<text | null>

Custom domain of the site

custom_htmlFilter<text>
date_visibilityFilter<"all" | "hide-unavailable" | "hide-closed" | "custom">

Visible dates in the calendar. Either all or available

failure_urlFilter<text>
filtersFilter<text[]>

Filters to show in the search bar

first_week_contains_dateFilter<1 | 4 | null>

First week of the year. Either 1 (first week with a Thursday) or 4 (first week with a Monday)

fontFilter<text | null>

Font of the site

ftsFilter<tsvector>
iconFilter<text | null>

URL of the icon image

initial_dateFilter<"today" | "next-open" | "next-available">

Initial date shown in the calendar

interval_wrap_styleFilter<"square" | "jagged">

Style of the interval when wrapping weeks

logoFilter<text | null>

URL of the logo image

logo_altFilter<text | null>

Alt text of the logo image

logo_sizeFilter<integer | null>
nameFilter<MultiLanguageString>

Localized name

password_hashFilter<text | null>

Hash of the password required to access the site

pricing_versionFilter<text>
rate_locationFilter<"inline" | "tooltip">

Location where rates are shown in the calendar. Either inline or tooltip

rate_visibilityFilter<"all" | "available" | "none">

Visibility of rates in the calendar. Either all, available or none

redirect_urlFilter<text | null>
related_productsFilter<SiteRelatedProducts | null>
show_booked_asFilter<"booked" | "unavailable">
show_brandingFilter<boolean>

Whether to show the Bookingmood branding

show_closed_asFilter<"closed" | "unavailable">
show_legendFilter<boolean>

Whether to show a legend in the calendar

show_organization_description_sectionFilter<boolean>

Whether to show the organization description section

show_pending_asFilter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
show_pricingFilter<boolean>
show_searchbarFilter<boolean>
show_totalsFilter<boolean>

Whether to show totals in the calendar

show_unavailable_resultsFilter<boolean>
subdomainFilter<text>

Subdomain of the site

typeFilter<"listing-site" | "single-unit-site">

Type of the site, either single-unit-site or listing-site

week_starts_onFilter<0 | 1 | null>

First day of the week. Either 1 or 0

Body

Partial<Site>

Responses

204

The updated sites with the selected columns

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