Property

Retrieve A Property By Code

Get property by code

get/v1/property/code/{property_code}

Request

  • Base URL: https://api.imobzi.app
  • URL: https://api.imobzi.app/v1/property/code/{property_code}
  • Auth: API key in header X-Imobzi-Secret

Path parameters

property_codestring required

Query parameters

namespacestring nullable
dependencies_on_editboolean nullable
member_databasestring nullable

Response

Successful Response

statusstring required
codestring required
neighborhoodstring required
deal_stagestring required
alternative_codestring required
updated_atstring required
bedroominteger required
site_publishboolean required
property_typestring required
vacation_rentalboolean required
building_namestring required
citystring required
bathroominteger required
areanumber required
lot_areanumber required
zipcodestring required
suiteinteger required
stagestring required
rental_valuenumber required
member_register_codestring required
db_idstring required
descriptionstring required
finalitystring required
addressstring required
activeboolean required
buildingboolean required
address_complementstring required
countrystring required
created_atstring required
property_situationstring required
sale_valuenumber required
garageinteger required
useful_areanumber required
key_idstring required
site_publish_priceboolean required
site_publish_rental_priceboolean nullable
site_publish_sale_priceboolean nullable
available_digital_real_estateboolean required
fiscal_registration_numberstring nullable
cib_codestring nullable
vacation_min_valuenumber nullable
vacation_max_valuenumber nullable

Changes

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