Sign-Up Supported Devices

List Devices

Get all devices

Returns a list of all devices (device objects).

/devices/list

POSThttps://connect.getseam.com/devices/list
Authorization
Body
connected_account_idstring (uuid)

List all devices owned by this connected account

connected_account_idsarray of string (uuid)
connect_webview_idstring (uuid)
device_typeone of
device_typesarray of one of
manufacturerenum
akuvoxaugustavigilon_altabrivobutterflymxdoorkingfour_suitesgenieiglookeywekwiksetlinearlocklynukiphiliasaltosamsungschlageseamunknownwyzeyaleminuttwo_nttlocknestigloohomeecobeehubitatcontrolbywebsmartthingsdormakaba_oracodetedeehoneywell_resideo
device_idsarray of string (uuid)
limitnullable number
created_beforenullable string (date-time)
user_identifier_keystring
custom_metadata_hasobject
include_ifarray of enum
exclude_ifarray of enum
Response

OK

Body
devices*array of device (object)
ok*boolean
Request
const response = await fetch('https://connect.getseam.com/devices/list', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "devices": [
    {
      "device_id": "123e4567-e89b-12d3-a456-426614174000",
      "device_type": "akuvox_lock",
      "nickname": "text",
      "display_name": "text",
      "capabilities_supported": [
        "access_code"
      ],
      "properties": {
        "online": false,
        "name": "text",
        "accessory_keypad": {
          "is_connected": false,
          "battery": {
            "level": 0
          }
        },
        "appearance": {
          "name": "text"
        },
        "model": {
          "can_connect_accessory_keypad": false,
          "display_name": "text",
          "manufacturer_display_name": "text",
          "has_built_in_keypad": false,
          "offline_access_codes_supported": false,
          "online_access_codes_supported": false,
          "accessory_keypad_supported": false
        },
        "has_direct_power": false,
        "battery_level": 0,
        "battery": {
          "level": 0,
          "status": "critical"
        },
        "manufacturer": "text",
        "image_url": "https://example.com",
        "image_alt_text": "text",
        "serial_number": "text",
        "online_access_codes_enabled": false,
        "offline_access_codes_enabled": false,
        "supports_accessory_keypad": false,
        "supports_offline_access_codes": false,
        "assa_abloy_credential_service_metadata": {
          "has_active_endpoint": false,
          "endpoints": [
            {
              "endpoint_id": "text",
              "is_active": false
            }
          ]
        },
        "august_metadata": {
          "lock_id": "text",
          "lock_name": "text",
          "house_name": "text",
          "has_keypad": false,
          "keypad_battery_level": "text",
          "model": "text",
          "house_id": "text"
        },
        "avigilon_alta_metadata": {
          "entry_name": "text",
          "org_name": "text",
          "zone_id": 0,
          "zone_name": "text",
          "site_id": 0,
          "site_name": "text"
        },
        "schlage_metadata": {
          "device_id": "text",
          "device_name": "text",
          "access_code_length": 0,
          "model": "text"
        },
        "smartthings_metadata": {
          "device_id": "text",
          "device_name": "text",
          "model": "text",
          "location_id": "text"
        },
        "lockly_metadata": {
          "device_id": "text",
          "device_name": "text",
          "model": "text"
        },
        "nuki_metadata": {
          "device_id": "text",
          "device_name": "text",
          "keypad_battery_critical": false,
          "keypad_paired": false,
          "keypad_2_paired": false
        },
        "kwikset_metadata": {
          "device_id": "text",
          "device_name": "text",
          "model_number": "text"
        },
        "salto_metadata": {
          "lock_id": "text",
          "customer_reference": "text",
          "lock_type": "text",
          "battery_level": "text",
          "locked_state": "text",
          "model": "text"
        },
        "genie_metadata": {
          "device_name": "text",
          "door_name": "text"
        },
        "brivo_metadata": {
          "device_name": "text"
        },
        "igloo_metadata": {
          "device_id": "text",
          "bridge_id": "text",
          "model": "text"
        },
        "noiseaware_metadata": {
          "device_model": "indoor",
          "noise_level_nrs": 0,
          "noise_level_decibel": 0,
          "device_name": "text",
          "device_id": "text"
        },
        "minut_metadata": {
          "device_id": "text",
          "device_name": "text",
          "latest_sensor_values": {
            "temperature": {
              "time": "text",
              "value": 0
            },
            "sound": {
              "time": "text",
              "value": 0
            },
            "humidity": {
              "time": "text",
              "value": 0
            },
            "pressure": {
              "time": "text",
              "value": 0
            },
            "accelerometer_z": {
              "time": "text",
              "value": 0
            }
          }
        },
        "four_suites_metadata": {
          "device_id": 0,
          "device_name": "text",
          "reclose_delay_in_seconds": 0
        },
        "two_n_metadata": {
          "device_id": 0,
          "device_name": "text"
        },
        "controlbyweb_metadata": {
          "device_id": "text",
          "device_name": "text",
          "relay_name": "text"
        },
        "ttlock_metadata": {
          "lock_id": 0,
          "lock_alias": "text"
        },
        "seam_bridge_metadata": {
          "unlock_method": "bridge",
          "device_num": 0,
          "name": "text"
        },
        "igloohome_metadata": {
          "device_id": "text",
          "device_name": "text",
          "bridge_id": "text",
          "bridge_name": "text",
          "keypad_id": "text"
        },
        "nest_metadata": {
          "nest_device_id": "text",
          "device_name": "text",
          "custom_name": "text"
        },
        "ecobee_metadata": {
          "ecobee_device_id": "text",
          "device_name": "text"
        },
        "honeywell_resideo_metadata": {
          "honeywell_resideo_device_id": "text",
          "device_name": "text"
        },
        "hubitat_metadata": {
          "device_id": "text",
          "device_name": "text",
          "device_label": "text"
        },
        "dormakaba_oracode_metadata": {
          "door_id": 0,
          "door_name": "text",
          "device_id": 0,
          "door_is_wireless": false,
          "site_id": 0,
          "site_name": "text",
          "iana_timezone": "text",
          "predefined_time_slots": [
            {
              "name": "text",
              "prefix": 0,
              "check_in_time": "text",
              "check_out_time": "text",
              "is_24_hour": false,
              "is_biweekly_mode": false,
              "is_one_shot": false,
              "is_master": false,
              "ext_dormakaba_oracode_user_level_prefix": 0,
              "dormakaba_oracode_user_level_id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ]
        },
        "wyze_metadata": {
          "device_id": "text",
          "device_name": "text",
          "product_name": "text",
          "product_type": "text",
          "product_model": "text",
          "device_info_model": "text",
          "keypad_uuid": "text",
          "locker_status_hardlock": 0
        },
        "tedee_metadata": {
          "device_id": 0,
          "serial_number": "text",
          "device_name": "text",
          "device_model": "text",
          "bridge_id": 0,
          "bridge_name": "text",
          "keypad_id": 0
        },
        "_experimental_supported_code_from_access_codes_lengths": [
          0
        ],
        "code_constraints": [
          {
            "constraint_type": "no_zeros"
          }
        ],
        "supported_code_lengths": [
          0
        ],
        "max_active_codes_supported": 0,
        "supports_backup_access_code_pool": false,
        "has_native_entry_events": false,
        "locked": false,
        "keypad_battery": {
          "level": 0
        },
        "door_open": false,
        "temperature_fahrenheit": 0,
        "temperature_celsius": 0,
        "relative_humidity": 0,
        "can_enable_automatic_heating": false,
        "can_enable_automatic_cooling": false,
        "available_hvac_mode_settings": [
          "off"
        ],
        "is_heating_available": true,
        "is_cooling_available": true,
        "is_heating": false,
        "is_cooling": false,
        "is_fan_running": false,
        "fan_mode_setting": "auto",
        "is_temporary_manual_override_active": false,
        "current_climate_setting": {
          "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
        },
        "default_climate_setting": {
          "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
        },
        "is_climate_setting_schedule_active": false,
        "active_climate_setting_schedule": {
          "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-04-16T12:04:45.232Z",
          "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
        },
        "min_cooling_set_point_celsius": 0,
        "min_cooling_set_point_fahrenheit": 0,
        "max_cooling_set_point_celsius": 0,
        "max_cooling_set_point_fahrenheit": 0,
        "min_heating_set_point_celsius": 0,
        "min_heating_set_point_fahrenheit": 0,
        "max_heating_set_point_celsius": 0,
        "max_heating_set_point_fahrenheit": 0,
        "min_heating_cooling_delta_celsius": 0,
        "min_heating_cooling_delta_fahrenheit": 0
      },
      "location": {
        "location_name": "text",
        "timezone": "text"
      },
      "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "errors": [
        {
          "error_code": "text",
          "message": "text"
        }
      ],
      "warnings": [
        {
          "warning_code": "text",
          "message": "text"
        }
      ],
      "created_at": "2024-04-16T12:04:45.232Z",
      "is_managed": true,
      "can_remotely_unlock": false,
      "can_remotely_lock": false,
      "can_program_offline_access_codes": false,
      "can_program_online_access_codes": false,
      "can_simulate_removal": false
    }
  ],
  "ok": false
}

Request

List all devices or filter the list of devices by including the corresponding filter parameter in the request body.

Request Body Parameters

ParameterTypeDescription

connected_account_id

String Optional

ID of the connected account.

connected_account_ids

String[] Optional

IDs of the connected accounts.

connect_webview_id

String Optional

ID of Connect Webview.

device_type

String Optional

Type of device.

device_types

String[] Optional

Types of devices.

manufacturer

String Optional

Device manufacturer.

device_ids

type: string[] Optional

IDs of the devices to include.

limit

Number Optional

Numerical limit on the number of devices to return.

created_before

String Optional

Date threshold for devices to return. If specified, returns only devices created before the specified date.

custom_metadata_has

JSON object Optional

Set of key:value custom metadata pairs by which you want to filter devices

Sample Request

devices = seam.devices.list()

Response

Returns a devices array, in which each returned device (device) contains the set of applicable device properties. For details, see Devices.

This response also includes a Boolean ok status indicator.

Sample Response

[Device(device_id='30fd243b-3054-4384-a713-5487076a3826',
        device_type='august_lock',
        location={'location_name': 'My House',
                  'timezone': 'America/Los_Angeles'},
        properties={'august_metadata': {'has_keypad': True,
                                        'house_id': 'house-1',
                                        'house_name': 'My House',
                                        'keypad_battery_level': 'Not Available',
                                        'lock_id': 'lock-2',
                                        'lock_name': 'BACK DOOR'},
                    'battery': {'level': 0.9999532347993827, 'status': 'full'},
                    'battery_level': 0.9999532347993827,
                    'code_constraints': [],
                    'door_open': False,
                    'has_native_entry_events': True,
                    'image_alt_text': 'August Wifi Smart Lock 3rd Gen, Silver, '
                                      'Front',
                    'image_url': 'https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png',
                    'locked': True,
                    'manufacturer': 'august',
                    'model': {'accessory_keypad_supported': True,
                              'display_name': 'Lock',
                              'manufacturer_display_name': 'August',
                              'offline_access_codes_supported': False,
                              'online_access_codes_supported': True},
                    'name': 'BACK DOOR',
                    'offline_access_codes_enabled': False,
                    'online': True,
                    'online_access_codes_enabled': True,
                    'serial_number': '00000004-992d-45a0-bea1-9128fdcd8d12',
                    'supported_code_lengths': [4, 5, 6, 7, 8],
                    'supports_accessory_keypad': True,
                    'supports_backup_access_code_pool': True,
                    'supports_offline_access_codes': False},
        capabilities_supported=['access_code', 'lock'],
        errors=[],
        warnings=[],
        custom_metadata={'internal_account_id': 'user-1'},
        connected_account_id='f72442d2-2c16-4e3f-9882-6bff21828b1b',
        workspace_id='398d80b7-3f96-47c2-b85a-6f8ba21d07be',
        created_at='2023-10-28T09:13:08.465Z',
        is_managed=True),
 Device(device_id='9689dc30-77d8-4728-9968-b3abd0835f47',
        device_type='igloohome_lock',
        ...),
 ...]
PreviousDevicesNextList Device Providers

Last updated

Logo

Resources

Sign-UpBlogAboutSupported Devices

© Seam Labs, Inc. All rights reserved.