Get all properties

GET /property

Retrieve all properties for a given company.

Query parameters

companyID integer Required

Responses

200 application/json

List of properties
Hide response attributes Show response attributes object
- propertyID integer
- nickname string
- streetNumber string
- routes string
- city string
- country string
- postalCode string
- formattedAddress string
- types string
- squareFootage integer
- yearBuild integer
- stateID integer
- countryID integer
- clientID integer
- companyID integer
- IsBilling boolean
- notes string
- createdBy integer
- updatedBy integer
500

Error occurred while retrieving properties

GET /property

curl \
 -X GET http://api.example.com/property?companyID=42

Response examples (200)

[
  {
    "propertyID": 42,
    "nickname": "string",
    "streetNumber": "string",
    "routes": "string",
    "city": "string",
    "country": "string",
    "postalCode": "string",
    "formattedAddress": "string",
    "types": "string",
    "squareFootage": 42,
    "yearBuild": 42,
    "stateID": 42,
    "countryID": 42,
    "clientID": 42,
    "companyID": 42,
    "IsBilling": true,
    "notes": "string",
    "createdBy": 42,
    "updatedBy": 42
  }
]