HEM Systems

List HEM systems

Request

List all the HEM systems that the authorization token has access to.

Security

oauth2(Required scopes: home_energy:read)

Query

page_beforestring[a-z]{4}[A-Z\d]{26}

Return results from the page after this ID.

Example:page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR

page_afterstring[a-z]{4}[A-Z\d]{26}

Return results from the page before this ID.

Example:page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR

page_sizeinteger, [ 1 .. 100 ]

Specify the number of results to return per page.

Default:25

Example:page_size=10

EvEnergy-Versionnumber

Specify the version of this endpoint to use.

Value:2

EvEnergy-Userstringuser[A-Z\d]{26}

If the client is authenticated using Client Credentials, setting EvEnergy-User to a valid user ID allows requests to be made as if you were directly authenticated as that user.

Example:user01HN2NJ9NMRZBXT1H6FT9N7735

curl -i -X GET \
  'https://developers.ev.energy/_mock/ev.energy-api-v2/hem_systems?page_before=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_after=xmpl01HNFZM7Q8FXASZXYZ6XM3TQRR&page_size=10' \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'EvEnergy-User: user01HN2NJ9NMRZBXT1H6FT9N7735' \
  -H 'EvEnergy-Version: 2'

Responses

Returns a list of HEM (Home Energy Management) systems.

Headers

Linkstring

Provides links to the previous and next pages of data, if they exist.

Example:"<https://api.ev.energy/v2/vehicles?page_size=25&page_before=vhcl01HRFF3SEVSCRAV9B3CHVDFN0H>; rel=\"previous\", <https://api.ev.energy/v2/vehicles?pag

EvEnergy-Versionnumber

Indicates the version of the API that generated this response. If EvEnergy-Version was not specified in the request, this will be your OAuth application's default version.

Value:2

X-RateLimit-Limitnumber

The maximum number of requests that can be made to this endpoint per hour. Defaults to 1000 but may vary per client.

Default:1000

X-RateLimit-Remainingnumber

The number of requests remaining until this client's rate limit is reached.

Default:999

RetryAfternumber

The number of seconds until this client's requests will not be rate limited.

Default:3600

Bodyapplication/json

Array [

idstringhems[A-Z\d]{26}read-onlyrequired

Unique identifier for the given HEM system.

Example:"hems01J5DCXX8DMJDJYGVR1DW4J7AA"

urlstring, (uri)read-onlyrequired

Example:"https://api.ev.energy/v2/hem_systems/hems01J5DCXX8DMJDJYGVR1DW4J7AA"

created_atstring, (date-time)read-onlyrequired

The date and time when this HEM system was created.

Example:"2024-03-15T14:22:33.123456Z"

]

Response