Skip to main content
GET
/
hvac
/
{deviceId}
curl
curl --request GET \
  --url 'https://api.amps.ai/hvac/device_abc123' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'
{ "success": true, "data": { "id": "device_hvac_001", "vendor": "example_vendor_a", "sync": { "available": true, "lastPulledAt": "2026-05-07T09:23:45.000Z" }, "metadata": { "model": "Smart Thermostat 4", "source": "live" }, "state": { "temperature": 18.5, "active": true, "heatSetpoint": 21, "coolSetpoint": 25, "holdType": "follow_schedule", "mode": "heat" }, "commands": { "heat": { "parameters": { "target": { "unit": "celsius", "min": 10, "max": 35 } }, "execution": [ "immediate", "scheduled", "windowed" ] }, "cool": { "parameters": { "target": { "unit": "celsius", "min": 10, "max": 35 } }, "execution": [ "immediate", "scheduled", "windowed" ] }, "idle": { "parameters": {}, "execution": [ "immediate", "scheduled" ] }, "auto": { "parameters": { "heatSetpoint": { "unit": "celsius", "min": 10, "max": 35 }, "coolSetpoint": { "unit": "celsius", "min": 10, "max": 35 } }, "execution": [ "immediate", "scheduled" ] }, "follow_schedule": { "parameters": {}, "execution": [ "immediate" ] } }, "conflictStrategies": [ "cancel_and_replace" ], "lastAction": { "id": "action_hvac_def456", "command": "heat", "state": "completed", "createdAt": "2026-05-07T08:15:00.000Z", "updatedAt": "2026-05-07T08:18:00.000Z", "links": { "self": "/actions/action_hvac_def456" } }, "currentSchedule": null }, "meta": { "requestId": "req_8a2Bf3kP", "environment": "sandbox", "timestamp": "2026-06-02T12:00:00.000Z", "latencyMs": 12 } }

Authorizations

​
x-api-key
string
header
required

Path Parameters

​
deviceId
string
required

The unique identifier for the HVAC device

Example:

"device_abc123"

Query Parameters

​
expedite
boolean

Use expedite cache with 1 minute TTL instead of normal 15 minute TTL

Example:

false

Response

HVAC state retrieved successfully

​
success
boolean
required

Always true for success responses.

​
data
HVAC Response · object
required
​
meta
Response Meta · object
required

Metadata attached to every response: the request identifier, the serving environment, the build timestamp, and the server-side latency.