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
{
"lettings_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",
"addedDate": "date",
"ModifededDate": "date",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
},
"branch": {
"branchid": integer,
"branchname": "string"
},
"status": "string",
"archived": boolean,
"appraisal": boolean,
"commercialunit": boolean,
"vattype": "string",
"managementtype": "string",
"managementfeetype": "string",
"managementfeeamount": decimal,
"lettingfeetype": "string",
"lettingfeeamount": decimal,
"authorisedexpenseamount": decimal,
"estimatedrentalvalue": decimal,
"counciltaxband": "string",
"agreementname": "string",
"alarmed": boolean,
"entrycode": "string",
"requireshmolicence": boolean,
"hmoexpirydate": "date",
"electforrentontime": boolean,
"rentontimeenddate": "date",
"landlords": [
{
"landlordid": long,
"name": "string",
"email": "string",
"primary": boolean,
}
],
"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": {
"meters": {
"eletricmeterserialnumber": "string",
"eletricmeterlocation": "string",
"gasmeterserialnumber": "string",
"gasmeterlocation": "string",
"watermeterserialnumber": "string",
"watermeterlocation": "string",
"oilmeterserialnumber": "string",
"oilmeterlocation": "string",
"meterlocationnotes": "string",
},
"ukcouncil": "string",
"refusecollectionday": "string",
"collectionpoint": "string",
"stopcocklocation": "string",
"comments": "string",
"accessinformation": "string"
"mortgage": {
"provider": "string",
"termyears": integer,
"totalvalue": decimal,
"deposit": decimal,
"interestrate": decimal,
"monthlypayment": decimal,
"total": decimal,
},
"yield": {
"gross": decimal,
"net": decimal,
"roi": decimal,
},
},
"marketing": {
"rent": decimal,
"deposit": decimal,
"bedrooms": integer,
"bathrooms": integer,
"receptions": integer,
"currency": "string"
"advertising": {
"advertise": boolean,
"newbuild": boolean,
"dateavailablefrom": "datetime",
"boardstatus": "string",
"propertyarea": "string",
"virtualtoururl": "string",
"virtualtourtwourl": "string",
"advertisingstatus": "string",
"advertisingaddress": "string",
"advertisingurl": "string",
"pets": boolean,
"smokers": boolean,
},
"matching": {
"leaseperiod": "string",
"minlease": integer,
"maxlease": integer,
"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",
}
],
"tenancies": [
{
"tenancyid": long,
"startdate": "datetime",
"enddate": "datetime",
"archived": boolean,
"prebooked": boolean,
"primarytenant": "string",
"primarytenantemail": "string",
"agreementname": "string",
}
],
"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",
}
],
}
]
}