Search
Return any records in your company based on a search term.
Request - POST https://api-uat.vtopenview.com/search
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 -- POST Base URI: https://api-uat.vtopenview.com/search
--header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"
Request Body
Example request body:
Content-Type: application/json
{
"searchTerm": "string",
"showArchived": boolean
}
Response
If successful, this method returns a response body with the following structure:
Example response:
HTTPS 200 OK
Content-Type: application/json
[
{
"RecordId": integer,
"RecordType": integer,
"RecordType_Desc": "string",
"Fullname": "string",
"Forename": "string",
"Surname": "string",
"Email": "string",
"Phone": "string",
"WPhone": "string",
"MPhone": "string",
"Avatar": "string",
"Avatar2": "string",
"CompanyId": integer,
"AddressId": integer,
"ApplicantSales": boolean
"PropertyBedrooms": integer,
"PropertyBathrooms": integer,
"PropertyReceptions": integer,
"PropertySales": boolean
"PropertyLettings": boolean
"PropertyType": "string",
"PropertyAskingPrice": integer,
"PropertyAverageStarRating": integer,
"PropertyReviewCount": integer,
"PropertyReviewPercentage": integer,
"PropertyDatePeriodId": integer,
"PropertyAdvertisingPeriodName": "string",
"PropertyAdvertisingPeriodValue": integer,
"PropertyImage": "string",
"PropertyUpdatedByFullName": "string",
"PropertyLastUpdateDate": "date",
"AskingPrice": {
"AskingRent": integer,
"AdvertisingPeriod": {
"AskingRent": integer,
"PropertyAdvertisingPeriodName": "string",
"Value": integer
}
"DisplayText": "string"
},
"Address": {
"HouseNo": "string",
"Line1": "string",
"Line2": "string",
"Town": "string",
"Country": "string",
"PostCode": "string",
"CountryName": "string",
"FullUKAddress": "string"
}
}
]