v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

List reservations

get/reservation/external-id

Query parameters

reference_property_idstring required

Property ID from external system

reference_company_idstring

Company ID from external system; required if using cross-company access

checkin_date_ltstring

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_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.

Response

200

access_codestring

checkin_datestring

checkin_earlyboolean

checkin_timestring

checkout_datestring

checkout_lateboolean

checkout_timestring

guide_urlstring

idinteger

{"stackTrail":"paths:/reservation/external-id:get:responses:200:content:application/json:schema:items:properties:note","oasType":"schema","type":"unknown"}

property_idinteger

reference_external_property_idstring

reference_property_idstring

{"stackTrail":"paths:/reservation/external-id:get:responses:200:content:application/json:schema:items:properties:reference_reservation_id","oasType":"schema","type":"unknown"}

statusstring

Example response

[
  {
    "access_code": "8675309",
    "checkin_date": "2021-02-07",
    "checkin_early": true,
    "checkin_time": "13:00:00",
    "checkout_date": "2021-02-10",
    "checkout_late": true,
    "checkout_time": "11:00:00",
    "guests": [
      {
        "first_name": "Teddy",
        "last_name": "Smith"
      }
    ],
    "guide_url": "https://guide.breezeway.io/szwer",
    "id": 8575867,
    "property_id": 8542,
    "reference_external_property_id": "PROP-12345",
    "reference_property_id": "PROP-12345",
    "status": "active",
    "type_guest": {
      "code": "owner",
      "name": "Owner"
    },
    "type_stay": {
      "code": "owner",
      "name": "Owner"
    }
  }
]