v1

latestOpenAPI 3.1.02026-07-24700152.8 KB

List properties

get/property

Query parameters

company_idinteger

Fetch properties associated with the specified Breezeway company ID (cross-company access required)

limitinteger

Number of records returned per page

pageinteger

The page to return

sort_bystring

Field to sort results by

sort_orderstring

Field to sort results by

status'active' | 'inactive' | 'pending_delete'

Response

200

limitinteger
pageinteger
total_pagesinteger
total_resultsinteger

Example response

{
  "limit": 100,
  "page": 1,
  "results": [
    {
      "address1": "Example Address 123",
      "address2": "Unit 1",
      "city": "example city",
      "company_id": 4,
      "country": "us",
      "id": 328858,
      "latitude": 32.3182314,
      "longitude": -86.902298,
      "name": "Example property",
      "state": "AL",
      "status": "active",
      "zipcode": "14100"
    }
  ],
  "total_pages": 1,
  "total_results": 2
}