Introduction

Core resources

Attribute options
Attributes
Booking details
Booking updates
Bookings
Calendar event notes
Calendar event tasks
Calendar event updates
Calendar events
Contact bookings
Contacts
Coupon products
Coupon services
Coupon uses
Coupons
Email events
Email templates
Emails
External calendars
Invoices
Line item taxes
Line items
Members
Occupancy group dependencies
Occupancy groups
Payments
Permissions
Product attribute options
Product calendar logs
Product configurations
Product email templates
Product occupancies
Product reply to addresses
Product services
Product tasks
Products
Reply to addresses
Seasons
Service deposit moments
Service discounts
Service payment moments
Service taxes
Services
Site listings
Site nav items
Site pages
Site views
Sites
Taxes
User profiles
Webhook notifications
Webhooks
Widget listings
Widget views
Widgets

Administration

Invite member
Revoke member
Create product
Delete product

Booking flow

Query availability
Search availability
Book

Query availability

Fetch the availability of multiple units over a long period of time.

Parameters

perform_syncboolean

Whether to sync external calendars before fetching availability. Defaults to false

product_idrequiredArray<uuid>

The product IDs to fetch availability for.

show_booked_as"booked" | "unavailable"

How to interpret confirmed bookings. Defaults to unavailable

show_closed_as"closed" | "unavailable"

How to interpret blocked / closed periods. Defaults to unavailable

show_pending_as"CANCELLED" | "TENTATIVE" | "CONFIRMED"

How to interpret pending events. Defaults to TENTATIVE

Responses

200

List with availability intervals per unit: 

Array<{
  product_id: uuid;
  intervals: Array<{
    start: string;
    end: string;
    status: "available" | "tentative" | "unavailable" | "booked" | "reserved";
  }>
}>
GET/availability
curl -X GET "https://api.bookingmood.com/v1/availability?product_id=00000000-0000-0000-0000-000000000000" \
  -H "Authorization: Bearer YOUR_API_KEY"
Example response
[
{
"product_id": "00000000-0000-0000-0000-000000000000",
"intervals": [
{
"start": "2024-05-11T13:32:21.035Z",
"end": "2024-05-15T13:32:21.035Z",
"status": "unavailable"
},
{
"start": "2024-05-15T13:32:21.035Z",
"end": "2024-08-19T13:32:21.035Z",
"status": "available"
}
]
}
]