API Documentation
Authentication
Sites
- GETList all sites
- POSTAddress lookup
- GETPeak demand for all sites
- GETAnnual consumption and emissions for all sites
- GETAnnual spend and savings for all sites
- GETTariffs for all sites
- GETInvoices for all sites
- GETReports for all sites
- GETEnergy cost data for all sites
- GETEnergy intensity for all sites
- GETStatistics for all sites
- GETEnergy recommendations
Emissions
Specific Site
- GETAnnual consumption and emissions for a specific site
- GETAnnual spend and savings for a specific site
- GETPeak demand for a specific site
- GETTariffs for a specific site
- GETReports for a specific site
- GETStatistics for a specific site
- GETEnergy intensity for a specific site
- GETEnergy cost data for a specific site
Consumption
Supplier Integration
Bill Validation
User
Fetch user profile
Retrieves the authenticated user’s profile information
GET
/
v1
/
getUser
curl --request GET \
--url https://api.voltview.co.uk/v1/getUser \
--header 'Authorization: Bearer <token>'
{
"id": "<string>",
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"organization": "<string>",
"role": "<string>"
}
Authorizations
JWT token obtained from /v1/requestToken endpoint
Response
200
application/json
User profile retrieved successfully
The response is of type object
.
curl --request GET \
--url https://api.voltview.co.uk/v1/getUser \
--header 'Authorization: Bearer <token>'
{
"id": "<string>",
"email": "jsmith@example.com",
"firstName": "<string>",
"lastName": "<string>",
"organization": "<string>",
"role": "<string>"
}
Assistant
Responses are generated using AI and may contain mistakes.