v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

List properties

get/property/external-id

Query parameters

reference_company_idstring

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

Response

200

address1string

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

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

citystring

company_idinteger

countrystring

displaystring

idinteger

latitudenumber

longitudenumber

namestring

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

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"
  }
]