Viewings: list

Return information about all Viewings in a company. You can filter by Viewing Id, Branch Id, Property Id, Applicant Id and Viewing modified date.

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

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/viewings?branchid={branchid}&applicantId={applicantId}&modifiedDate={MM/DD/YYYY}&propertyId={propertyId} --header "Authorization: Bearer MTQ0NjJkZmQ5OTM2NDE1ghNNBiuyUYUN"

Query Parameters

viewingsId

long

The Viewing's ID

branchid

int

The Branch's ID

propertyId

long

The Property's ID

applicantId

long

The Applicant's ID

modifiedDate

string

The Viewing modified date. Format: MM/DD/YYYY

Response

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

Example response:

HTTPS 200 OK Content-Type: Viewing/json { "Viewings": [ { "ViewingsId": long, "CalendarEventId": long, "ApplicantAddressId": long, "Lettings": boolean "Sales": boolean "AllDayEvent": boolean "Title": "string", "AdditionalNotes": "string", "Private": boolean "EventType": "string", "LandlordConfirmed": boolean, "ApplicantConfirmed": boolean, "TenantConfirmed": boolean, "ModifiedDate": "date", "details": { "ApplicantFullName": "string", "viewinfstatusname": "string", "confirmed": boolean "PropertyId": long, "PropertyAddress": "string", "ApplicantId": long, }, "feedback": { "ViewingFeedbackId": long, "LocationStar": long, "ValueForMoneyStar": long, "AttributesStar": long, "PrivateNotes": "string", "PublicNotes": "string", "StartDate": "date", "EndDate": "date", }, } ] }