Sign UpSupported Devices
Edit

List Devices

Returns a list of all devices.

Returns a list of all devices for a specified connected account ID.

Code:

await seam.devices.list({
  connected_account_id: "a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d",
  limit: 50,
});

Output:

[
  {
    "can_hvac_cool": true,
    "can_hvac_heat": true,
    "can_hvac_heat_cool": true,
    "can_turn_off_hvac": true,
    "capabilities_supported": ["thermostat"],
    "connected_account_id": "a0b1c2d3-e4f5-6a7b-8c9d-0e1f2a3b4c5d",
    "created_at": "2024-10-03T22:12:15.666Z",
    "custom_metadata": { "id": "internalId1" },
    "device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
    "device_type": "ecobee_thermostat",
    "display_name": "Living Room",
    "errors": [],
    "is_managed": true,
    "location": {
      "location_name": "2948 20th St, San Francisco, CA, 94110, US",
      "timezone": "America/Los_Angeles"
    },
    "nickname": "Living Room",
    "properties": {
      "active_climate_preset": {
        "can_delete": true,
        "can_edit": true,
        "climate_preset_key": "sleep",
        "cooling_set_point_celsius": 23.88888888888889,
        "display_name": "Sleep",
        "fan_mode_setting": "auto",
        "heating_set_point_celsius": 17.77777777777778,
        "hvac_mode_setting": "heat_cool",
        "manual_override_allowed": true
      },
      "appearance": { "name": "Living Room" },
      "available_climate_presets": [
        {
          "climate_preset_key": "sleep",
          "can_edit": true,
          "can_delete": true,
          "can_use_with_thermostat_daily_programs": false,
          "name": "Sleep",
          "display_name": "Sleep",
          "fan_mode_setting": "auto",
          "hvac_mode_setting": "heat_cool",
          "manual_override_allowed": true,
          "cooling_set_point_celsius": 23.88888888888889,
          "heating_set_point_celsius": 17.77777777777778,
          "cooling_set_point_fahrenheit": 75,
          "heating_set_point_fahrenheit": 64
        },
        {
          "climate_preset_key": "home",
          "can_edit": true,
          "can_delete": true,
          "can_use_with_thermostat_daily_programs": false,
          "name": "Home",
          "display_name": "Home",
          "fan_mode_setting": "auto",
          "hvac_mode_setting": "heat_cool",
          "manual_override_allowed": false,
          "cooling_set_point_celsius": 23.88888888888889,
          "heating_set_point_celsius": 17.77777777777778,
          "cooling_set_point_fahrenheit": 75,
          "heating_set_point_fahrenheit": 64
        },
        {
          "climate_preset_key": "work",
          "can_edit": true,
          "can_delete": true,
          "can_use_with_thermostat_daily_programs": false,
          "name": "Work",
          "display_name": "Work",
          "fan_mode_setting": "auto",
          "hvac_mode_setting": "heat_cool",
          "manual_override_allowed": false,
          "cooling_set_point_celsius": 23.88888888888889,
          "heating_set_point_celsius": 17.77777777777778,
          "cooling_set_point_fahrenheit": 75,
          "heating_set_point_fahrenheit": 64
        }
      ],
      "available_fan_mode_settings": ["auto", "on"],
      "available_hvac_mode_settings": ["cool", "heat", "heat_cool", "off"],
      "current_climate_setting": {
        "display_name": "Manual Setting",
        "fan_mode_setting": "auto",
        "heating_set_point_celsius": 25,
        "heating_set_point_fahrenheit": 77,
        "hvac_mode_setting": "heat",
        "manual_override_allowed": true
      },
      "ecobee_metadata": {
        "device_name": "Living Room",
        "ecobee_device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0"
      },
      "fallback_climate_preset_key": "eco",
      "fan_mode_setting": "auto",
      "has_direct_power": true,
      "image_alt_text": "Ecobee 3 Lite Thermostat",
      "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/ecobee_3-lite_front.png&q=75&w=128",
      "is_cooling": false,
      "is_fan_running": false,
      "is_heating": false,
      "is_temporary_manual_override_active": false,
      "manufacturer": "ecobee",
      "max_cooling_set_point_celsius": 33.333333333333336,
      "max_cooling_set_point_fahrenheit": 92,
      "max_heating_set_point_celsius": 26.11111111111111,
      "max_heating_set_point_fahrenheit": 79,
      "min_cooling_set_point_celsius": 18.333333333333336,
      "min_cooling_set_point_fahrenheit": 65,
      "min_heating_cooling_delta_celsius": 2.7777777777777777,
      "min_heating_cooling_delta_fahrenheit": 5,
      "min_heating_set_point_celsius": 7.222222222222222,
      "min_heating_set_point_fahrenheit": 45,
      "model": {
        "display_name": "Thermostat",
        "manufacturer_display_name": "Ecobee"
      },
      "name": "Living Room",
      "online": true,
      "relative_humidity": 0.36,
      "temperature_celsius": 21.11111111111111,
      "temperature_fahrenheit": 70,
      "temperature_threshold": {
        "lower_limit_celsius": 16.66666666666667,
        "lower_limit_fahrenheit": 62,
        "upper_limit_celsius": 26.66666666666667,
        "upper_limit_fahrenheit": 80
      },
      "thermostat_daily_programs": [
        {
          "thermostat_daily_program_id": "1a2b3c4d-5e6f-7890-1234-56789abcdef1",
          "device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
          "name": "Weekday Program",
          "periods": [
            { "starts_at_time": "00:00:00", "climate_preset_key": "sleep" },
            { "starts_at_time": "07:00:00", "climate_preset_key": "home" },
            { "starts_at_time": "09:00:00", "climate_preset_key": "work" },
            { "starts_at_time": "18:00:00", "climate_preset_key": "home" },
            { "starts_at_time": "22:00:00", "climate_preset_key": "sleep" }
          ],
          "workspace_id": "9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab",
          "created_at": "2025-05-30T04:01:25.455Z"
        },
        {
          "thermostat_daily_program_id": "d4e5f6a7-8b9c-0d1e-2f3a-4b5c6d7e8f90",
          "device_id": "a1b2c3d4-e5f6-7890-1234-56789abcdef0",
          "name": "Weekend Program",
          "periods": [
            { "starts_at_time": "00:00:00", "climate_preset_key": "sleep" },
            { "starts_at_time": "08:00:00", "climate_preset_key": "home" },
            { "starts_at_time": "23:00:00", "climate_preset_key": "sleep" }
          ],
          "workspace_id": "9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab",
          "created_at": "2025-05-30T04:02:19.952Z"
        }
      ],
      "thermostat_weekly_program": null
    },
    "warnings": [],
    "workspace_id": "9f8e7d6c-5b4a-3c2d-1e0f-9876543210ab"
  }
]
Authentication Methods

  • API key

  • Client session token

  • Personal access token Must also include the seam-workspace header in the request.

