Get a Thermostat Schedule
POST /thermostats/schedules/get ⇒ { thermostat_schedule }Returns a specified thermostat schedule.
Request
await seam.thermostats.schedules.get({
thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
});Response
{
"thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
"name": "Reservation 2",
"device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
"climate_preset_key": "occupied",
"starts_at": "2024-11-10T15:00:00.000Z",
"ends_at": "2024-11-15T12:00:00.000Z",
"max_override_period_minutes": 90
}Request
seam.thermostats.schedules.get(
thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4"
)Response
ThermostatSchedule(
thermostat_schedule_id="89d3507e-60e3-4101-bd1b-ba066ec30ad4",
name="Reservation 2",
device_id="2d488679-6f07-4810-aed2-e726872c1dd5",
climate_preset_key="occupied",
starts_at="2024-11-10T15:00:00.000Z",
ends_at="2024-11-15T12:00:00.000Z",
max_override_period_minutes=90,
)Request
seam.thermostats.schedules.get(thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4")Response
{
"thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
"name" => "Reservation 2",
"device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
"climate_preset_key" => "occupied",
"starts_at" => "2024-11-10T15:00:00.000Z",
"ends_at" => "2024-11-15T12:00:00.000Z",
"max_override_period_minutes" => 90,
}Request
<?php
$seam->thermostats->schedules->get(
thermostat_schedule_id: "89d3507e-60e3-4101-bd1b-ba066ec30ad4"
);Response
<?php
[
"thermostat_schedule_id" => "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
"name" => "Reservation 2",
"device_id" => "2d488679-6f07-4810-aed2-e726872c1dd5",
"climate_preset_key" => "occupied",
"starts_at" => "2024-11-10T15:00:00.000Z",
"ends_at" => "2024-11-15T12:00:00.000Z",
"max_override_period_minutes" => 90,
];Request
seam thermostats schedules get --thermostat_schedule_id "89d3507e-60e3-4101-bd1b-ba066ec30ad4"Response
{
"thermostat_schedule_id": "89d3507e-60e3-4101-bd1b-ba066ec30ad4",
"name": "Reservation 2",
"device_id": "2d488679-6f07-4810-aed2-e726872c1dd5",
"climate_preset_key": "occupied",
"starts_at": "2024-11-10T15:00:00.000Z",
"ends_at": "2024-11-15T12:00:00.000Z",
"max_override_period_minutes": 90
}Request
package main
import api "github.com/seamapi/go"
import schedules "github.com/seamapi/go/schedules"
func main() {
client.Thermostats.Schedules.Get(
context.Background(),
schedules.SchedulesGetRequest{
ThermostatScheduleId: api.String("89d3507e-60e3-4101-bd1b-ba066ec30ad4"),
},
)
}Response
api.ThermostatSchedule{ThermostatScheduleId: "89d3507e-60e3-4101-bd1b-ba066ec30ad4", Name: "Reservation 2", DeviceId: "2d488679-6f07-4810-aed2-e726872c1dd5", ClimatePresetKey: "occupied", StartsAt: "2024-11-10T15:00:00.000Z", EndsAt: "2024-11-15T12:00:00.000Z", MaxOverridePeriodMinutes: 90}Authentication Methods
API key
Client session token
Personal access token Must also include the
seam-workspaceheader in the request.
Request Parameters
thermostat_schedule_id
thermostat_schedule_idType: string Required: Yes
ID of the desired thermostat schedule.
Return Type
Last updated
Was this helpful?