The property the deal is about, with its facts as of the deal. A closed project without a property has none (404).
Path Parameters
- Type: stringidrequired
Deal id
Responses
- application/json
- application/problem+json
- application/problem+json
- application/problem+json
- application/problem+json
Request Example for get/api/v1/comps/{id}/property
curl 'https://app.propstreet.com/api/v1/comps/{id}/property' \
--header 'Authorization: Bearer YOUR_SECRET_TOKEN'
{
"propertyId": "string",
"ownProperty": true,
"pictureId": null,
"pictureUrl": null,
"isPortfolio": true,
"propertyCount": null,
"name": null,
"locality": null,
"country": null,
"location": {
"latitude": null,
"longitude": null,
"country": null,
"locality": null
},
"factsAsOf": null,
"categories": [
{
"type": "string",
"rentedArea": {
"value": 1,
"unit": "string"
},
"vacantArea": {
"value": 1,
"unit": "string"
}
}
],
"leasableArea": {
"value": 1,
"unit": "string"
},
"parcelArea": {
"value": 1,
"unit": "string"
},
"buildingRights": {
"value": 1,
"unit": "string"
},
"yearBuilt": null,
"rentedPercent": null,
"contractLengthYears": null,
"rentalIncome": {
"value": 0,
"currency": "string",
"scale": "string"
},
"netOperatingIncome": {
"value": 0,
"currency": "string",
"scale": "string"
},
"totalCosts": {
"value": 0,
"currency": "string",
"scale": "string"
}
}Previous
Adds a source: an article, a note from the activity log, or a contact or company. An
`activity` source may file a new note on a contact or company in the same call
(`note`) — what they told you — which also shows on their timeline. Answers
`201` with the whole deal and its new version, and the source's address in
`Location`. Send an `Idempotency-Key` to make a retry safe.Next
Anchors the deal on another property: an existing record of your organisation by
`propertyId`, or a new record for somebody else's building. A deal from a closed
project follows the project's property (`409`). A stale `If-Match` is `412`.