List Climate Setting Schedules

/thermostats/climate_setting_schedules/list

POSThttps://connect.getseam.com/thermostats/climate_setting_schedules/list

Authorization

api_keyclient_sessionpat_with_workspaceconsole_session

Body

application/json

device_id*string (uuid)

user_identifier_keystring

Response

200400401

OK

Body

application/json

climate_setting_schedules*array of climate_setting_schedule (object)

ok*boolean

Request

JavaScriptCurl

const response = await fetch('https://connect.getseam.com/thermostats/climate_setting_schedules/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer API Key",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "device_id": "123e4567-e89b-12d3-a456-426614174000"
    }),
});
const data = await response.json();

Response

{
  "climate_setting_schedules": [
    {
      "climate_setting_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
      "schedule_type": "time_bound",
      "device_id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "text",
      "schedule_starts_at": "text",
      "schedule_ends_at": "text",
      "created_at": "2024-07-27T08:52:44.330Z",
      "automatic_heating_enabled": false,
      "automatic_cooling_enabled": false,
      "hvac_mode_setting": "off",
      "cooling_set_point_celsius": 0,
      "heating_set_point_celsius": 0,
      "cooling_set_point_fahrenheit": 0,
      "heating_set_point_fahrenheit": 0,
      "manual_override_allowed": false
    }
  ],
  "ok": false
}

Code Example

Python

device_id="123e4567-e89b-12d3-a456-426614174001"
seam.climate_setting_schedules.list(device_id)

# [
#   ClimateSettingSchedule:
#      climate_setting_schedule_id: 26d6138c-6524-4f3c-ac96-43cc3bea0a8d  
#      device_id: 123e4567-e89b-12d3-a456-426614174001
#      name: Guest Stay #1234        
#      ...
#   ClimateSettingSchedule:    
#      climate_setting_schedule_id: a83690b2-2b70-409a-9a94-426699b84c97
#      device_id: 123e4567-e89b-12d3-a456-426614174001    
#      name: Guest Stay #5678
#      ...
# ]

Javascript

await seam.climateSettingSchedules.list({
    device_id: "a83690b2-2b70-409a-9a94-426699b84c97",
});

/*
{
  "climate_setting_schedules": [
    {
      "climate_setting_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
      "device_id": "123e4567-e89b-12d3-a456-426614174001",
      "name": "Guest Stay #1234",
      "schedule_starts_at": "2022-07-01T10:40:00Z",
      "schedule_ends_at": "2022-07-10T10:40:00Z",
      "created_at": "2022-07-06T23:26:42.223Z",
      "is_set_on_device": false,
      "automatic_heating_enabled": true,
      "automatic_cooling_enabled": true,
      "hvac_mode_setting": "heat_cool",
      "cooling_set_point_fahrenheit": 75,
      "heating_set_point_fahrenheit": 65,
      "manual_override_allowed": false
    }
  ],
  "ok": true
}
*/

Parameters

device_id	String Required	ID of device connected to account
user_identifier_key	String Optional	Your own internal user ID for the user by which to filter climate setting schedules

Response

This section shows the JSON response returned by the API. Since each language encapsulates this response inside objects specific to that language and/or implementation, the actual type in your language might differ from what’s written here.

JSON format

JSON

{
  "climate_setting_schedules": [
    {
      "climate_setting_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
      "device_id": "123e4567-e89b-12d3-a456-426614174001",
      "name": "Guest Stay #1234",
      "schedule_starts_at": "2022-07-01T10:40:00Z",
      "schedule_ends_at": "2022-07-10T10:40:00Z",
      "created_at": "2022-07-06T23:26:42.223Z",
      "is_set_on_device": false,
      "automatic_heating_enabled": true,
      "automatic_cooling_enabled": true,
      "hvac_mode_setting": "heat_cool",
      "cooling_set_point_fahrenheit": 75,
      "heating_set_point_fahrenheit": 65,
      "manual_override_allowed": false
    }
  ],
  "ok": true
}