To learn more, see Authentication.

Request Parameters

connect_webview_id String

ID of the Connect Webview for which you want to list devices.

connected_account_id String

ID of the connected account for which you want to list devices.

connected_account_ids Array of UUIDs

Array of IDs of the connected accounts for which you want to list devices.

created_before String

Timestamp by which to limit returned devices. Returns devices created before this timestamp.

custom_metadata_has Object

Set of key:value custom metadata pairs for which you want to list devices.

customer_key String

Customer key for which you want to list devices.

device_ids Array of UUIDs

Array of device IDs for which you want to list devices.

device_type String

Device type for which you want to list devices.

device_types Array of Enums

Array of device types for which you want to list devices.

Enum values

Possible enum values:

  • akuvox_lock

  • august_lock

  • brivo_access_point

  • butterflymx_panel

  • avigilon_alta_entry

  • doorking_lock

  • genie_door

  • igloo_lock

  • linear_lock

  • lockly_lock

  • kwikset_lock

  • nuki_lock

  • salto_lock

  • schlage_lock

  • seam_relay

  • smartthings_lock

  • wyze_lock

  • yale_lock

  • two_n_intercom

  • controlbyweb_device

  • ttlock_lock

  • igloohome_lock

  • hubitat_lock

  • four_suites_door

  • dormakaba_oracode_door

  • tedee_lock

  • akiles_lock

  • ultraloq_lock

  • keynest_key

  • noiseaware_activity_zone

  • minut_sensor

  • ecobee_thermostat

  • nest_thermostat

  • honeywell_resideo_thermostat

  • tado_thermostat

  • sensi_thermostat

  • smartthings_thermostat

  • ios_phone

  • android_phone

limit Number

Numerical limit on the number of devices to return.

manufacturer String

Manufacturer for which you want to list devices.

page_cursor String

Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.

search String

String for which to search. Filters returned devices to include all records that satisfy a partial match using device_id, display_name, custom_metadata or location.location_name.

space_id String

ID of the space for which you want to list devices.

unstable_location_id String

Deprecated. Use space_id.

user_identifier_key String

Your own internal user ID for the user for which you want to list devices.

Response

Returns: Array of devices

Examples

List devices for a Connect Webview

Returns a list of all devices that were connected using a specified Connect Webview.

Code:

Output:

List devices for a user identifier key

Returns a list of all devices for a specified user identifier key.

Code:

Output:

List devices for a space

Returns a list of all devices for a specified space ID.

Code:

Output:

List devices with specific custom metadata

Returns a list of all devices containing specified custom metadata.

Code:

Output:

List devices for a specific manufacturer, created before a specific date

Returns a list of all devices for a specific manufacturer, created (in Seam) before a specific date.

Code:

Output:

PreviousList Device ProvidersNextReport Provider Metadata

Last updated

Was this helpful?