Search Properties

GET

/properties/search

Search for properties that have available rooms for specific check-in and check-out dates. Returns properties with room availability, average daily rate, and total quantity.

Scope Required: properties:read

Query Parameters:

• checkin_date (required): Check-in date in YYYY-MM-DD format
• checkout_date (required): Check-out date in YYYY-MM-DD format

Important Notes:

• Maximum stay period: 30 days
• For same-day availability queries, checkin and checkout must be different dates
• Only returns properties with quantity > 0 (at least one available room)
• quantity is total of all available rooms across all room types in the property
• avg_daily_rate shows the average daily rate for the entire stay period
• Prices are calculated from direct rate plans only
• Availability calculation considers:
  • Existing bookings (confirmed, checked-in)
  • Room maintenance schedules
  • Out-of-order rooms

Authorizations

• http

Parameters

Query Parameters

checkin_date

required

string format: date

Example

2025-11-19

checkout_date

required

string format: date

Example

2025-11-21

Responses

200

object

success

required

boolean

data

required

Array<object>

object

id

required

string

prefix

required

string

title

required

string

property_type

required

string

currency

required

string

timezone

required

string

quantity

required

integer

avg_daily_rate

required

number

422

Validation error

object

message

required

Errors overview.

string

errors

required

A detailed description of each field that failed validation.

object

key

additional properties

Array<string>