Skip to main content
GET
/
hvac
curl
curl --request GET \
  --url 'https://api.amps.ai/hvac' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'
{
  "success": true,
  "data": {
    "items": [
      {
        "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": 21.5,
          "active": true,
          "heatSetpoint": 20,
          "coolSetpoint": 24,
          "holdType": "follow_schedule",
          "mode": "auto"
        },
        "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
      },
      {
        "id": "device_hvac_002",
        "vendor": "example_vendor_b",
        "sync": {
          "available": true,
          "lastPulledAt": "2026-05-07T09:24:10.000Z"
        },
        "metadata": {
          "model": "Smart Thermostat 3",
          "source": "cache"
        },
        "state": {
          "temperature": 23.8,
          "active": false,
          "heatSetpoint": 18,
          "coolSetpoint": 22,
          "holdType": "permanent",
          "mode": "cool"
        },
        "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_mno345",
          "command": "cool",
          "state": "completed",
          "createdAt": "2026-05-07T07:55:00.000Z",
          "updatedAt": "2026-05-07T07:58:00.000Z",
          "links": {
            "self": "/actions/action_hvac_mno345"
          }
        },
        "currentSchedule": null
      }
    ],
    "pagination": {
      "limit": 10,
      "offset": 0,
      "total": 2,
      "hasMore": false
    }
  },
  "meta": {
    "requestId": "req_8a2Bf3kP",
    "environment": "sandbox",
    "timestamp": "2026-06-02T12:00:00.000Z",
    "latencyMs": 12
  }
}

Authorizations

​
x-api-key
string
header
required

Query Parameters

​
userId
string

Filter devices by userId

Example:

"user_abc123"

​
offset
number

Number of devices to skip (default: 0)

Example:

0

​
limit
number

Maximum number of devices to return (1-50, default: 10)

Example:

10

Response

HVAC devices retrieved successfully

​
success
boolean
required

Always true for success responses.

​
data
Paginated Hvac · 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.