BRbreezeway

List properties

get/property/external-id

Request

  • Base URL
    https://api.breezeway.io/public/inventory/v1
  • URL
    https://api.breezeway.io/public/inventory/v1/property/external-id
  • Auth
    API key in header Authorization

Query parameters

reference_company_idstring

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

Response

200

address1string
address2unknown
buildingunknown
citystring
company_idinteger
countrystring
displaystring
idinteger
latitudenumber
longitudenumber
namestring
reference_company_idunknown
reference_external_property_idstring
reference_property_idstring
statestring
statusstring
zipcodestring

Example response

[
  {
    "address1": "118 Walnut St",
    "city": "Auburn",
    "company_id": 4,
    "country": "us",
    "display": "Peyto's Home",
    "id": 8542,
    "latitude": 42.9307671,
    "longitude": -76.5427852,
    "name": "John's Home",
    "notes": {
      "general": "new note 123"
    },
    "reference_external_property_id": "john_home",
    "reference_property_id": "john_home",
    "state": "NY",
    "status": "active",
    "zipcode": "13021"
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.