GET
/
v1.0.0
/
link
/
users
/
{userId}
/
vendor-accounts
/
{vendorAccountId}
/
batteries
curl --request GET \
  --url https://api.energy-hub.io/v1.0.0/link/users/{userId}/vendor-accounts/{vendorAccountId}/batteries \
  --header 'X-API-KEY: <api-key>'
{
  "totalPages": 1,
  "content": [
    {
      "isLinked": true,
      "vendor": "FRONIUS",
      "name": "My battery",
      "externalId": "8413731391660801",
      "siteName": "My Home",
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
  ],
  "totalElements": 1
}

Authorizations

X-API-KEY
string
header
required

API key used for authorization and authentication.

Path Parameters

userId
string
required

User ID

vendorAccountId
string
required

Vendor account ID

Query Parameters

page
integer
required

Zero-based page index (0..N)

Required range: x > 0
size
integer
required

The size of the page to be returned. Default value is 10. Maximum value is 100.

Required range: 1 < x < 100

Response

200
application/json
Successful operation
totalPages
integer
required

Total number of pages.

content
object[]
required

Elements in the page. If there is no elements the list will be empty.

totalElements
integer
required

Total number of elements.