Property: list

Return information about all properties in a company.

Request - GET https://api-uat.vtopenview.com/property

DO NOT supply a request body and a request parameter with this method.
You will need to include your access token upon making a request. For more information, see the authentication and authorization page.

Example request with authorization:

curl -- GET Base URI: https://api-uat.vtopenview.com/property
--header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Response

If successful, this method returns a response body with the following structure:

Example response:

HTTPS 200 OK
Content-Type: application/json
{
"sales_properties": [
{
"propertyid": long,
"GUID": "GUID",
"address": {
"houseno": "string",
"address1": "string",
"address2": "string",
"town": "string",
"county": "string",
"postcode": "string",
"latitude": decimal,
"longitude": decimal,
"geocodingverified": boolean,
"countryname": "string",
"countrydisplayname": "string",
"fulladdress": "string",
"shortaddress": "string"
},
"internalreference": "string",
"archivedDate": "date",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
},
"branch": {
"branchid": integer,
"branchname": "string"
},
"status": "string",
"archived": boolean,
"appraisal": boolean,
"priceprefix": "string",
"price": decimal,
"pricecurrency": "string",
"instructeddate": "date",
"contracttype": "string",
"contractexpires": "date",
"feeamount": decimal,
"feetype": "string",
"commissionamount": decimal,
"commissiontype": "string",
"vendors": [
{
"vendorid": long,
"name": "string",
"email": "string",
"primary": boolean,
}
],
"solicitor": [
{
"instructed": boolean,
"instructeddate": "date",
"solicitor": "string",
"contact": "string",
"address": "string",
"contactemail": "string",
"contactphone": "string",
"contactmobile": "string",
"contactfax": "string",
}
],
"compliance": {
"safetychecks": [
{
"type": "string",
"responsability": "string",
"duedate": "date",
"boilerservice": boolean,
}
],
"energyefficiencycurrent": integer,
"energyefficiencypotential": integer,
"enviromentalimpactcurrent": integer,
"enviromentalimpactpotential": integer,
"epc": {
"rrnnumber": "string",
"expirydate": "date",
},
"notes": "string"
},
"information": {
"ukcouncil": "string",
"counciltaxband": "string",
"occupier": "string",
"occupierothername": "string",
"tenure": {
"type": "string",
"expirydate": "string",
},
"alarm": {
"alarmed": boolean,
"alarmcode": "string",
},
},
"marketing": {
"priceprefix": "string",
"price": decimal,
"bedrooms": integer,
"bathrooms": integer,
"receptions": integer,
"currency": "string"
"advertising": {
"advertise": boolean,
"newbuild": boolean,
"propertyarea": "string",
"virtualtoururl": "string",
"virtualtourtwourl": "string",
"advertisingstatus": "string",
"advertisingaddress": "string",
"advertisingurl": "string",
},
"matching": {
"propertytype": "string",
"propertytypezoopla": "string",
"propertyattributes": [
{
"attribute": "string",
}
],
},
"descriptions": {
"main": "string",
"summary": "string",
"extra1": "string",
"extra2": "string",
"advertisingsmsmessage": "string",
},
"others": {
"landusage": "string",
"size": integer,
"measurementunits": "string",
"directions": "string",
},
"keyfeatures": [
{
"description": "string",
"addedby": "string",
"dateadded": "datetime",
}
],
},
"media": [
{
"type": "string",
"caption": "string",
"urlprimary": "string",
"urlsmall": "string",
"urllarge": "string",
"room": "string",
"roomtype": "string",
"dateadded": "datetime",
}
],
"keys": [
{
"keynumber": "string",
"alias": "string",
"notes": "string",
"urlimage": "string",
}
],
"statistics": [
{
"propertyId": long,
"propertyStatusId":integer,
"instructedDate": "datetime",
"lastContactedDate": "datetime",
"firstViewingDate": "datetime",
"lastViewingDate": "datetime",
"totalViewings":integer,
"totalViewings":integer,
"firstOffer":integer,
"lastOffer":integer,
"totalOffers":integer,
"withdrawnDate": "datetime",
"exchangedDate": "datetime",
"completedDate": "datetime",
"acceptedDate": "datetime",
"fallenThroughDate": "datetime",
"invoicedDate": "datetime",
}
],
}
]
}