Users: list
Return information about Users by User email and branch Id.
Request - GET https://api-uat.vtopenview.com/Users?email={email}&branchid={branchId}
You will need to supply UserId on your request parameters 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/Users?email={email}&branchid={branchId}
--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
{
"Users": [
{
"userId": long,
"title": "string",
"firstname": "string",
"lastname": "string",
"email": "string",
"phoneNumber": "string",
"workNumber": "string",
"mobileNumber": "string",
"salutation": "string",
"createdDate": "datetime",
"address": {
"houseno": "string",
"address1": "string",
"address2": "string",
"town": "string",
"county": "string",
"postcode": "string",
"latitude": float,
"longitude": float,
"geocodingverified": float,
"countryname": "string",
"countryDisplayName": "string",
"fulladdress": "string",
"shortaddress": "string"
},
"vendor": {
"isArchived": boolean,
},
"landlord": {
"isArchived": boolean,
},
"applicant": {
"isArchived": boolean,
"isLettings": boolean,
"isSales": boolean
}
}
]
}