Sites

Retrieves all sites associated with the authenticated user

Scoped API keys require sites:read and effective site access.

API key: requires the sites:read scope.

get/v1/sites

Request

  • Base URL
    https://api.voltview.co.uk
  • Auth
    • API key in header x-api-key
    • or HTTP bearer

Response

Sites retrieved successfully

idstring

Site identifier

namestring

Site name

addressstring

Site address

postcodestring

Site postcode

regionstring

Geographic region

floorAreanumber

Floor area in square meters

buildingTypestring

Type of building

meterCountinteger

Number of meters at the site

utilitiesstring[]

Utilities available at the site

status'ACTIVE' | 'INACTIVE'

Site status

Changes

    • info

      the endpoint scheme security apiKeyAuth was added to the API

    • info

      the endpoint scheme security sessionJwt was added to the API

    • breaking

      the response property / became optional for the status

    2 more changes in this revision