GET /property/clientAndProperty

Retrieve clients and their first property for a given company.

Query parameters

  • companyID integer Required

Responses

  • 200 application/json

    List of clients with their first property

    Hide response attributes Show response attributes object
    • clientID integer
    • companyID integer
    • properties array[object]
      Hide properties attributes Show properties 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 client and property data

GET /property/clientAndProperty 
curl \
 -X GET http://api.example.com/property/clientAndProperty?companyID=42
Response examples (200) 
[
  {
    "clientID": 42,
    "companyID": 42,
    "properties": [
      {
        "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
      }
    ]
  }
]