Tenants: list

Return information about all tenants in a company.

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

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/tenants
--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
{
"tenants": [
{
"tenantid": long,
"title": "string",
"forename": "string",
"surname": "string",
"companyname": "string",
"website": "string",
"phone": "string",
"workphone": "string",
"mobilephone": "string",
"email": "string",
"salutation": "string",
"source": "string",
"internalreference": "string",
"negotiator": {
"userid": long,
"name": "string",
"email": "string"
},
"branch": {
"branchid": integer,
"branchname": "string"
},
"status": "string",
"archived": boolean,
"primarytenant": boolean,
"prebooked": boolean,
"rent": decimal,
"deposit": decimal,
"holdingdeposit": decimal,
"collectionday": "string",
"nextrentdue": "date",
"rentperiod": "string",
"occupation": "string",
"employer": "string",
"ninumber": "string",
"agreementname": "string",
"renttype": "string",
"autorentinvoice": boolean,
"usealternateaddress": boolean,
"housingbenefit": boolean,
"casenumber": "string",
"hbchargedahead": boolean,
"hbchargedarrears": boolean,
"contactnotes": "string",
"tenancy": [
{
"tenancyid": long,
"startdate": "date",
"enddate": "date",
"renewalstart": "date",
"vacatingdate": "date",
"visitnextdue": "date",
"status": "string",
"propertyid": long,
"propertyfulladdress": "string",
"propertyshortaddress": "string",
}
],
"forwarding_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"
}
],
"prebooked_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"
}
],
"statement_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"
}
],
"alternateinvoice_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"
}
]
}
]
}