The Seam API enables you to control connected smart locks from a wide variety of manufacturers, including locks that provide online and offline access code programming.
Depending on the smart lock brand and model, actions that you can perform include remote unlock, remote lock, and programming access codes. You can also view a lock's properties, capabilities, and status. Further, you can monitor for unlock and lock events.
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.
Group ID to which to add users for an Akiles device.
gadget_idString
Gadget ID for an Akiles device.
gadget_nameString
Gadget name for an Akiles device.
product_nameString
Product name for an Akiles device.
assa_abloy_credential_service_metadataObject
ASSA ABLOY Credential Service metadata for the phone.
Child Properties
endpointsListof Objects
Endpoints associated with the phone.
endpoint_idString
ID of the associated endpoint.
is_activeBoolean
Indicated whether the endpoint is active.
has_active_endpointBoolean
Indicates whether the credential service has active endpoints associated with the phone.
assa_abloy_vostio_metadataObject
Metadata for an ASSA ABLOY Vostio system.
Child Properties
encoder_nameString
Encoder name for an ASSA ABLOY Vostio system.
august_metadataObject
Metadata for an August device.
Child Properties
has_keypadBoolean
Indicates whether an August device has a keypad.
house_idString
House ID for an August device.
house_nameString
House name for an August device.
keypad_battery_levelString
Keypad battery level for an August device.
lock_idString
Lock ID for an August device.
lock_nameString
Lock name for an August device.
modelString
Model for an August device.
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.
code_constraintsListof Objects
Constraints on access codes for the device. Seam represents each constraint as an object with a constraint_type property. Depending on the constraint type, there may also be additional properties. Note that some constraints are manufacturer- or device-specific.
Child Object Properties
constraint_typeEnum
max_lengthNumber
Maximum name length constraint for access codes.
min_lengthNumber
Minimum name length constraint for access codes.
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.
door_openBoolean
Indicates whether the door is open.
dormakaba_oracode_metadataObject
Metadata for a dormakaba Oracode device.
Child Properties
device_idObject
Device ID for a dormakaba Oracode device.
door_idNumber
Door ID for a dormakaba Oracode device.
door_is_wirelessBoolean
Indicates whether a door is wireless for a dormakaba Oracode device.
door_nameString
Door name for a dormakaba Oracode device.
iana_timezoneString
IANA time zone for a dormakaba Oracode device.
predefined_time_slotsListof Objects
Predefined time slots for a dormakaba Oracode device.
check_in_timeString
Check in time for a time slot for a dormakaba Oracode device.
check_out_timeString
Checkout time for a time slot for a dormakaba Oracode device.
dormakaba_oracode_user_level_idUUID
ID of a user level for a dormakaba Oracode device.
ext_dormakaba_oracode_user_level_prefixNumber
Prefix for a user level for a dormakaba Oracode device.
is_24_hourBoolean
Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.
is_biweekly_modeBoolean
Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.
is_masterBoolean
Indicates whether a time slot for a dormakaba Oracode device is a master time slot.
is_one_shotBoolean
Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.
nameString
Name of a time slot for a dormakaba Oracode device.
prefixNumber
Prefix for a time slot for a dormakaba Oracode device.
site_idNumber
Site ID for a dormakaba Oracode device.
{% hint style="warning" %} Deprecated. Previously marked as "@DEPRECATED." {% endhint %}
site_nameString
Site name for a dormakaba Oracode device.
ecobee_metadataObject
Metadata for an ecobee device.
Child Properties
device_nameString
Device name for an ecobee device.
ecobee_device_idString
Device ID for an ecobee device.
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.
has_native_entry_eventsBoolean
Indicates whether the device supports native entry events.
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.
keypad_batteryObject
Keypad battery status.
Child Properties
levelNumber
Keypad battery charge level.
kwikset_metadataObject
Metadata for a Kwikset device.
Child Properties
device_idString
Device ID for a Kwikset device.
device_nameString
Device name for a Kwikset device.
model_numberString
Model number for a Kwikset device.
lockedBoolean
Indicates whether the lock is locked.
lockly_metadataObject
Metadata for a Lockly device.
Child Properties
device_idString
Device ID for a Lockly device.
device_nameString
Device name for a Lockly device.
modelString
Model for a Lockly device.
max_active_codes_supportedNumber
Maximum number of active access codes that the device supports.
minut_metadataObject
Metadata for a Minut device.
Child Properties
device_idString
Device ID for a Minut device.
device_nameString
Device name for a Minut device.
latest_sensor_valuesObject
Latest sensor values for a Minut device.
latest_sensor_values.accelerometer_zObject
Latest accelerometer Z-axis reading for a Minut device.
latest_sensor_values.accelerometer_z.timeString
Time of latest accelerometer Z-axis reading for a Minut device.
latest_sensor_values.accelerometer_z.valueNumber
Value of latest accelerometer Z-axis reading for a Minut device.
latest_sensor_values.humidityObject
Latest humidity reading for a Minut device.
latest_sensor_values.humidity.timeString
Time of latest humidity reading for a Minut device.
latest_sensor_values.humidity.valueNumber
Value of latest humidity reading for a Minut device.
latest_sensor_values.pressureObject
Latest pressure reading for a Minut device.
latest_sensor_values.pressure.timeString
Time of latest pressure reading for a Minut device.
latest_sensor_values.pressure.valueNumber
Value of latest pressure reading for a Minut device.
latest_sensor_values.soundObject
Latest sound reading for a Minut device.
latest_sensor_values.sound.timeString
Time of latest sound reading for a Minut device.
latest_sensor_values.sound.valueNumber
Value of latest sound reading for a Minut device.
latest_sensor_values.temperatureObject
Latest temperature reading for a Minut device.
latest_sensor_values.temperature.timeString
Time of latest temperature reading for a Minut device.
latest_sensor_values.temperature.valueNumber
Value of latest temperature reading for a Minut device.
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
nest_metadataObject
Metadata for a Google Nest device.
Child Properties
device_custom_nameString
Custom device name for a Google Nest device. The device owner sets this value.
device_nameString
Device name for a Google Nest device. Google sets this value.
display_nameString
Display name for a Google Nest device.
nest_device_idString
Device ID for a Google Nest device.
noiseaware_metadataObject
Metadata for a NoiseAware device.
Child Properties
device_idString
Device ID for a NoiseAware device.
device_modelEnum
Device model for a NoiseAware device.
device_nameString
Device name for a NoiseAware device.
noise_level_decibelNumber
Noise level, in decibels, for a NoiseAware device.
noise_level_nrsNumber
Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.
nuki_metadataObject
Metadata for a Nuki device.
Child Properties
device_idString
Device ID for a Nuki device.
device_nameString
Device name for a Nuki device.
keypad_2_pairedBoolean
Indicates whether keypad 2 is paired for a Nuki device.
keypad_battery_criticalBoolean
Indicates whether the keypad battery is in a critical state for a Nuki device.
keypad_pairedBoolean
Indicates whether the keypad is paired for a Nuki device.
offline_access_codes_enabledBoolean
Indicates whether it is currently possible to use offline access codes for the device.
onlineBoolean
Indicates whether the device is online.
online_access_codes_enabledBoolean
Indicates whether it is currently possible to use online access codes for the device.
salto_ks_metadataObject
Metadata for a Salto KS device.
Child Properties
battery_levelString
Battery level for a Salto KS device.
customer_referenceString
Customer reference for a Salto KS device.
lock_idString
Lock ID for a Salto KS device.
lock_typeString
Lock type for a Salto KS device.
locked_stateString
Locked state for a Salto KS device.
modelString
Model for a Salto KS device.
salto_metadataObject
Metada for a Salto device.
Deprecated. Use salto_ks_metadata instead.
Child Properties
battery_levelString
Battery level for a Salto device.
customer_referenceString
Customer reference for a Salto device.
lock_idString
Lock ID for a Salto device.
lock_typeString
Lock type for a Salto device.
locked_stateString
Locked state for a Salto device.
modelString
Model for a Salto device.
salto_space_credential_service_metadataObject
Salto Space credential service metadata for the phone.
Child Properties
has_active_phoneBoolean
Indicates whether the credential service has an active associated phone.
schlage_metadataObject
Metadata for a Schlage device.
Child Properties
device_idString
Device ID for a Schlage device.
device_nameString
Device name for a Schlage device.
modelString
Model for a Schlage device.
seam_bridge_metadataObject
Metadata for Seam Bridge.
Child Properties
device_numNumber
Device number for Seam Bridge.
nameString
Name for Seam Bridge.
unlock_methodEnum
Unlock method for Seam Bridge.
sensi_metadataObject
Metadata for a Sensi device.
Child Properties
device_idString
Device ID for a Sensi device.
device_nameString
Device name for a Sensi device.
product_typeString
Product type for a Sensi device.
smartthings_metadataObject
Metadata for a SmartThings device.
Child Properties
device_idString
Device ID for a SmartThings device.
device_nameString
Device name for a SmartThings device.
location_idString
Location ID for a SmartThings device.
modelString
Model for a SmartThings device.
supported_code_lengthsListof Numbers
Supported code lengths for access codes.
supports_accessory_keypadBoolean
Deprecated. use device.properties.model.can_connect_accessory_keypad
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.
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.
power_saving_mode
Indicates that the device is in power saving mode and may have limited functionality.
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.
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_lock_gateway_unlocking_not_enabled
Indicates that the Remote Unlock feature is not enabled in the settings."
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.
Method by which the affected lock device was locked. When the method is keycode, the access_code_id indicates the access code that was used, if reported by the device.
Method by which the affected lock device was unlocked. When the method is keycode, the access_code_id indicates the access code that was used, if reported by the device.