Skip to main content

The device Object

Represents a device that has been connected to Seam.
{
  "can_program_online_access_codes": true,
  "can_remotely_lock": true,
  "can_remotely_unlock": true,
  "capabilities_supported": [
    "access_code",
    "lock"
  ],
  "connected_account_id": "8e3a4f1b-2c7d-4a9e-8b5f-3d2c1a0b9e8f",
  "created_at": "2025-03-27T02:08:16.418Z",
  "space_ids": [],
  "custom_metadata": {
    "id": "internalId1"
  },
  "device_id": "a69569e1-133b-4a9d-b883-018641bfe543",
  "device_type": "schlage_lock",
  "display_name": "FRONT DOOR",
  "errors": [],
  "is_managed": true,
  "location": {
    "location_name": "Front Door",
    "timezone": "America/New_York"
  },
  "nickname": "Front Door",
  "properties": {
    "appearance": {
      "name": "FRONT DOOR"
    },
    "battery": {
      "level": 0.48,
      "status": "good"
    },
    "battery_level": 0.48,
    "code_constraints": [
      {
        "constraint_type": "name_length",
        "max_length": 9
      }
    ],
    "has_native_entry_events": true,
    "image_alt_text": "Schlage Sense Smart Deadbolt with Camelot Trim, Front",
    "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/schlage_sense-smart-deadbolt-with-camelot-trim_front.png&q=75&w=128",
    "locked": false,
    "manufacturer": "schlage",
    "model": {
      "accessory_keypad_supported": false,
      "can_connect_accessory_keypad": false,
      "display_name": "Encode",
      "has_built_in_keypad": true,
      "manufacturer_display_name": "Schlage",
      "offline_access_codes_supported": false,
      "online_access_codes_supported": true
    },
    "name": "FRONT DOOR",
    "offline_access_codes_enabled": false,
    "online": true,
    "online_access_codes_enabled": true,
    "schlage_metadata": {
      "device_id": "a69569e1-133b-4a9d-b883-018641bfe543",
      "device_name": "FRONT DOOR",
      "model": "Encode"
    },
    "serial_number": "34000000000531e0",
    "supported_code_lengths": [
      4,
      5,
      6,
      7,
      8
    ],
    "supports_backup_access_code_pool": true,
    "supports_offline_access_codes": false
  },
  "warnings": [],
  "workspace_id": "5d7f2e1a-9c8b-4f3e-8d2c-1a0b9e8f7c6d"
}

Properties

can_configure_auto_lock
Boolean
The can configure auto lock.
can_hvac_cool
Boolean
The can hvac cool.
can_hvac_heat
Boolean
The can hvac heat.
can_hvac_heat_cool
Boolean
The can hvac heat cool.
can_program_offline_access_codes
Boolean
The can program offline access codes.
can_program_online_access_codes
Boolean
The can program online access codes.
can_program_thermostat_programs_as_different_each_day
Boolean
The can program thermostat programs as different each day.
can_program_thermostat_programs_as_same_each_day
Boolean
The can program thermostat programs as same each day.
can_program_thermostat_programs_as_weekday_weekend
Boolean
The can program thermostat programs as weekday weekend.
can_remotely_lock
Boolean
The can remotely lock.
can_remotely_unlock
Boolean
The can remotely unlock.
can_run_thermostat_programs
Boolean
The can run thermostat programs.
can_simulate_connection
Boolean
The can simulate connection.
can_simulate_disconnection
Boolean
The can simulate disconnection.
can_simulate_hub_connection
Boolean
The can simulate hub connection.
can_simulate_hub_disconnection
Boolean
The can simulate hub disconnection.
can_simulate_paid_subscription
Boolean
The can simulate paid subscription.
can_simulate_removal
Boolean
The can simulate removal.
can_turn_off_hvac
Boolean
The can turn off hvac.
can_unlock_with_code
Boolean
The can unlock with code.
capabilities_supported
Array
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_id
String (UUID)
Unique identifier for the account associated with the device.
created_at
String (ISO 8601)
Date and time at which the device object was created.
custom_metadata
object
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_id
String (UUID)
ID of the device.
device_type
Enum (String)
Type of the device.
display_name
String
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.
errors
Array
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.
is_managed
Boolean
Indicates whether Seam manages the device. See also Managed and Unmanaged Devices.
nickname
String
Optional nickname to describe the device, settable through Seam.
properties
Object
Properties of the device.
space_ids
Array
IDs of the spaces the device is in.
warnings
Array
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.
workspace_id
String (UUID)
Unique identifier for the Seam workspace associated with the device.
device_manufacturer
Object
Manufacturer of the device. Represents the hardware brand, which may differ from the provider.
device_provider
Object
Provider of the device. Represents the third-party service through which the device is controlled.
location
Object
Location information for the device.

