Core resources


Administration


Booking flow

Search availability

Find the availability of multiple units for a given date range. Filter by occupancy and attribute options.

Body

interval{ start: string, end: string }

The interval to search for availability in. If not provided, search will check each unit for a match with the other parameters.

occupancyRecord<occupancy_group_id, integer>

Filter search results by allowed occupancy.

option_idsArray<uuid>

Filter search results by attribute_options.

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

How to interpret pending events. Defaults to TENTATIVE

Responses

200

List with search results:

Array<{
  productId: uuid;
  match: boolean;
  occupancyMatches: boolean;
  optionsMatch: boolean;
  availability: "available" | "tentative" | "unavailable" | "booked" | "reserved";
  price: { min: number, max: number } | null;
}>
POST/search
curl -X POST "https://api.bookingmood.com/v1/search" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{}'
Example response
[
{
"productId": "00000000-0000-0000-0000-000000000000",
"match": false,
"occupancyMatches": true,
"optionsMatch": true,
"availability": "unavailable",
"price": {
"min": 100,
"max": 200
}
}
]