Skip to content

Dossier Read

GET dossiers/<dossier_id>

Get the dossier specified in the request path.

Dossier response#

Field Description Type Remarks
id string
dealType Deal type of the dossier enum sale or rent
countryCode ISO country code string
property Information about the property Property
title string
createdAt Creation date string date-time example: 2021-04-08T13:19:30.683646Z
modifiedAt Last modification date string date-time example: 2021-04-08T13:19:30.683646Z
createdBy Username of the user that created this dossier string
description Description of the dossier string maximum length: 10000, can contain HTML markup
images Dossier images array of Dossier Images max items: 20
logo Dossier logo filename string
priceStrategyDescription User generated information about the price strategy string
selectedOffers The list of selected offer for this dossier array of strings example: ['05d9ab4', '18453de']
selectedTransactions The list of selected transaction for this dossier array of strings example: ['05d9ab4', '18453de']
askingSalePrice Asking price in the main currency of the dossier’s country integer
valuationOverrideSalePrice Custom sale price valuation that override PriceHubble's valuation integer
valuationOverrideSalePriceRange Custom sale price valuation range that override PriceHubble's valuation Value Range
valuationOverrideRentNet Custom net rent valuation that override PriceHubble's valuation integer
valuationOverrideRentNetRange Custom net rent valuation range that override PriceHubble's valuation Value Range
valuationOverrideRentGross Custom gross rent valuation that override PriceHubble's valuation integer
valuationOverrideRentGrossRange Custom gross rent valuation range that override PriceHubble's valuation Value Range
valuationRentGross PriceHubble's gross rent valuation integer Latest cached valuation
valuationRentGrossRange PriceHubble's gross rent range valuation Value Range Latest cached valuation
valuationRentNet PriceHubble's net rent valuation integer Latest cached valuation
valuationRentNetRange PriceHubble's net rent range valuation Value Range Latest cached valuation
valuationSalePrice PriceHubble's sale price valuation integer Latest cached valuation
valuationSalePriceRange PriceHubble's sale price range valuation Value Range Latest cached valuation
valuationDate When the last PriceHubble's valuation was done string date-time example: 2021-04-08T13:19:30.683646Z
valuationConfidenceRent Indicates the confidence of the rent valuation Confidence
valuationConfidenceSale Indicates the confidence of the rent valuation Confidence
isValuationStored Indicate if a valuation is stored boolean
isValuationStale Indicate if the stored valuation is stale boolean true if the dossier has been modified since the last valuation