GET
/
v1.0.0
/
users
/
{userId}
/
hvacs
/
{hvacId}
/
commands
curl --request GET \
  --url https://api.energy-hub.io/v1.0.0/users/{userId}/hvacs/{hvacId}/commands \
  --header 'X-API-KEY: <api-key>'
[
  {
    "createdAt": "2023-11-07T05:31:56Z",
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "state": "PENDING",
    "type": "SET_TEMPERATURE",
    "userId": "896f9d5a-b618-48a2-98ae-957059bf1bc9",
    "deviceId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
]

Authorizations

​
X-API-KEY
string
header
required

API key used for authorization and authentication.

Path Parameters

​
userId
string
required

User ID

​
hvacId
string
required

HVAC ID

Response

200
application/json
Successful operation
​
createdAt
string
required

The timestamp when command is created.

​
id
string
required

The ID of the command.

​
state
enum<string>
required

The state of the command.

  • PENDING - Command is waiting to be executed.
  • FAILED - Execution of command has failed.
  • EXECUTED - Command has been executed successfully.
Available options:
PENDING,
EXECUTED,
FAILED
​
type
enum<string>
required

The name of the command type to execute.

Available options:
SET_TEMPERATURE,
SET_MODE,
SET_SCHEDULE
​
userId
string
required

The ID of the user.

​
deviceId
string
required

The ID of the vehicle.

HVAC image for userSubmit command to change mode of HVAC