v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

List reservations

get/reservation

Query parameters

property_idinteger[]

Filters reservations by provided Breezeway property IDs

company_idinteger[]

Filters reservations by provided Breezeway company IDs (cross-company access required)

checkin_date_ltstring date

Retrieve reservations with a check-in date less than the specified date.

checkin_date_lestring date

Retrieve reservations with a check-in date less than or equal to the specified date.

checkin_date_gtstring date

Retrieve reservations with a check-in date greater than the specified date.

checkin_date_gestring date

Retrieve reservations with a check-in date greater than or equal to the specified date.

checkout_date_ltstring date

Retrieve reservations with a checkout date less than the specified date.

checkout_date_lestring date

Retrieve reservations with a checkout date less than or equal to the specified date.

checkout_date_gtstring date

Retrieve reservations with a checkout date greater than the specified date.

checkout_date_gestring date

Retrieve reservations with a checkout date greater than or equal to the specified date.

created_at_ltstring date

Filter by creation date less than the specified date-time.

created_at_lestring date

Filter by creation date less than or equal to the specified date-time.

created_at_gtstring date

Filter by creation date greater than the specified date-time.

created_at_gestring date

Filter by creation date greater than or equal to the specified date-time.

updated_at_ltstring date

Filter by last updated date less than the specified date-time.

updated_at_lestring date

Filter by last updated date less than or equal to the specified date-time.

updated_at_gtstring date

Filter by last updated date greater than the specified date-time.

updated_at_gestring date

Filter by last updated date greater than or equal to the specified date-time.

limitinteger

Number of records returned per page

pageinteger

The page to return

sort_bystring

Field to sort results by

sort_orderstring

Order to sort results in ('asc' or 'desc')

Response

200

limitinteger

pageinteger

total_pagesinteger

total_resultsinteger

Example response

{
  "limit": 100,
  "page": 1,
  "results": [
    {
      "access_code": "8675309",
      "checkin_date": "2023-05-20",
      "checkin_time": "15:30:00",
      "checkout_date": "2023-05-27",
      "checkout_time": "11:00:00",
      "guests": [
        {
          "first_name": "John",
          "last_name": "Doe"
        }
      ],
      "guide_url": "https://guide.breezeway.io/szwer",
      "id": 15486273,
      "property_id": 8542,
      "reference_external_property_id": "peyto_home",
      "reference_property_id": "peyto_home",
      "reference_reservation_id": "782880112",
      "status": "active",
      "type_guest": {
        "code": "guest",
        "name": "Guest"
      },
      "type_reservation": {
        "code": "booking",
        "name": "Booking"
      },
      "type_stay": {
        "code": "guest",
        "name": "Guest"
      }
    }
  ],
  "total_pages": 1,
  "total_results": 1
}