Branches: list
Return information about all branches in a company.
Request - GET https://api-uat.vtopenview.com/branches
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/branches
--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
{
"branches": [
{
"branchid": integer,
"name": "string",
"email": "string",
"phone1": "string",
"phone2": "string",
"fax": "string",
"GUID": "GUID",
"logourl": "string",
"active": boolean,
"addresses": [
{
"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"
}
],
"users": [
{
"name": "string",
"email": "string",
"phone": "string",
"mobilephone": "string",
"workphone": "string",
"status": "string",
"SecurityRoleId": integer,
"SecurityRoleName": "string"
}
]
}
]
}