Get this HVAC device's schedule

GET

hvac

{deviceId}

schedule

curl

curl --request GET \
  --url 'https://api.amps.ai/hvac/device_abc123/schedule' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'

const response = await fetch('https://api.amps.ai/hvac/device_abc123/schedule', {
  method: 'GET',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
  },
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/hvac/device_abc123/schedule'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
}

response = requests.get(url, headers=headers)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/hvac/{deviceId}/schedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.amps.ai/hvac/{deviceId}/schedule"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.amps.ai/hvac/{deviceId}/schedule")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amps.ai/hvac/{deviceId}/schedule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "sched_abc123",
  "deviceId": "device_abc123",
  "deviceType": "hvac",
  "state": "active",
  "timezone": "Europe/London",
  "recurrence": {
    "rule": "daily"
  },
  "slots": [
    {
      "time": "00:30",
      "duration": "PT5H",
      "command": "charge",
      "parameters": {
        "target": {
          "value": 100,
          "unit": "percent"
        }
      }
    }
  ],
  "updatedAt": "2026-06-01T12:00:00.000Z",
  "nextFireAt": "2026-06-02T00:30:00.000Z"
}

Authorizations

x-api-key

string

header

required

Path Parameters

deviceId

string

required

The unique identifier for the HVAC device.

Example:

"device_abc123"

Response

The device's active schedule, or null when none is set.

Set this HVAC device's scheduleSet or replace the schedule on this HVAC device. The schedule's contents are device config, so they are written on the device itself rather than posted to a separate resource. The body is a non-empty `slots` array (each slot an `at` absolute-timestamp variant or a `time` wall-clock variant), an optional `recurrence` rule, and a schedule-level IANA `timezone` for `time`-variant slots. The route is published ahead of the scheduler; every call returns 501 until it lands.

curl

curl --request GET \
  --url 'https://api.amps.ai/hvac/device_abc123/schedule' \
  --header 'x-api-key: amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx'

const response = await fetch('https://api.amps.ai/hvac/device_abc123/schedule', {
  method: 'GET',
  headers: {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
  },
});

const data = await response.json();

import requests

url = 'https://api.amps.ai/hvac/device_abc123/schedule'
headers = {
    'x-api-key': 'amps_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx',
}

response = requests.get(url, headers=headers)
data = response.json()

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.amps.ai/hvac/{deviceId}/schedule",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "x-api-key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.amps.ai/hvac/{deviceId}/schedule"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("x-api-key", "<api-key>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.get("https://api.amps.ai/hvac/{deviceId}/schedule")
  .header("x-api-key", "<api-key>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.amps.ai/hvac/{deviceId}/schedule")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'

response = http.request(request)
puts response.read_body

{
  "id": "sched_abc123",
  "deviceId": "device_abc123",
  "deviceType": "hvac",
  "state": "active",
  "timezone": "Europe/London",
  "recurrence": {
    "rule": "daily"
  },
  "slots": [
    {
      "time": "00:30",
      "duration": "PT5H",
      "command": "charge",
      "parameters": {
        "target": {
          "value": 100,
          "unit": "percent"
        }
      }
    }
  ],
  "updatedAt": "2026-06-01T12:00:00.000Z",
  "nextFireAt": "2026-06-02T00:30:00.000Z"
}

Get Started

Concepts

API Reference

Guides

Quick reference

More

Authorizations

Path Parameters

Response