Core resources
Administration
Booking flow
Websites, either single-unit or catalog sites.
id
uuid
Unique identifier
organization_id
uuid
Identifier of the organization this site 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
color_background
text
Background color of the site
color_booked
text
color_closed
text
color_error
text
Error color of the site
color_header
text
color_info
text
color_primary
text
Primary color of the site
color_text
text
Text color of the site
color_unavailable
text
color_warning
text
cover
text | null
URL of the cover image
currency
text
Currency of the site
custom_domain
text | null
Custom domain of the site
date_visibility
text
Visible dates in the calendar. Either all
or available
filters
text[]
Filters to show in the search bar
first_week_contains_date
smallint | null
First week of the year. Either 1
(first week with a Thursday) or 4
(first week with a Monday)
font
text | null
Font of the site
icon
text | null
URL of the icon image
initial_date
text
Initial date shown in the calendar
interval_wrap_style
text
Style of the interval when wrapping weeks
logo
text | null
URL of the logo image
logo_alt
text | null
Alt text of the logo image
name
jsonb
Localized name
password_hash
text | null
Hash of the password required to access the site
pricing_version
text
rate_location
text
Location where rates are shown in the calendar. Either inline
or tooltip
rate_visibility
text
Visibility of rates in the calendar. Either all
, available
or none
related_listings
integer | null
Number of related listings to show on detail pages
show_booked_as
text
show_branding
boolean
Whether to show the Bookingmood branding
show_closed_as
text
show_legend
boolean
Whether to show a legend in the calendar
show_organization_description_section
boolean
Whether to show the organization description section
show_pending_as
"CANCELLED" | "TENTATIVE" | "CONFIRMED"
show_pricing
boolean
show_totals
boolean
Whether to show totals in the calendar
show_unavailable_results
boolean
subdomain
text
Subdomain of the site
type
text
Type of the site, either single-unit-site
or listing-site
week_starts_on
smallint | null
First day of the week. Either 1
or 0
{"id": "00000000-0000-0000-0000-000000000000","organization_id": "00000000-0000-0000-0000-000000000000","created_at": "2024-05-19T13:48:47.920Z","updated_at": "2024-05-19T13:48:47.920Z","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}
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this site 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
color_background
Filter<text>
Background color of the site
color_booked
Filter<text>
color_closed
Filter<text>
color_error
Filter<text>
Error color of the site
color_header
Filter<text>
color_info
Filter<text>
color_primary
Filter<text>
Primary color of the site
color_text
Filter<text>
Text color of the site
color_unavailable
Filter<text>
color_warning
Filter<text>
cover
Filter<text>
URL of the cover image
currency
Filter<text>
Currency of the site
custom_domain
Filter<text>
Custom domain of the site
date_visibility
Filter<text>
Visible dates in the calendar. Either all
or available
filters
Filter<text[]>
Filters to show in the search bar
first_week_contains_date
Filter<smallint>
First week of the year. Either 1
(first week with a Thursday) or 4
(first week with a Monday)
font
Filter<text>
Font of the site
icon
Filter<text>
URL of the icon image
initial_date
Filter<text>
Initial date shown in the calendar
interval_wrap_style
Filter<text>
Style of the interval when wrapping weeks
logo
Filter<text>
URL of the logo image
logo_alt
Filter<text>
Alt text of the logo image
name
Filter<jsonb>
Localized name
password_hash
Filter<text>
Hash of the password required to access the site
pricing_version
Filter<text>
rate_location
Filter<text>
Location where rates are shown in the calendar. Either inline
or tooltip
rate_visibility
Filter<text>
Visibility of rates in the calendar. Either all
, available
or none
related_listings
Filter<integer>
Number of related listings to show on detail pages
show_booked_as
Filter<text>
show_branding
Filter<boolean>
Whether to show the Bookingmood branding
show_closed_as
Filter<text>
show_legend
Filter<boolean>
Whether to show a legend in the calendar
show_organization_description_section
Filter<boolean>
Whether to show the organization description section
show_pending_as
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
show_pricing
Filter<boolean>
show_totals
Filter<boolean>
Whether to show totals in the calendar
show_unavailable_results
Filter<boolean>
subdomain
Filter<text>
Subdomain of the site
type
Filter<text>
Type of the site, either single-unit-site
or listing-site
week_starts_on
Filter<smallint>
First day of the week. Either 1
or 0
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"
id
Filter<uuid>
Unique identifier
organization_id
Filter<uuid>
Identifier of the organization this site 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
color_background
Filter<text>
Background color of the site
color_booked
Filter<text>
color_closed
Filter<text>
color_error
Filter<text>
Error color of the site
color_header
Filter<text>
color_info
Filter<text>
color_primary
Filter<text>
Primary color of the site
color_text
Filter<text>
Text color of the site
color_unavailable
Filter<text>
color_warning
Filter<text>
cover
Filter<text>
URL of the cover image
currency
Filter<text>
Currency of the site
custom_domain
Filter<text>
Custom domain of the site
date_visibility
Filter<text>
Visible dates in the calendar. Either all
or available
filters
Filter<text[]>
Filters to show in the search bar
first_week_contains_date
Filter<smallint>
First week of the year. Either 1
(first week with a Thursday) or 4
(first week with a Monday)
font
Filter<text>
Font of the site
icon
Filter<text>
URL of the icon image
initial_date
Filter<text>
Initial date shown in the calendar
interval_wrap_style
Filter<text>
Style of the interval when wrapping weeks
logo
Filter<text>
URL of the logo image
logo_alt
Filter<text>
Alt text of the logo image
name
Filter<jsonb>
Localized name
password_hash
Filter<text>
Hash of the password required to access the site
pricing_version
Filter<text>
rate_location
Filter<text>
Location where rates are shown in the calendar. Either inline
or tooltip
rate_visibility
Filter<text>
Visibility of rates in the calendar. Either all
, available
or none
related_listings
Filter<integer>
Number of related listings to show on detail pages
show_booked_as
Filter<text>
show_branding
Filter<boolean>
Whether to show the Bookingmood branding
show_closed_as
Filter<text>
show_legend
Filter<boolean>
Whether to show a legend in the calendar
show_organization_description_section
Filter<boolean>
Whether to show the organization description section
show_pending_as
Filter<"CANCELLED" | "TENTATIVE" | "CONFIRMED">
show_pricing
Filter<boolean>
show_totals
Filter<boolean>
Whether to show totals in the calendar
show_unavailable_results
Filter<boolean>
subdomain
Filter<text>
Subdomain of the site
type
Filter<text>
Type of the site, either single-unit-site
or listing-site
week_starts_on
Filter<smallint>
First day of the week. Either 1
or 0
Partial<Site>
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 '{}'