Property

Retrieve A List Of Properties

Show list of properties with performance improvements using parallel async calls.

get/v1/properties

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/properties
  • Auth: API key in header X-Imobzi-Secret

Query parameters

cursorstring nullable
all_brokersstring nullable
clear_notificationsstring nullable
smart_listunknown
namespacestring nullable
orderstring nullable
limitinteger nullable
show_mapboolean nullable
show_networkboolean nullable

Request body

advert_not_equalstring nullable
without_site_highlightsstring nullable
order_by_codeboolean nullable
smart_liststring nullable
search_valuestring nullable
fieldsunknown
custom_fieldsobject[] nullable
typestring nullable
intereststring nullable
search_typestring nullable
orderstring nullable
search_fieldstring nullable
tv_idstring nullable
update_last_property_seenunknown

Response

Successful Response

activeboolean required
addressstring required
address_complementstring required
alternative_codestring required
areanumber required
bathroominteger required
bedroominteger required
buildingboolean required
building_namestring required
citystring required
codestring required
countrystring required
created_atstring required
db_idstring required
deal_stagestring required
finalitystring required
garageinteger required
key_idstring required
latitudenumber required
longitudenumber nullable
lot_areanumber required
neighborhoodstring required
plus_codestring nullable
cib_codestring nullable
property_idstring nullable
property_situationstring required
property_typestring required
rental_valuenumber required
sale_valuenumber required
site_publishboolean required
site_publish_priceboolean nullable
site_publish_rental_priceboolean nullable
site_publish_sale_priceboolean nullable
site_urlstring nullable
stagestring required
statestring required
statusstring required
suiteinteger required
updated_atstring required
useful_areanumber required

Changes

No recorded changes to this operation across all 1 revision of this API.