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.
custom_metadataRecord
Set of key:value pairs. Adding custom metadata to a resource, such as a Connect Webview, connected account, or device, enables you to store custom information, like customer details or internal IDs from your application.
device_idUUID
ID of the device.
device_typeEnum
Type of the device.
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
noiseaware_activity_zone
minut_sensor
ecobee_thermostat
nest_thermostat
honeywell_resideo_thermostat
tado_thermostat
sensi_thermostat
smartthings_thermostat
ios_phone
android_phone
display_nameString
Display name of the device, defaults to nickname (if it is set) or properties.appearance.name, otherwise. Enables administrators and users to identify the device easily, especially when there are numerous devices.
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.
Indicates whether the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be deleted.
can_editBoolean
Indicates whether the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be edited.
can_programBoolean
Indicates whether the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md) key can be programmed in a thermostat daily program.
climate_preset_keyString
Unique key to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
climate_preset_modeEnum
The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.
cooling_set_point_celsiusNumber
Temperature to which the thermostat should cool (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
cooling_set_point_fahrenheitNumber
Temperature to which the thermostat should cool (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
display_nameString
Display name for the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
ecobee_metadataObject
Metadata specific to the Ecobee climate, if applicable.
ecobee_metadata.climate_refString
Reference to the Ecobee climate, if applicable.
ecobee_metadata.is_optimizedBoolean
Indicates if the climate preset is optimized by Ecobee.
ecobee_metadata.ownerEnum
Indicates whether the climate preset is owned by the user or the system.
fan_mode_settingEnum
Desired [fan mode setting](https://docs.seam.co/latest/capability-guides/thermostats/configure-current-climate-settings#fan-mode-settings), such as `on`, `auto`, or `circulate`.
heating_set_point_celsiusNumber
Temperature to which the thermostat should heat (in °C). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
heating_set_point_fahrenheitNumber
Temperature to which the thermostat should heat (in °F). See also [Set Points](../../capability-guides/thermostats/understanding-thermostat-concepts/set-points.md).
hvac_mode_settingEnum
Desired [HVAC mode](../../capability-guides/thermostats/understanding-thermostat-concepts/hvac-mode.md) setting, such as `heat`, `cool`, `heat_cool`, or `off`.
manual_override_allowedBoolean
Indicates whether a person at the thermostat can change the thermostat's settings. See [Specifying Manual Override Permissions](../../capability-guides/thermostats/creating-and-managing-thermostat-schedules.md#specifying-manual-override-permissions).
{% hint style="warning" %}
**Deprecated**. Use 'thermostat_schedule.is_override_allowed'
{% endhint %}
nameString
User-friendly name to identify the [climate preset](../../capability-guides/thermostats/creating-and-managing-climate-presets/README.md).
available_fan_mode_settingsListof Enums
Fan mode settings that the thermostat supports.
available_hvac_mode_settingsListof Enums
HVAC mode settings that the thermostat supports.
avigilon_alta_metadataObject
Metadata for an Avigilon Alta system.
Child Properties
entry_nameString
Entry name for an Avigilon Alta system.
entry_relays_total_countNumber
Total count of entry relays for an Avigilon Alta system.
org_nameString
Organization name for an Avigilon Alta system.
site_idNumber
Site ID for an Avigilon Alta system.
site_nameString
Site name for an Avigilon Alta system.
zone_idNumber
Zone ID for an Avigilon Alta system.
zone_nameString
Zone name for an Avigilon Alta system.
brivo_metadataObject
Metadata for a Brivo device.
Child Properties
device_nameString
Device name for a Brivo device.
controlbyweb_metadataObject
Metadata for a ControlByWeb device.
Child Properties
device_idString
Device ID for a ControlByWeb device.
device_nameString
Device name for a ControlByWeb device.
relay_nameString
Relay name for a ControlByWeb device.
current_climate_settingObject
Current climate setting.
Child Properties
can_deleteBoolean
Indicates whether the climate preset key can be deleted.
Deprecated. Use current_climate_setting.fan_mode_setting instead.
Enum values
auto
on
circulate
four_suites_metadataObject
Metadata for a 4SUITES device.
Child Properties
device_idNumber
Device ID for a 4SUITES device.
device_nameString
Device name for a 4SUITES device.
reclose_delay_in_secondsNumber
Reclose delay, in seconds, for a 4SUITES device.
genie_metadataObject
Metadata for a Genie device.
Child Properties
device_nameString
Lock name for a Genie device.
door_nameString
Door name for a Genie device.
honeywell_resideo_metadataObject
Metadata for a Honeywell Resideo device.
Child Properties
device_nameString
Device name for a Honeywell Resideo device.
honeywell_resideo_device_idString
Device ID for a Honeywell Resideo device.
hubitat_metadataObject
Metadata for a Hubitat device.
Child Properties
device_idString
Device ID for a Hubitat device.
device_labelString
Device label for a Hubitat device.
device_nameString
Device name for a Hubitat device.
igloo_metadataObject
Metadata for an igloo device.
Child Properties
bridge_idString
Bridge ID for an igloo device.
device_idString
Device ID for an igloo device.
modelString
Model for an igloo device.
igloohome_metadataObject
Metadata for an igloohome device.
Child Properties
bridge_idString
Bridge ID for an igloohome device.
bridge_nameString
Bridge name for an igloohome device.
device_idString
Device ID for an igloohome device.
device_nameString
Device name for an igloohome device.
is_keypad_linked_to_bridgeBoolean
Indicates whether a keypad is linked to a bridge for an igloohome device.
keypad_idString
Keypad ID for an igloohome device.
is_coolingBoolean
Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.
is_fan_runningBoolean
Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.
is_heatingBoolean
Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.
is_temporary_manual_override_activeBoolean
Indicates whether the current thermostat settings differ from the most recent active program or schedule that Seam activated. For this condition to occur, current_climate_setting.manual_override_allowed must also be true.
Date and time at which the thermostat weekly program was created.
friday_program_idUUID
ID of the thermostat daily program to run on Fridays.
monday_program_idUUID
ID of the thermostat daily program to run on Mondays.
saturday_program_idUUID
ID of the thermostat daily program to run on Saturdays.
sunday_program_idUUID
ID of the thermostat daily program to run on Sundays.
thursday_program_idUUID
ID of the thermostat daily program to run on Thursdays.
tuesday_program_idUUID
ID of the thermostat daily program to run on Tuesdays.
wednesday_program_idUUID
ID of the thermostat daily program to run on Wednesdays.
ttlock_metadataObject
Metadata for a TTLock device.
Child Properties
feature_valueString
Feature value for a TTLock device.
featuresObject
Features for a TTLock device.
features.incomplete_keyboard_passcodeBoolean
Indicates whether a TTLock device supports an incomplete keyboard passcode.
features.lock_commandBoolean
Indicates whether a TTLock device supports the lock command.
features.passcodeBoolean
Indicates whether a TTLock device supports a passcode.
features.passcode_managementBoolean
Indicates whether a TTLock device supports passcode management.
features.unlock_via_gatewayBoolean
Indicates whether a TTLock device supports unlock via gateway.
features.wifiBoolean
Indicates whether a TTLock device supports Wi-Fi.
has_gatewayBoolean
Indicates whether a TTLock device has a gateway.
lock_aliasString
Lock alias for a TTLock device.
lock_idNumber
Lock ID for a TTLock device.
wireless_keypadsListof Objects
Wireless keypads for a TTLock device.
wireless_keypad_idNumber
ID for a wireless keypad for a TTLock device.
wireless_keypad_nameString
Name for a wireless keypad for a TTLock device.
two_n_metadataObject
Metadata for a 2N device.
Child Properties
device_idNumber
Device ID for a 2N device.
device_nameString
Device name for a 2N device.
visionline_metadataObject
Metadata for an ASSA ABLOY Visionline system.
Child Properties
encoder_idString
Encoder ID for an ASSA ABLOY Visionline system.
wyze_metadataObject
Metadata for a Wyze device.
Child Properties
device_idString
Device ID for a Wyze device.
device_info_modelString
Device information model for a Wyze device.
device_nameString
Device name for a Wyze device.
keypad_uuidString
Keypad UUID for a Wyze device.
locker_status_hardlockNumber
Locker status (hardlock) for a Wyze device.
product_modelString
Product model for a Wyze device.
product_nameString
Product name for a Wyze device.
product_typeString
Product type for a Wyze device.
Errors
auxiliary_heat_running
Indicates that the auxiliary heat is running.
ttlock_lock_not_paired_to_gateway
Indicates that the lock is not paired with a gateway.
subscription_required
Indicates that a subscription is required to connect.
missing_device_credentials
Indicates that device credentials are missing.
lockly_missing_wifi_bridge
Indicates that the Lockly lock is not connected to a Wi-Fi bridge.
hub_disconnected
Indicates that the hub is disconnected.
device_removed
Indicates that the device has been removed.
device_offline
Indicates that the device is offline.
device_disconnected
Indicates that the device is disconnected.
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.
invalid_credentials
Indicates that the credentials provided were invalid.
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.
nest_thermostat_in_manual_eco_mode
Indicates that the Nest thermostat is in manual eco 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.
scheduled_maintenance_window
Indicates that a scheduled maintenance window has been detected.
temperature_threshold_exceeded
Indicates that the temperature threshold has been exceeded.
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.
Sets a temperature threshold for a specified thermostat. Seam emits a thermostat.temperature_threshold_exceeded event and adds a warning on a thermostat if it reports a temperature outside the threshold range.
Updates the thermostat weekly program for a thermostat device. To configure a weekly program, specify the ID of the daily program that you want to use for each day of the week. When you update a weekly program, the set of programs that you specify overwrites any previous weekly program for the thermostat.