availability.query
read-only
Check room availability for a date range. Returns rooms (by type and room name) that are NOT blocked for any night in [checkIn, checkOut). Optionally filter by roomType. Each result includes the room id, name, type, and the current price from the default rate plan for checkIn (if set).
Input parameters
| Field | Type | Required | Notes |
|---|---|---|---|
checkIn | string | yes | First night, YYYY-MM-DD. |
checkOut | string | yes | Departure date (exclusive), YYYY-MM-DD. |
roomType | string | no | Filter to a specific room type (rooms.type). |
Output fields
| Field | Type | Required | Notes |
|---|---|---|---|
available | array of object | yes | |
available.roomId | string | yes | |
available.roomName | string | yes | |
available.roomType | string · nullable | yes | |
available.priceCents | integer · nullable | yes | Price for checkIn night, if set. |
available.currency | string · nullable | yes |