Skip to main content
GET
/
v1
/
sites
List all sites
curl --request GET \
  --url https://api.voltview.co.uk/v1/sites \
  --header 'x-api-key: <api-key>'
[
  {
    "id": "<string>",
    "name": "<string>",
    "address": "<string>",
    "postcode": "<string>",
    "region": "<string>",
    "floorArea": 123,
    "buildingType": "<string>",
    "meterCount": 123,
    "utilities": []
  }
]

Authorizations

​
x-api-key
string
header
required

VoltView API key

Response

Sites retrieved successfully

​
id
string

Site identifier

​
name
string

Site name

​
address
string

Site address

​
postcode
string

Site postcode

​
region
string

Geographic region

​
floorArea
number

Floor area in square meters

​
buildingType
string

Type of building

​
meterCount
integer

Number of meters at the site

​
utilities
enum<string>[]

Utilities available at the site

Available options:
ELECTRICITY,
GAS,
WATER
​
status
enum<string>

Site status

Available options:
ACTIVE,
INACTIVE