v1

latestOpenAPI 3.0.02026-07-26155147.1 KB
Properties

List all properties

Returns a list of properties from your organization.

get/properties

Query parameters

pageinteger

Content's page

limitinteger

Max results per page (Maximum: 50)

search[property_types][]string[]
[
  "apartment"
]
updated_afterstring date-time
updated_beforestring date-time
operation_type'sale' | 'rental' | 'temporary_rental'
min_priceinteger

operation_type is required

max_priceinteger

operation_type is required

min_bedroomsinteger
min_bathroomsinteger
min_parking_spacesinteger
min_construction_sizeinteger

construction size in square meters

max_construction_sizeinteger

construction size in square meters

min_lot_sizeinteger

lot size in square meters

max_lot_sizeinteger

lot size in square meters

{
  "updated_after": "2020-03-01T23:26:53.402Z",
  "updated_before": "2025-03-01T23:26:53.402Z",
  "min_price": 500000,
  "max_price": 3000000,
  "min_bedrooms": 1,
  "min_bathrooms": 1,
  "min_parking_spaces": 1,
  "min_construction_size": 100,
  "max_construction_size": 1000,
  "min_lot_size": 100,
  "max_lot_size": 1000
}
search[statuses][]string[]
search[sort_by]string[]

Response

Successful property list request

Example response

{
  "pagination": {
    "limit": 20,
    "page": 1,
    "total": 1
  },
  "content": [
    {
      "agent": "John Smith",
      "public_id": "EB-XXX123",
      "title": "Beautiful property in Condesa",
      "title_image_full": "http://assets.easybroker.com/property_images/123/456/EB-010101.jpg",
      "title_image_thumb": "http://assets.easybroker.com/property_images/123/456/EB-010101.jpg?version=1713484800&width=200",
      "location": "Condesa, Cuauhtemoc",
      "property_type": "Apartment",
      "updated_at": "2020-03-01T23:26:53.402Z",
      "show_prices": true,
      "share_commission": true,
      "operations": [
        {
          "amount": 500000,
          "formatted_amount": "$500,000 USD",
          "currency": "USD",
          "commission": {
            "type": "amount",
            "value": 10000,
            "currency": "USD"
          }
        }
      ]
    }
  ]
}