List Devices

Get all devices

Returns a list of all devices.


Request

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

Request Body Parameters

Parameter
Type
Description

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

device_type

String Optional

Type of device.

device_types

String[] Optional

Types of devices.

manufacturer

String Optional

Device manufacturer.

device_ids

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.

user_identifier_key

String Optional

Your own internal user ID for the user by which to filter devices.

custom_metadata_has

JSON object Optional

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


Sample Request

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
  ),
  ...
]

Last updated

Logo

© Seam Labs, Inc. All rights reserved.