Access Codes

offline_access_codes_enabled
Boolean
deprecated
Indicates whether it is currently possible to use offline access codes for the device.
online_access_codes_enabled
Boolean
deprecated
Indicates whether it is currently possible to use online access codes for the device.
supports_accessory_keypad
Boolean
deprecated
The supports accessory keypad.
supports_offline_access_codes
Boolean
deprecated
The supports offline access codes.
code_constraints
Array
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.
has_native_entry_events
Boolean
Indicates whether the device supports native entry events.
keypad_battery
Object
Keypad battery status.
max_active_codes_supported
number
Maximum number of active access codes that the device supports.
supported_code_lengths
Array
Supported code lengths for access codes.
supports_backup_access_code_pool
Boolean
Indicates whether the device supports a backup access code pool.

Hardware

accessory_keypad
Object
Accessory keypad properties and state.
appearance
Object
Appearance-related properties, as reported by the device.
battery
Object
Represents the current status of the battery charge level.
battery_level
number
Indicates the battery level of the device as a decimal value between 0 and 1, inclusive.
has_direct_power
Boolean
Indicates whether the device has direct power.
image_alt_text
String
Alt text for the device image.
image_url
String
Image URL for the device.
manufacturer
String
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.
serial_number
String
Serial number of the device.

Locks

auto_lock_delay_seconds
number
The delay in seconds before the lock automatically locks after being unlocked.
auto_lock_enabled
Boolean
Indicates whether automatic locking is enabled.
door_open
Boolean
Indicates whether the door is open.
locked
Boolean
Indicates whether the lock is locked.

Noise Sensors

currently_triggering_noise_threshold_ids
Array
Array of noise threshold IDs that are currently triggering.
noise_level_decibels
number
Indicates current noise level in decibels, if the device supports noise detection.

Thermostats

