Represents an unmanaged device. An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any access codes on an unmanaged device are unmanaged. To control an unmanaged device with Seam, convert it to a managed device.
Collection of capabilities that the device supports when connected to Seam. Values are access_code, which indicates that the device can manage and utilize digital PIN codes for secure access; lock, which indicates that the device controls a door locking mechanism, enabling the remote opening and closing of doors and other entry points; noise_detection, which indicates that the device supports monitoring and responding to ambient noise levels; thermostat, which indicates that the device can regulate and adjust indoor temperatures; battery, which indicates that the device can manage battery life and health; and phone, which indicates that the device is a mobile device, such as a smartphone. Important: Superseded by capability flags.
connected_account_idUUID
Unique identifier for the account associated with the device.
created_atDatetime
Date and time at which the device object was created.
Array of errors associated with the device. Each error object within the array contains two fields: error_code and message. error_code is a string that uniquely identifies the type of error, enabling quick recognition and categorization of the issue. message provides a more detailed description of the error, offering insights into the issue and potentially how to rectify it.
The specific structure of each object in this list depends on the value of its error_code field.
Variants:
account_disconnected
Indicates that the account is disconnected.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
empty_backup_access_code_pool
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
august_lock_not_authorized
Indicates that the user is not authorized to use the August lock.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
august_lock_not_authorized
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
august_lock_missing_bridge
Indicates that the lock is not connected to a bridge.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
august_lock_missing_bridge
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
ttlock_lock_not_paired_to_gateway
Indicates that the lock is not paired with a gateway.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
ttlock_lock_not_paired_to_gateway
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
missing_device_credentials
Indicates that device credentials are missing.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
missing_device_credentials
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
auxiliary_heat_running
Indicates that the auxiliary heat is running.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
auxiliary_heat_running
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
subscription_required
Indicates that a subscription is required to connect.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
subscription_required
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
lockly_missing_wifi_bridge
Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
lockly_missing_wifi_bridge
is_device_errorBoolean
Indicates that the error is a device error.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
invalid_credentials
Indicates that the credentials provided were invalid.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
invalid_credentials
is_bridge_errorBoolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_errorBoolean
Indicates whether the error is related specifically to the connected account.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
created_atDatetime
Date and time at which Seam created the error.
error_codeEnum
Unique identifier of the type of error. Enables quick recognition and categorization of the issue.
Enum values:
bridge_disconnected
is_bridge_errorBoolean
Indicates whether the error is related to Seam Bridge.
is_connected_account_errorBoolean
Indicates whether the error is related specifically to the connected account.
messageString
Detailed description of the error. Provides insights into the issue and potentially how to rectify it.
Array of warnings associated with the device. Each warning object within the array contains two fields: warning_code and message. warning_code is a string that uniquely identifies the type of warning, enabling quick recognition and categorization of the issue. message provides a more detailed description of the warning, offering insights into the issue and potentially how to rectify it.
The specific structure of each object in this list depends on the value of its warning_code field.
Variants:
partial_backup_access_code_pool
Indicates that the backup access code is unhealthy.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
partial_backup_access_code_pool
many_active_backup_codes
Indicates that there are too many backup codes.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
many_active_backup_codes
wyze_device_missing_gateway
Indicates that the Wyze Lock is not connected to a gateway.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
wyze_device_missing_gateway
functional_offline_device
Indicates that the device is offline but has some functionality available.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
functional_offline_device
third_party_integration_detected
Indicates that a third-party integration has been detected.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
third_party_integration_detected
nest_thermostat_in_manual_eco_mode
Indicates that the Nest thermostat is in manual eco mode.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
nest_thermostat_in_manual_eco_mode
ttlock_lock_gateway_unlocking_not_enabled
Indicates that the Remote Unlock feature is not enabled in the settings."
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
ttlock_lock_gateway_unlocking_not_enabled
ttlock_weak_gateway_signal
Indicates that the gateway signal is weak.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
ttlock_weak_gateway_signal
power_saving_mode
Indicates that the device is in power saving mode and may have limited functionality.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
power_saving_mode
temperature_threshold_exceeded
Indicates that the temperature threshold has been exceeded.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
temperature_threshold_exceeded
device_communication_degraded
Indicates that the device appears to be unresponsive.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
device_communication_degraded
scheduled_maintenance_window
Indicates that a scheduled maintenance window has been detected.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
scheduled_maintenance_window
device_has_flaky_connection
Indicates that the device has a flaky connection.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
device_has_flaky_connection
salto_ks_office_mode
Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_office_mode
salto_ks_privacy_mode
Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_privacy_mode
salto_ks_subscription_limit_almost_reached
Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
salto_ks_subscription_limit_almost_reached
unknown_issue_with_phone
Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
unknown_issue_with_phone
lockly_time_zone_not_configured
Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.
created_atDatetime
Date and time at which Seam created the warning.
messageString
Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.
warning_codeEnum
Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.
Enum values:
lockly_time_zone_not_configured
workspace_idUUID
Unique identifier for the Seam workspace associated with the device.
Hardware
locationObject
Location information for the device.
Child Properties
location_nameString
Name of the device location.
timezoneString
Time zone of the device location.
unmanaged_device.properties
modelObject
Device model-related properties.
Child Properties
accessory_keypad_supportedBoolean
{% hint style="warning" %} Deprecated. use device.properties.model.can_connect_accessory_keypad {% endhint %}
can_connect_accessory_keypadBoolean
Indicates whether the device can connect a accessory keypad.
display_nameString
Display name of the device model.
has_built_in_keypadBoolean
Indicates whether the device has a built in accessory keypad.
manufacturer_display_nameString
Display name that corresponds to the manufacturer-specific terminology for the device.
offline_access_codes_supportedBoolean
{% hint style="warning" %} Deprecated. use device.can_program_offline_access_codes. {% endhint %}
online_access_codes_supportedBoolean
{% hint style="warning" %} Deprecated. use device.can_program_online_access_codes. {% endhint %}
nameString
Name of the device.
Deprecated. use device.display_name instead
onlineBoolean
Indicates whether the device is online.
access codes
offline_access_codes_enabledBoolean
Indicates whether it is currently possible to use offline access codes for the device.
online_access_codes_enabledBoolean
Indicates whether it is currently possible to use online access codes for the device.
hardware
accessory_keypadObject
Accessory keypad properties and state.
Child Properties
batteryObject
Keypad battery properties.
battery.levelNumber
is_connectedBoolean
Indicates if an accessory keypad is connected to the device.
batteryObject
Represents the current status of the battery charge level.
Child Properties
levelNumber
Battery charge level as a value between 0 and 1, inclusive.
statusEnum
Represents the current status of the battery charge level. Values are critical, which indicates an extremely low level, suggesting imminent shutdown or an urgent need for charging; low, which signifies that the battery is under the preferred threshold and should be charged soon; good, which denotes a satisfactory charge level, adequate for normal use without the immediate need for recharging; and full, which represents a battery that is fully charged, providing the maximum duration of usage.
battery_levelNumber
Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
image_alt_textString
Alt text for the device image.
image_urlString
Image URL for the device.
manufacturerString
Manufacturer of the device. When a device, such as a smart lock, is connected through a smart hub, the manufacturer of the device might be different from that of the smart hub.
Errors
account_disconnected
Indicates that the account is disconnected.
bridge_disconnected
Indicates that the Seam API cannot communicate with Seam Bridge, for example, if the Seam Bridge executable has stopped or if the computer running the Seam Bridge executable is offline. See also Troubleshooting Your Access Control System.
device_disconnected
Indicates that the device is disconnected.
device_offline
Indicates that the device is offline.
device_removed
Indicates that the device has been removed.
hub_disconnected
Indicates that the hub is disconnected.
invalid_credentials
Indicates that the credentials provided were invalid.
lockly_missing_wifi_bridge
Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
missing_device_credentials
Indicates that device credentials are missing.
subscription_required
Indicates that a subscription is required to connect.
ttlock_lock_not_paired_to_gateway
Indicates that the lock is not paired with a gateway.
Indicates that the lock is not connected to a bridge.
august_lock_not_authorized
Indicates that the user is not authorized to use the August lock.
salto_ks_subscription_limit_exceeded
Indicates that the Salto site user limit has been reached.
Thermostats
auxiliary_heat_running
Indicates that the auxiliary heat is running.
Warnings
device_communication_degraded
Indicates that the device appears to be unresponsive.
device_has_flaky_connection
Indicates that the device has a flaky connection.
functional_offline_device
Indicates that the device is offline but has some functionality available.
lockly_time_zone_not_configured
Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.
salto_ks_subscription_limit_almost_reached
Indicates that the Salto KS site has exceeded 80% of the maximum number of allowed users. Increase your subscription limit or delete some users from your site.
scheduled_maintenance_window
Indicates that a scheduled maintenance window has been detected.
third_party_integration_detected
Indicates that a third-party integration has been detected.
ttlock_weak_gateway_signal
Indicates that the gateway signal is weak.
wyze_device_missing_gateway
Indicates that the Wyze Lock is not connected to a gateway.
Access Codes
many_active_backup_codes
Indicates that there are too many backup codes.
partial_backup_access_code_pool
Indicates that the backup access code is unhealthy.
salto_ks_office_mode
Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.
salto_ks_privacy_mode
Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.
Locks
power_saving_mode
Indicates that the device is in power saving mode and may have limited functionality.
ttlock_lock_gateway_unlocking_not_enabled
Indicates that the Remote Unlock feature is not enabled in the settings."
Phones
unknown_issue_with_phone
Indicates that an unknown issue occurred while syncing the state of the phone with the provider. This issue may affect the proper functioning of the phone.
Thermostats
nest_thermostat_in_manual_eco_mode
Indicates that the Nest thermostat is in manual eco mode.
temperature_threshold_exceeded
Indicates that the temperature threshold has been exceeded.
Events
device.unmanaged.converted_to_managed
An unmanaged device was successfully converted to a managed device.