v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

Retrieve property

get/property/{id}

Path parameters

idinteger required

Property ID from Breezeway system

Response

200

access_codestring

address1string

{"stackTrail":"paths:/property/{id}:get:responses:200:content:application/json:schema:properties:address2","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/property/{id}:get:responses:200:content:application/json:schema:properties:building","oasType":"schema","type":"unknown"}

citystring

company_idinteger

countrystring

displaystring

idinteger

latitudenumber

longitudenumber

namestring

{"stackTrail":"paths:/property/{id}:get:responses:200:content:application/json:schema:properties:reference_company_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/property/{id}:get:responses:200:content:application/json:schema:properties:reference_external_property_id","oasType":"schema","type":"unknown"}

{"stackTrail":"paths:/property/{id}:get:responses:200:content:application/json:schema:properties:reference_property_id","oasType":"schema","type":"unknown"}

statestring

statusstring

zipcodestring

Example response

{
  "access_code": "1234",
  "address1": "Example Address 3",
  "city": "Clark",
  "company_id": 4,
  "country": "us",
  "display": "Example Test Property",
  "groups": [
    {
      "id": 11223,
      "name": "Test Group Item"
    }
  ],
  "id": 325334,
  "latitude": 44.874834,
  "longitude": -97.734746,
  "name": "Example Test Property",
  "notes": {
    "access": "access note",
    "general": "general public note",
    "wifi": "wifi note",
    "about": "Near railway station, this property offers great connection with the rest of the state",
    "direction": "Near railway station",
    "trash_info": "Every Tuesday ay 6am"
  },
  "state": "SD",
  "status": "active",
  "zipcode": "57225"
}