Seam Docs
Search…
⌃K

Devices

A device that has been connected to the Seam platform.

The Device Object

device_id
uuid
ID of the Device
device_type
string
Type of Device
capabilities_supported
Capabilities supported by this Device
errors
As seen in 'Device Error Types'
List of errors for this Device
location
object
Location information for the Device
manufacturer
Manufacturer of the Device
properties
object
Properties for the Device
warnings
List of warnings for this Device
workspace_id
uuid
ID of the workspace that the device belongs to
created_at
datetime
Timestamp of creation time

List of Methods

​Get Device​
Get device
​List Devices​
List device

Device Capabilities Supported

Capability Types
Description
access_code
If present, one can set access codes on the device.
battery
If present, you can look at the battery_level of the device
health
If present, one can introspect some parameters related to the health of the device.
lock
If present, the device is able to be locked and unlocked.

Device Error Types

Errors are displayed in the format:
{
"message": "...",
"created_at": "ISO8601 string"
}
account_disconnected
Seam has lost connection to a connected account. This may happen if the third-party provider triggered an access token to be revoked (e.g. after a password change). The account owner needs to reconnect the connected account with a new connect webview.
device_removed
A device has been removed from the Connected Account. Seam can no longer sync with this device.
hub_disconnected
The hub that the device is connected to is offline. Seam is unable to sync updates to this device.

Device Warning Types

Warnings are displayed in the format:
{
"message": "...",
"created_at": "ISO8601 string"
}
salto_office_mode
A Salto Lock is in Office Mode. Access Codes will not unlock doors. You can disable office mode in the Salto dashboard.
salto_privacy_mode
A Salto Lock is in Privacy Mode. Access Codes will not unlock doors. You can disable privacy mode by pressing the back of the lock.

Device Manufacturers

On some account types, Seam provides additional information on the manufacturer of the door lock. Where the device is being connected via a smart hub, the manufacturer of the door lock might be different from that of the smart hub.
Here are a list of manufacturers that might get returned:
august
keywe
kwikset
lockly
philia
samsung
schlage
yale
unknown
​
​