Dossier Read
GET
dossiers/<dossier_id>
Get the dossier specified in the request path.
Request#
curl 'https://api.pricehubble.com/api/v1/dossiers/2681ea65-72e0-422b-93c9-63fd10ecb982' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer 74126eab0a9048d993bda4b1b55ae074'
Dossier response#
{
"countryCode": "BE",
"createdAt": "2022-02-28T21:15:29.416215Z",
"createdBy": "api_pricehubble.com_test",
"dealType": "sale",
"id": "a4b64f7c-9a3b-4f19-8b7b-6afa5005ac63",
"images": [],
"isValuationStale": false,
"modifiedAt": "2022-02-28T21:27:53.212103Z",
"modifiedBy": "api_pricehubble.com_test",
"sourceDossierId": "123e4567-e89b-12d3-a456-426614174000",
"property": {
"balconyArea": 15.0,
"buildingYear": 1990,
"hasLift": false,
"hasPool": false,
"hasSauna": false,
"landArea": 100.0,
"livingArea": 100.0,
"location": {
"address": {
"city": "Genk",
"houseNumber": "99",
"postCode": "3600",
"street": "Europalaan"
},
"coordinates": {
"latitude": 50.9665184,
"longitude": 5.5015689
}
},
"numberOfBathrooms": 2,
"numberOfIndoorParkingSpaces": 2,
"numberOfOutdoorParkingSpaces": 0,
"propertyType": {
"code": "house",
"subcode": "house_detached"
},
"renovationYear": 2000,
"volume": 900.0
},
"roomTourLink": "https://example.com",
"title": "My dossier title",
"valuationSale": {
"valuationConfidence": "medium",
"valuationDate": "2022-02-28",
"value": 257200,
"valueRange": {
"lower": 223800,
"upper": 290600
}
},
"valuationSaleTimeline": [
{
"valuationDate": "2019-01-01",
"value": 257100,
"valueConfidence": "medium",
"valueRange": {
"lower": 223600,
"upper": 290500
}
},
...
]
}
Response Fields#
Field | Description | Type | Remarks |
---|---|---|---|
id | string | ||
dealType | Deal type of the dossier | string | Valid values are 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 | |
modifiedBy | Username of the user that modified this dossier | string | |
description | Description of the dossier | string | maximum length: 10000, can contain HTML markup |
images | Dossier images | array of Generic Images | max items: 20 |
logo | Dossier logo filename | string | |
roomTourLink | Url for virtual tour of the property | string | |
priceStrategyDescription | User generated information about the price strategy | string | |
priceStrategyStrength | User generated information about the strengths of the property | string | |
priceStrategyWeakness | User generated information about the weaknesses of the property | string | |
selectedSaleOffers or selectedRentOffers instead. |
|||
selectedSaleOffers | The list of selected sale offers for this dossier | array of strings | example: ['05d9ab4', '18453de'] |
selectedRentOffers | The list of selected rent offers for this dossier | array of strings | example: ['05d9ab4', '18453de'] |
selectedTransactions | The list of selected transaction for this dossier | array of strings | example: ['05d9ab4', '18453de']. An exclusive transaction is indicated with the excl: prefix, example: ['excl:sourceTransactionId', 'excl:uuid']. Both the uuid and sourceTransactionId can be used. |
useSelectedOffers | Show only the selectedRentOffers & selectedSaleOffers in shared dossier and PDF. |
boolean | |
useSelectedTransactions | Show only the selectedTransactions in shared dossier and PDF. |
boolean | |
askingSalePrice | Asking price in the main currency of the dossier’s country | integer | |
valuationOverrideSalePrice | Custom sale price valuation that overrides PriceHubble's valuation | integer | |
valuationOverrideSalePriceRange | Custom sale price valuation range that overrides PriceHubble's valuation | LowerUpperBound | |
valuationOverrideRentNet | Custom net rent valuation that overrides PriceHubble's valuation | integer | |
valuationOverrideRentNetRange | Custom net rent valuation range that overrides PriceHubble's valuation | LowerUpperBound | |
valuationOverrideRentGross | Custom gross rent valuation that overrides PriceHubble's valuation | integer | |
valuationOverrideRentGrossRange | Custom gross rent valuation range that overrides PriceHubble's valuation | LowerUpperBound | |
userDefinedFields | User Defined Fields | array of User Defined Fields | max items: 50 |
sourceDossierId | External source Dossier identifier | string | For matching Dossiers with external source database |
isValuationStale | Indicates whether the valuation is still relevant | boolean | |
valuationSale | Estimated sale price value of the property | Valuation | Only present if dealType is sale or is unset Only returned if Dossier Valuation was called at least once after Dossier Creation |
valuationSaleTimeline | Estimated sale price timeline of the property | array of Valuations | Only present if dealType is sale or is unset Only returned if Dossier Valuation was called at least once after Dossier Creation |
valuationRentNet | Estimated monthly net rent value of the property | Valuation | Only present if dealType is rent or is unset,and if net rent valuations are supported in the current country Only returned if Dossier Valuation was called at least once after Dossier Creation |
valuationRentNetTimeline | Estimated monthly net rent timeline of the property | array of Valuations | Only present if dealType is rent or is unset,and if net rent valuations are supported in the current country Only returned if Dossier Valuation was called at least once after Dossier Creation |
valuationRentGross | Estimated monthly gross rent value of the property | Valuation | Only present if dealType is rent or is unset,and if gross rent valuations are supported in the current country Only returned if Dossier Valuation was called at least once after Dossier Creation |
valuationRentGrossTimeline | Estimated monthly gross rent timeline of the property | array of Valuations | Only present if dealType is rent or is unset,and if gross rent valuations are supported in the current country Only returned if Dossier Valuation was called at least once after Dossier Creation |