Landlords: list

Return information about all landlords in a company.

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

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/landlords
--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
{
"landlords": [
{
"landlordid": long,
"title": "string",
"forename": "string",
"surname": "string",
"companyname": "string",
"website": "string",
"phone": "string",
"workphone": "string",
"mobilephone": "string",
"email": "string",
"salutation": "string",
"agreementname": "string",
"source": "string",
"lettingsreason": "string",
"internalreference": "string",
"archivedDate": "date",
"addedDate": "date",
"modifiedDate": "date",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
},
"branch": {
"branchid": integer,
"branchname": "string"
},
"status": "string",
"overseas": "string",
"taxenabled": "string",
"excludefrompayments": boolean,
"registrationnumber": "string",
"cnrnumber": "string",
"cnrapprovaldate": "string",
"taxrate": decimal,
"vatregistration": "string",
"hmrcduedate": "date",
"statement": "string",
"sendstatementvia": "string",
"safedepositstype": "string",
"safedepositsregnumber": "string",
"financialnotes": "string",
"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"
},
"properties": [
{
"propertyid": long,
"shortaddress": "string",
"fulladdress": "string",
"numberoftenants": integer,
"rent": decimal,
"deposit": decimal,
"bedrooms": integer,
"bathrooms": integer,
"receptions": integer,
}
],
"GDPR": {
"donotcontact": boolean,
"Email": boolean,
"letter": boolean,
"sms": boolean,
"phone": boolean",
"allowthirdparty":boolean,
"allowmarketing": boolean,
}
}
]
}