active_thermostat_schedule
Object
deprecated
Active thermostat schedule.
active_thermostat_schedule_id
String (UUID)
ID of the active thermostat schedule.
available_climate_preset_modes
Array
Climate preset modes that the thermostat supports, such as “home”, “away”, “wake”, “sleep”, “occupied”, and “unoccupied”.
available_climate_presets
Array
Available climate presets for the thermostat.
available_fan_mode_settings
Array
Fan mode settings that the thermostat supports.
available_hvac_mode_settings
Array
HVAC mode settings that the thermostat supports.
current_climate_setting
Object
Current climate setting.
default_climate_setting
Object
deprecated
The default climate setting.
fallback_climate_preset_key
String
Key of the fallback climate preset for the thermostat.
fan_mode_setting
Enum (String)
deprecated
The fan mode setting.
is_cooling
Boolean
Indicates whether the connected HVAC system is currently cooling, as reported by the thermostat.
is_fan_running
Boolean
Indicates whether the fan in the connected HVAC system is currently running, as reported by the thermostat.
is_heating
Boolean
Indicates whether the connected HVAC system is currently heating, as reported by the thermostat.
is_temporary_manual_override_active
Boolean
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.
max_cooling_set_point_celsius
number
Maximum cooling set point in °C.
max_cooling_set_point_fahrenheit
number
Maximum cooling set point in °F.
max_heating_set_point_celsius
number
Maximum heating set point in °C.
max_heating_set_point_fahrenheit
number
Maximum heating set point in °F.
max_thermostat_daily_program_periods_per_day
number
Maximum number of periods that the thermostat can support per day. For example, if the thermostat supports 4 periods per day, this value is 4.
max_unique_climate_presets_per_thermostat_weekly_program
number
Maximum number of climate presets that the thermostat can support for weekly programming.
min_cooling_set_point_celsius
number
Minimum cooling set point in °C.
min_cooling_set_point_fahrenheit
number
Minimum cooling set point in °F.
min_heating_cooling_delta_celsius
number
Minimum temperature difference in °C between the cooling and heating set points when in heat-cool (auto) mode.
min_heating_cooling_delta_fahrenheit
number
Minimum temperature difference in °F between the cooling and heating set points when in heat-cool (auto) mode.
min_heating_set_point_celsius
number
Minimum heating set point in °C.
min_heating_set_point_fahrenheit
number
Minimum heating set point in °F.
relative_humidity
number
Reported relative humidity, as a value between 0 and 1, inclusive.
temperature_celsius
number
Reported temperature in °C.
temperature_fahrenheit
number
Reported temperature in °F.
temperature_threshold
Object
Current temperature threshold set for the thermostat.
thermostat_daily_program_period_precision_minutes
number
Precision of the thermostat’s period in minutes. For example, if the thermostat supports 15-minute periods, this value is 15. All values are relative to the top of the hour, so for 15 minutes, the periods would be 0, 15, 30, and 45 minutes past the hour.
thermostat_daily_programs
Array
Configured daily programs for the thermostat.
thermostat_weekly_program
Object
Current weekly program for the thermostat.

The device_provider Object

{
  "can_program_online_access_codes": true,
  "can_remotely_unlock": true,
  "device_provider_name": "akiles",
  "display_name": "Akiles",
  "image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/logos/akiles.png&q=75&w=128",
  "space_ids": [],
  "provider_categories": [
    "stable",
    "consumer_smartlocks"
  ]
}

Properties

can_configure_auto_lock
Boolean
The can configure auto lock.
can_hvac_cool
Boolean
The can hvac cool.
can_hvac_heat
Boolean
The can hvac heat.
can_hvac_heat_cool
Boolean
The can hvac heat cool.
can_program_offline_access_codes
Boolean
The can program offline access codes.
can_program_online_access_codes
Boolean
The can program online access codes.
can_program_thermostat_programs_as_different_each_day
Boolean
The can program thermostat programs as different each day.
can_program_thermostat_programs_as_same_each_day
Boolean
The can program thermostat programs as same each day.
can_program_thermostat_programs_as_weekday_weekend
Boolean
The can program thermostat programs as weekday weekend.
can_remotely_lock
Boolean
The can remotely lock.
can_remotely_unlock
Boolean
The can remotely unlock.
can_run_thermostat_programs
Boolean
The can run thermostat programs.
can_simulate_connection
Boolean
The can simulate connection.
can_simulate_disconnection
Boolean
The can simulate disconnection.
can_simulate_hub_connection
Boolean
The can simulate hub connection.
can_simulate_hub_disconnection
Boolean
The can simulate hub disconnection.
can_simulate_paid_subscription
Boolean
The can simulate paid subscription.
can_simulate_removal
Boolean
The can simulate removal.
can_turn_off_hvac
Boolean
The can turn off hvac.
can_unlock_with_code
Boolean
The can unlock with code.
device_provider_name
Enum (String)
The device provider name.
display_name
String
The display name.
image_url
String
The image url.
provider_categories
Array
The provider categories.