search
Sign UpSupported Devices
githubEdit

Devices

hashtag
The device Object

Represents a device that has been connected to Seam.

A lock device resource.

{
  "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"
}

hashtag
Properties

can_hvac_cool Boolean

can_hvac_heat Boolean

can_hvac_heat_cool Boolean

can_program_offline_access_codes Boolean

can_program_online_access_codes Boolean

can_program_thermostat_programs_as_different_each_day Boolean

can_program_thermostat_programs_as_same_each_day Boolean

can_program_thermostat_programs_as_weekday_weekend Boolean

can_remotely_lock Boolean

can_remotely_unlock Boolean

can_run_thermostat_programs Boolean

can_simulate_connection Boolean

can_simulate_disconnection Boolean

can_simulate_hub_connection Boolean

can_simulate_hub_disconnection Boolean

can_simulate_paid_subscription Boolean

can_simulate_removal Boolean

can_turn_off_hvac Boolean

can_unlock_with_code Boolean

capabilities_supported List of Enums

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 UUID

Unique identifier for the account associated with the device.

created_at Datetime

Date and time at which the device object was created.

custom_metadata Record

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 UUID

ID of the device.

device_type Enum

Type of the device.

chevron-rightEnum valueshashtag

  • 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

  • ultraloq_lock

  • korelock_lock

  • keynest_key

  • noiseaware_activity_zone

  • minut_sensor

  • ecobee_thermostat

  • nest_thermostat

  • honeywell_resideo_thermostat

  • tado_thermostat

  • sensi_thermostat

  • smartthings_thermostat

  • ios_phone

  • android_phone

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 List of Objects

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:

chevron-rightaccount_disconnectedhashtag

Indicates that the account is disconnected.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • account_disconnected

is_connected_account_error Boolean

Indicates that the error is a connected accountarrow-up-right error.

is_device_error Boolean

Indicates that the error is not a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightsalto_ks_subscription_limit_exceededhashtag

Indicates that the Salto site user limit has been reached.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • salto_ks_subscription_limit_exceeded

is_connected_account_error Boolean

Indicates that the error is a connected accountarrow-up-right error.

is_device_error Boolean

Indicates that the error is not a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightdevice_offlinehashtag

Indicates that the device is offline.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • device_offline

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightdevice_removedhashtag

Indicates that the device has been removed.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • device_removed

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-righthub_disconnectedhashtag

Indicates that the hub is disconnected.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • hub_disconnected

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightdevice_disconnectedhashtag

Indicates that the device is disconnected.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • device_disconnected

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightempty_backup_access_code_poolhashtag

Indicates that the backup access code poolarrow-up-right is empty.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • empty_backup_access_code_pool

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightaugust_lock_not_authorizedhashtag

Indicates that the user is not authorized to use the August lock.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • august_lock_not_authorized

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightaugust_lock_missing_bridgehashtag

Indicates that the lock is not connected to a bridge.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • august_lock_missing_bridge

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightttlock_lock_not_paired_to_gatewayhashtag

Indicates that the lock is not paired with a gateway.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

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_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightmissing_device_credentialshashtag

Indicates that device credentials are missing.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • missing_device_credentials

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightauxiliary_heat_runninghashtag

Indicates that the auxiliary heat is running.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • auxiliary_heat_running

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightsubscription_requiredhashtag

Indicates that a subscription is required to connect.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • subscription_required

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightlockly_missing_wifi_bridgehashtag

Indicates that the Lockly lock is not connected to a Wi-Fi bridge.

created_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • lockly_missing_wifi_bridge

is_device_error Boolean

Indicates that the error is a device error.

message String

Detailed description of the error. Provides insights into the issue and potentially how to rectify it.

chevron-rightbridge_disconnectedhashtag

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_at Datetime

Date and time at which Seam created the error.

error_code Enum

Unique identifier of the type of error. Enables quick recognition and categorization of the issue.

Enum values:

  • bridge_disconnected

is_bridge_error Boolean

Indicates whether the error is related to Seam Bridge.

is_connected_account_error Boolean

Indicates whether the error is related specifically to the connected account.

message String

Detailed description of the error. Provides 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.

space_ids List of UUIDs

IDs of the spaces the device is in.

warnings List of Objects

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:

chevron-rightpartial_backup_access_code_poolhashtag

Indicates that the backup access code is unhealthy.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • partial_backup_access_code_pool

chevron-rightmany_active_backup_codeshashtag

Indicates that there are too many backup codes.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • many_active_backup_codes

chevron-rightwyze_device_missing_gatewayhashtag

Indicates that the Wyze Lock is not connected to a gateway.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • wyze_device_missing_gateway

chevron-rightthird_party_integration_detectedhashtag

Indicates that a third-party integration has been detected.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • third_party_integration_detected

chevron-rightttlock_lock_gateway_unlocking_not_enabledhashtag

Indicates that the Remote Unlock feature is not enabled in the settings."

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • ttlock_lock_gateway_unlocking_not_enabled

chevron-rightttlock_weak_gateway_signalhashtag

Indicates that the gateway signal is weak.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • ttlock_weak_gateway_signal

chevron-rightpower_saving_modehashtag

Indicates that the device is in power saving mode and may have limited functionality.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • power_saving_mode

chevron-righttemperature_threshold_exceededhashtag

Indicates that the temperature threshold has been exceeded.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • temperature_threshold_exceeded

chevron-rightdevice_communication_degradedhashtag

Indicates that the device appears to be unresponsive.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • device_communication_degraded

chevron-rightscheduled_maintenance_windowhashtag

Indicates that a scheduled maintenance window has been detected.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • scheduled_maintenance_window

chevron-rightdevice_has_flaky_connectionhashtag

Indicates that the device has a flaky connection.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • device_has_flaky_connection

chevron-rightsalto_ks_office_modehashtag

Indicates that the Salto KS lock is in Office Mode. Access Codes will not unlock doors.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • salto_ks_office_mode

chevron-rightsalto_ks_privacy_modehashtag

Indicates that the Salto KS lock is in Privacy Mode. Access Codes will not unlock doors.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • salto_ks_privacy_mode

chevron-rightsalto_ks_subscription_limit_almost_reachedhashtag

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_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • salto_ks_subscription_limit_almost_reached

chevron-rightunknown_issue_with_phonehashtag

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_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • unknown_issue_with_phone

chevron-rightlockly_time_zone_not_configuredhashtag

Indicates that Seam detected that the Lockly device does not have a time zone configured. Time-bound codes may not work as expected.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • lockly_time_zone_not_configured

chevron-rightultraloq_time_zone_unknownhashtag

Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • ultraloq_time_zone_unknown

chevron-righthub_required_for_additional_capabilitieshashtag

Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • hub_required_for_additional_capabilities

chevron-rightkeynest_unsupported_lockerhashtag

Indicates that the key is in a locker that does not support the access codes API.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • keynest_unsupported_locker

chevron-rightaccessory_keypad_setup_requiredhashtag

Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.

created_at Datetime

Date and time at which Seam created the warning.

message String

Detailed description of the warning. Provides insights into the issue and potentially how to rectify it.

warning_code Enum

Unique identifier of the type of warning. Enables quick recognition and categorization of the issue.

Enum values:

  • accessory_keypad_setup_required

workspace_id UUID

Unique identifier for the Seam workspace associated with the device.

hashtag
Hardware

device_manufacturer Object

Manufacturer of the device. Represents the hardware brand, which may differ from the provider.

chevron-rightChild Propertieshashtag

  • display_name String

    Display name for the manufacturer, such as August, Yale, Salto, and so on.

  • image_url String

    Image URL for the manufacturer logo.

  • manufacturer String

    Manufacturer identifier, such as august, yale, salto, and so on.

device_provider Object

Provider of the device. Represents the third-party service through which the device is controlled.

chevron-rightChild Propertieshashtag

  • device_provider_name String

    Device provider name. Corresponds to the integration type, such as august, schlage, yale_access, and so on.

  • display_name String

    Display name for the device provider type.

  • image_url String

    Image URL for the device provider.

  • provider_category String

    Provider category. Indicates the third-party provider type, such as stable, for stable integrations, or internal, for internal integrations.

location Object

Location information for the device.

chevron-rightChild Propertieshashtag

  • location_name String

    Name of the device location.

  • timezone String

    Time zone of the device location.

hashtag
device.properties

akiles_metadata Object

Metadata for an Akiles device.

chevron-rightChild Propertieshashtag

  • _member_group_id String

    Group ID to which to add users for an Akiles device.

  • gadget_id String

    Gadget ID for an Akiles device.

  • gadget_name String

    Gadget name for an Akiles device.

  • product_name String

    Product name for an Akiles device.

assa_abloy_credential_service_metadata Object

ASSA ABLOY Credential Service metadata for the phone.

chevron-rightChild Propertieshashtag

  • endpoints List of Objects

    Endpoints associated with the phone.

  • endpoint_id String

    ID of the associated endpoint.

  • is_active Boolean

    Indicated whether the endpoint is active.

    • has_active_endpoint Boolean

      Indicates whether the credential service has active endpoints associated with the phone.

assa_abloy_vostio_metadata Object

Metadata for an ASSA ABLOY Vostio system.

chevron-rightChild Propertieshashtag

  • encoder_name String

    Encoder name for an ASSA ABLOY Vostio system.

august_metadata Object

Metadata for an August device.

chevron-rightChild Propertieshashtag

  • has_keypad Boolean

    Indicates whether an August device has a keypad.

  • house_id String

    House ID for an August device.

  • house_name String

    House name for an August device.

  • keypad_battery_level String

    Keypad battery level for an August device.

  • lock_id String

    Lock ID for an August device.

  • lock_name String

    Lock name for an August device.

  • model String

    Model for an August device.

avigilon_alta_metadata Object

Metadata for an Avigilon Alta system.

chevron-rightChild Propertieshashtag

  • entry_name String

    Entry name for an Avigilon Alta system.

  • entry_relays_total_count Number

    Total count of entry relays for an Avigilon Alta system.

  • org_name String

    Organization name for an Avigilon Alta system.

  • site_id Number

    Site ID for an Avigilon Alta system.

  • site_name String

    Site name for an Avigilon Alta system.

  • zone_id Number

    Zone ID for an Avigilon Alta system.

  • zone_name String

    Zone name for an Avigilon Alta system.

brivo_metadata Object

Metadata for a Brivo device.

chevron-rightChild Propertieshashtag

  • activation_enabled Boolean

    Indicates whether the Brivo access point has activation (remote unlock) enabled.

  • device_name String

    Device name for a Brivo device.

controlbyweb_metadata Object

Metadata for a ControlByWeb device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a ControlByWeb device.

  • device_name String

    Device name for a ControlByWeb device.

  • relay_name String

    Relay name for a ControlByWeb device.

dormakaba_oracode_metadata Object

Metadata for a dormakaba Oracode device.

chevron-rightChild Propertieshashtag

  • device_id Object

    Device ID for a dormakaba Oracode device.

  • door_id Number

    Door ID for a dormakaba Oracode device.

  • door_is_wireless Boolean

    Indicates whether a door is wireless for a dormakaba Oracode device.

  • door_name String

    Door name for a dormakaba Oracode device.

  • iana_timezone String

    IANA time zone for a dormakaba Oracode device.

  • predefined_time_slots List of Objects

    Predefined time slots for a dormakaba Oracode device.

  • check_in_time String

    Check in time for a time slot for a dormakaba Oracode device.

  • check_out_time String

    Checkout time for a time slot for a dormakaba Oracode device.

  • dormakaba_oracode_user_level_id UUID

    ID of a user level for a dormakaba Oracode device.

  • ext_dormakaba_oracode_user_level_prefix Number

    Prefix for a user level for a dormakaba Oracode device.

  • is_24_hour Boolean

    Indicates whether a time slot for a dormakaba Oracode device is a 24-hour time slot.

  • is_biweekly_mode Boolean

    Indicates whether a time slot for a dormakaba Oracode device is in biweekly mode.

  • is_master Boolean

    Indicates whether a time slot for a dormakaba Oracode device is a master time slot.

  • is_one_shot Boolean

    Indicates whether a time slot for a dormakaba Oracode device is a one-shot time slot.

  • name String

    Name of a time slot for a dormakaba Oracode device.

  • prefix Number

    Prefix for a time slot for a dormakaba Oracode device.

    • site_id Number

      Site ID for a dormakaba Oracode device.

    circle-exclamation

    Deprecated. Previously marked as "@DEPRECATED."

    • site_name String

      Site name for a dormakaba Oracode device.

ecobee_metadata Object

Metadata for an ecobee device.

chevron-rightChild Propertieshashtag

  • device_name String

    Device name for an ecobee device.

  • ecobee_device_id String

    Device ID for an ecobee device.

four_suites_metadata Object

Metadata for a 4SUITES device.

chevron-rightChild Propertieshashtag

  • device_id Number

    Device ID for a 4SUITES device.

  • device_name String

    Device name for a 4SUITES device.

  • reclose_delay_in_seconds Number

    Reclose delay, in seconds, for a 4SUITES device.

genie_metadata Object

Metadata for a Genie device.

chevron-rightChild Propertieshashtag

  • device_name String

    Lock name for a Genie device.

  • door_name String

    Door name for a Genie device.

honeywell_resideo_metadata Object

Metadata for a Honeywell Resideo device.

chevron-rightChild Propertieshashtag

  • device_name String

    Device name for a Honeywell Resideo device.

  • honeywell_resideo_device_id String

    Device ID for a Honeywell Resideo device.

hubitat_metadata Object

Metadata for a Hubitat device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a Hubitat device.

  • device_label String

    Device label for a Hubitat device.

  • device_name String

    Device name for a Hubitat device.

igloo_metadata Object

Metadata for an igloo device.

chevron-rightChild Propertieshashtag

  • bridge_id String

    Bridge ID for an igloo device.

  • device_id String

    Device ID for an igloo device.

  • model String

    Model for an igloo device.

igloohome_metadata Object

Metadata for an igloohome device.

chevron-rightChild Propertieshashtag

  • bridge_id String

    Bridge ID for an igloohome device.

  • bridge_name String

    Bridge name for an igloohome device.

  • device_id String

    Device ID for an igloohome device.

  • device_name String

    Device name for an igloohome device.

  • is_accessory_keypad_linked_to_bridge Boolean

    Indicates whether a keypad is linked to a bridge for an igloohome device.

  • keypad_id String

    Keypad ID for an igloohome device.

keynest_metadata Object

Metadata for a KeyNest device.

chevron-rightChild Propertieshashtag

  • address String

    Address for a KeyNest device.

  • current_or_last_store_id Number

    Current or last store ID for a KeyNest device.

  • current_status String

    Current status for a KeyNest device.

  • current_user_company String

    Current user company for a KeyNest device.

  • current_user_email String

    Current user email for a KeyNest device.

  • current_user_name String

    Current user name for a KeyNest device.

  • current_user_phone_number String

    Current user phone number for a KeyNest device.

  • default_office_id Number

    Default office ID for a KeyNest device.

  • device_name String

    Device name for a KeyNest device.

  • fob_id Number

    Fob ID for a KeyNest device.

  • handover_method String

    Handover method for a KeyNest device.

  • has_photo Boolean

    Whether the KeyNest device has a photo.

  • is_quadient_locker Boolean

    Whether the key is in a locker that does not support the access codes API.

  • key_id String

    Key ID for a KeyNest device.

  • key_notes String

    Key notes for a KeyNest device.

  • keynest_app_user String

    KeyNest app user for a KeyNest device.

  • last_movement String

    Last movement timestamp for a KeyNest device.

  • property_id String

    Property ID for a KeyNest device.

  • property_postcode String

    Property postcode for a KeyNest device.

  • status_type String

    Status type for a KeyNest device.

  • subscription_plan String

    Subscription plan for a KeyNest device.

korelock_metadata Object

Metadata for a Korelock device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a Korelock device.

  • device_name String

    Device name for a Korelock device.

  • firmware_version String

    Firmware version for a Korelock device.

  • model_code String

    Model code for a Korelock device.

  • serial_number String

    Serial number for a Korelock device.

  • wifi_signal_strength Number

    WiFi signal strength (0-1) for a Korelock device.

kwikset_metadata Object

Metadata for a Kwikset device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a Kwikset device.

  • device_name String

    Device name for a Kwikset device.

  • model_number String

    Model number for a Kwikset device.

lockly_metadata Object

Metadata for a Lockly device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a Lockly device.

  • device_name String

    Device name for a Lockly device.

  • model String

    Model for a Lockly device.

minut_metadata Object

Metadata for a Minut device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a Minut device.

  • device_name String

    Device name for a Minut device.

  • latest_sensor_values Object

    Latest sensor values for a Minut device.

  • latest_sensor_values.accelerometer_z Object

    Latest accelerometer Z-axis reading for a Minut device.

  • latest_sensor_values.accelerometer_z.time String

    Time of latest accelerometer Z-axis reading for a Minut device.

  • latest_sensor_values.accelerometer_z.value Number

    Value of latest accelerometer Z-axis reading for a Minut device.

  • latest_sensor_values.humidity Object

    Latest humidity reading for a Minut device.

  • latest_sensor_values.humidity.time String

    Time of latest humidity reading for a Minut device.

  • latest_sensor_values.humidity.value Number

    Value of latest humidity reading for a Minut device.

  • latest_sensor_values.pressure Object

    Latest pressure reading for a Minut device.

  • latest_sensor_values.pressure.time String

    Time of latest pressure reading for a Minut device.

  • latest_sensor_values.pressure.value Number

    Value of latest pressure reading for a Minut device.

  • latest_sensor_values.sound Object

    Latest sound reading for a Minut device.

  • latest_sensor_values.sound.time String

    Time of latest sound reading for a Minut device.

  • latest_sensor_values.sound.value Number

    Value of latest sound reading for a Minut device.

  • latest_sensor_values.temperature Object

    Latest temperature reading for a Minut device.

  • latest_sensor_values.temperature.time String

    Time of latest temperature reading for a Minut device.

  • latest_sensor_values.temperature.value Number

    Value of latest temperature reading for a Minut device.

model Object

Device model-related properties.

chevron-rightChild Propertieshashtag

  • accessory_keypad_supported Boolean

circle-exclamation

Deprecated. use device.properties.model.can_connect_accessory_keypad

  • can_connect_accessory_keypad Boolean

    Indicates whether the device can connect a accessory keypad.

  • display_name String

    Display name of the device model.

  • has_built_in_keypad Boolean

    Indicates whether the device has a built in accessory keypad.

  • manufacturer_display_name String

    Display name that corresponds to the manufacturer-specific terminology for the device.

  • offline_access_codes_supported Boolean

circle-exclamation

Deprecated. use device.can_program_offline_access_codes.

  • online_access_codes_supported Boolean

circle-exclamation

Deprecated. use device.can_program_online_access_codes.

name String

Name of the device.

circle-exclamation

Deprecated. use device.display_name instead

nest_metadata Object

Metadata for a Google Nest device.

chevron-rightChild Propertieshashtag

  • device_custom_name String

    Custom device name for a Google Nest device. The device owner sets this value.

  • device_name String

    Device name for a Google Nest device. Google sets this value.

  • display_name String

    Display name for a Google Nest device.

  • nest_device_id String

    Device ID for a Google Nest device.

noiseaware_metadata Object

Metadata for a NoiseAware device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a NoiseAware device.

  • device_model Enum

    Device model for a NoiseAware device.

  • device_name String

    Device name for a NoiseAware device.

  • noise_level_decibel Number

    Noise level, in decibels, for a NoiseAware device.

  • noise_level_nrs Number

    Noise level, expressed as a Noise Risk Score (NRS), for a NoiseAware device.

nuki_metadata Object

Metadata for a Nuki device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a Nuki device.

  • device_name String

    Device name for a Nuki device.

  • keypad_2_paired Boolean

    Indicates whether keypad 2 is paired for a Nuki device.

  • keypad_battery_critical Boolean

    Indicates whether the keypad battery is in a critical state for a Nuki device.

  • keypad_paired Boolean

    Indicates whether the keypad is paired for a Nuki device.

online Boolean

Indicates whether the device is online.

salto_ks_metadata Object

Metadata for a Salto KS device.

chevron-rightChild Propertieshashtag

  • battery_level String

    Battery level for a Salto KS device.

  • customer_reference String

    Customer reference for a Salto KS device.

  • has_custom_pin_subscription Boolean

    Indicates whether the site has a Salto KS subscription that supports custom PINs.

  • lock_id String

    Lock ID for a Salto KS device.

  • lock_type String

    Lock type for a Salto KS device.

  • locked_state String

    Locked state for a Salto KS device.

  • model String

    Model for a Salto KS device.

salto_metadata Object

Metada for a Salto device.

circle-exclamation

Deprecated. Use salto_ks_metadata instead.

chevron-rightChild Propertieshashtag

  • battery_level String

    Battery level for a Salto device.

  • customer_reference String

    Customer reference for a Salto device.

  • lock_id String

    Lock ID for a Salto device.

  • lock_type String

    Lock type for a Salto device.

  • locked_state String

    Locked state for a Salto device.

  • model String

    Model for a Salto device.

salto_space_credential_service_metadata Object

Salto Space credential service metadata for the phone.

chevron-rightChild Propertieshashtag

  • has_active_phone Boolean

    Indicates whether the credential service has an active associated phone.

schlage_metadata Object

Metadata for a Schlage device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a Schlage device.

  • device_name String

    Device name for a Schlage device.

  • model String

    Model for a Schlage device.

seam_bridge_metadata Object

Metadata for Seam Bridge.

chevron-rightChild Propertieshashtag

  • device_num Number

    Device number for Seam Bridge.

  • name String

    Name for Seam Bridge.

  • unlock_method Enum

    Unlock method for Seam Bridge.

sensi_metadata Object

Metadata for a Sensi device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a Sensi device.

  • device_name String

    Device name for a Sensi device.

  • product_type String

    Product type for a Sensi device.

smartthings_metadata Object

Metadata for a SmartThings device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a SmartThings device.

  • device_name String

    Device name for a SmartThings device.

  • location_id String

    Location ID for a SmartThings device.

  • model String

    Model for a SmartThings device.

tado_metadata Object

Metadata for a tado° device.

chevron-rightChild Propertieshashtag

  • device_type String

    Device type for a tado° device.

  • serial_no String

    Serial number for a tado° device.

tedee_metadata Object

Metadata for a Tedee device.

chevron-rightChild Propertieshashtag

  • bridge_id Number

    Bridge ID for a Tedee device.

  • bridge_name String

    Bridge name for a Tedee device.

  • device_id Number

    Device ID for a Tedee device.

  • device_model String

    Device model for a Tedee device.

  • device_name String

    Device name for a Tedee device.

  • keypad_id Number

    Keypad ID for a Tedee device.

  • serial_number String

    Serial number for a Tedee device.

ttlock_metadata Object

Metadata for a TTLock device.

chevron-rightChild Propertieshashtag

  • feature_value String

    Feature value for a TTLock device.

  • features Object

    Features for a TTLock device.

  • features.incomplete_keyboard_passcode Boolean

    Indicates whether a TTLock device supports an incomplete keyboard passcode.

  • features.lock_command Boolean

    Indicates whether a TTLock device supports the lock command.

  • features.passcode Boolean

    Indicates whether a TTLock device supports a passcode.

  • features.passcode_management Boolean

    Indicates whether a TTLock device supports passcode management.

  • features.unlock_via_gateway Boolean

    Indicates whether a TTLock device supports unlock via gateway.

  • features.wifi Boolean

    Indicates whether a TTLock device supports Wi-Fi.

  • has_gateway Boolean

    Indicates whether a TTLock device has a gateway.

  • lock_alias String

    Lock alias for a TTLock device.

  • lock_id Number

    Lock ID for a TTLock device.

  • wireless_keypads List of Objects

    Wireless keypads for a TTLock device.

  • wireless_keypad_id Number

    ID for a wireless keypad for a TTLock device.

  • wireless_keypad_name String

    Name for a wireless keypad for a TTLock device.

two_n_metadata Object

Metadata for a 2N device.

chevron-rightChild Propertieshashtag

  • device_id Number

    Device ID for a 2N device.

  • device_name String

    Device name for a 2N device.

ultraloq_metadata Object

Metadata for an Ultraloq device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for an Ultraloq device.

  • device_name String

    Device name for an Ultraloq device.

  • device_type String

    Device type for an Ultraloq device.

  • time_zone String

    IANA timezone for the Ultraloq device.

visionline_metadata Object

Metadata for an ASSA ABLOY Visionline system.

chevron-rightChild Propertieshashtag

  • encoder_id String

    Encoder ID for an ASSA ABLOY Visionline system.

wyze_metadata Object

Metadata for a Wyze device.

chevron-rightChild Propertieshashtag

  • device_id String

    Device ID for a Wyze device.

  • device_info_model String

    Device information model for a Wyze device.

  • device_name String

    Device name for a Wyze device.

  • keypad_uuid String

    Keypad UUID for a Wyze device.

  • locker_status_hardlock Number

    Locker status (hardlock) for a Wyze device.

  • product_model String

    Product model for a Wyze device.

  • product_name String

    Product name for a Wyze device.

  • product_type String

    Product type for a Wyze device.

hashtag
Access Codes

code_constraints List of 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.

chevron-rightChild Object Propertieshashtag

constraint_type Enum

max_length Number

Maximum name length constraint for access codes.

min_length Number

Minimum name length constraint for access codes.

has_native_entry_events Boolean

Indicates whether the device supports native entry events.

keypad_battery Object

Keypad battery status.

chevron-rightChild Propertieshashtag

  • level Number

    Keypad battery charge level.

max_active_codes_supported Number

Maximum number of active access codes that the device supports.

offline_access_codes_enabled Boolean

Indicates whether it is currently possible to use offline access codes for the device.

circle-exclamation

Deprecated. use device.can_program_offline_access_codes

online_access_codes_enabled Boolean

Indicates whether it is currently possible to use online access codes for the device.

circle-exclamation

Deprecated. use device.can_program_online_access_codes

supported_code_lengths List of Numbers

Supported code lengths for access codes.

supports_accessory_keypad Boolean

circle-exclamation

Deprecated. use device.properties.model.can_connect_accessory_keypad

supports_backup_access_code_pool Boolean

Indicates whether the device supports a backup access code poolarrow-up-right.

supports_offline_access_codes Boolean

circle-exclamation

Deprecated. use offline_access_codes_enabled

hashtag
Hardware

accessory_keypad Object

Accessory keypad properties and state.

chevron-rightChild Propertieshashtag

  • battery Object

    Keypad battery properties.

  • battery.level Number

  • is_connected Boolean

    Indicates if an accessory keypad is connected to the device.

appearance Object

Appearance-related properties, as reported by the device.

chevron-rightChild Propertieshashtag

  • name String

    Name of the device as seen from the provider API and application, not settable through Seam.

battery Object

Represents the current status of the battery charge level.

chevron-rightChild Propertieshashtag

  • level Number

    Battery charge level as a value between 0 and 1, inclusive.

  • status Enum

    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_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.

hashtag
Locks

door_open Boolean

Indicates whether the door is open.

locked Boolean

Indicates whether the lock is locked.

hashtag
Noise Sensors

currently_triggering_noise_threshold_ids List of Strings

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.

hashtag
Thermostats

active_thermostat_schedule Object

Active thermostat schedule.

circle-exclamation

Deprecated. Use active_thermostat_schedule_id with /thermostats/schedules/get instead.

chevron-rightChild Propertieshashtag

active_thermostat_schedule_id UUID

ID of the active thermostat schedule.

available_climate_preset_modes List of Enums

Climate preset modes that the thermostat supports, such as "home", "away", "wake", "sleep", "occupied", and "unoccupied".

available_climate_presets List of Objects

Available climate presets for the thermostat.

chevron-rightChild Object Propertieshashtag

can_delete Boolean

Indicates whether the climate preset key can be deleted.

can_edit Boolean

Indicates whether the climate preset key can be edited.

can_use_with_thermostat_daily_programs Boolean

Indicates whether the climate preset key can be programmed in a thermostat daily program.

climate_preset_key String

Unique key to identify the climate preset.

climate_preset_mode Enum

The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

cooling_set_point_celsius Number

Temperature to which the thermostat should cool (in °C). See also Set Points.

cooling_set_point_fahrenheit Number

Temperature to which the thermostat should cool (in °F). See also Set Points.

display_name String

Display name for the climate preset.

ecobee_metadata Object

Metadata specific to the Ecobee climate, if applicable.

ecobee_metadata.climate_ref String

Reference to the Ecobee climate, if applicable.

ecobee_metadata.is_optimized Boolean

Indicates if the climate preset is optimized by Ecobee.

ecobee_metadata.owner Enum

Indicates whether the climate preset is owned by the user or the system.

fan_mode_setting Enum

Desired fan mode settingarrow-up-right, such as on, auto, or circulate.

heating_set_point_celsius Number

Temperature to which the thermostat should heat (in °C). See also Set Points.

heating_set_point_fahrenheit Number

Temperature to which the thermostat should heat (in °F). See also Set Points.

hvac_mode_setting Enum

Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

manual_override_allowed Boolean

Indicates whether a person at the thermostat can change the thermostat's settings. See Specifying Manual Override Permissions.

circle-exclamation

Deprecated. Use 'thermostat_schedule.is_override_allowed'

name String

User-friendly name to identify the climate preset.

available_fan_mode_settings List of Enums

Fan mode settings that the thermostat supports.

available_hvac_mode_settings List of Enums

HVAC mode settings that the thermostat supports.

current_climate_setting Object

Current climate setting.

chevron-rightChild Propertieshashtag

  • can_delete Boolean

    Indicates whether the climate preset key can be deleted.

  • can_edit Boolean

    Indicates whether the climate preset key can be edited.

  • can_use_with_thermostat_daily_programs Boolean

    Indicates whether the climate preset key can be programmed in a thermostat daily program.

  • climate_preset_key String

    Unique key to identify the climate preset.

  • climate_preset_mode Enum

    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

  • cooling_set_point_celsius Number

    Temperature to which the thermostat should cool (in °C). See also Set Points.

  • cooling_set_point_fahrenheit Number

    Temperature to which the thermostat should cool (in °F). See also Set Points.

  • display_name String

    Display name for the climate preset.

  • ecobee_metadata Object

    Metadata specific to the Ecobee climate, if applicable.

  • ecobee_metadata.climate_ref String

    Reference to the Ecobee climate, if applicable.

  • ecobee_metadata.is_optimized Boolean

    Indicates if the climate preset is optimized by Ecobee.

  • ecobee_metadata.owner Enum

    Indicates whether the climate preset is owned by the user or the system.

  • fan_mode_setting Enum

    Desired fan mode settingarrow-up-right, such as on, auto, or circulate.

  • heating_set_point_celsius Number

    Temperature to which the thermostat should heat (in °C). See also Set Points.

  • heating_set_point_fahrenheit Number

    Temperature to which the thermostat should heat (in °F). See also Set Points.

  • hvac_mode_setting Enum

    Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

  • manual_override_allowed Boolean

    Indicates whether a person at the thermostat can change the thermostat's settings. See Specifying Manual Override Permissions.

circle-exclamation

Deprecated. Use 'thermostat_schedule.is_override_allowed'

default_climate_setting Object

circle-exclamation

Deprecated. use fallback_climate_preset_key to specify a fallback climate preset instead.

chevron-rightChild Propertieshashtag

  • can_delete Boolean

    Indicates whether the climate preset key can be deleted.

  • can_edit Boolean

    Indicates whether the climate preset key can be edited.

  • can_use_with_thermostat_daily_programs Boolean

    Indicates whether the climate preset key can be programmed in a thermostat daily program.

  • climate_preset_key String

    Unique key to identify the climate preset.

  • climate_preset_mode Enum

    The climate preset mode for the thermostat, based on the available climate preset modes reported by the device.

  • cooling_set_point_celsius Number

    Temperature to which the thermostat should cool (in °C). See also Set Points.

  • cooling_set_point_fahrenheit Number

    Temperature to which the thermostat should cool (in °F). See also Set Points.

  • display_name String

    Display name for the climate preset.

  • ecobee_metadata Object

    Metadata specific to the Ecobee climate, if applicable.

  • ecobee_metadata.climate_ref String

    Reference to the Ecobee climate, if applicable.

  • ecobee_metadata.is_optimized Boolean

    Indicates if the climate preset is optimized by Ecobee.

  • ecobee_metadata.owner Enum

    Indicates whether the climate preset is owned by the user or the system.

  • fan_mode_setting Enum

    Desired fan mode settingarrow-up-right, such as on, auto, or circulate.

  • heating_set_point_celsius Number

    Temperature to which the thermostat should heat (in °C). See also Set Points.

  • heating_set_point_fahrenheit Number

    Temperature to which the thermostat should heat (in °F). See also Set Points.

  • hvac_mode_setting Enum

    Desired HVAC mode setting, such as heat, cool, heat_cool, or off.

  • manual_override_allowed Boolean

    Indicates whether a person at the thermostat can change the thermostat's settings. See Specifying Manual Override Permissions.

circle-exclamation

Deprecated. Use 'thermostat_schedule.is_override_allowed'

fallback_climate_preset_key String

Key of the fallback climate preset for the thermostat.

fan_mode_setting Enum

circle-exclamation

Deprecated. Use current_climate_setting.fan_mode_setting instead.

chevron-rightEnum valueshashtag

  • auto

  • on

  • circulate

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.

chevron-rightChild Propertieshashtag

  • lower_limit_celsius Number

    Lower limit in °C within the current temperature threshold set for the thermostat.

  • lower_limit_fahrenheit Number

    Lower limit in °F within the current temperature threshold set for the thermostat.

  • upper_limit_celsius Number

    Upper limit in °C within the current temperature threshold set for the thermostat.

  • upper_limit_fahrenheit Number

    Upper limit in °F within the 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 List of Objects

Configured daily programs for the thermostat.

chevron-rightChild Object Propertieshashtag

created_at Datetime

Date and time at which the thermostat daily program was created.

device_id UUID

ID of the thermostat device on which the thermostat daily program is configured.

name String

User-friendly name to identify the thermostat daily program.

periods List of Objects

Array of thermostat daily program periods.

  • climate_preset_key String

    Key of the climate preset to activate at the starts_at_time.

  • starts_at_time String

    Time at which the thermostat daily program period starts, in ISO 8601arrow-up-right format.

thermostat_daily_program_id UUID

ID of the thermostat daily program.

workspace_id UUID

ID of the workspace that contains the thermostat daily program.

thermostat_weekly_program Object

Current weekly program for the thermostat.

chevron-rightChild Propertieshashtag

  • created_at Datetime

    Date and time at which the thermostat weekly program was created.

  • friday_program_id UUID

    ID of the thermostat daily program to run on Fridays.

  • monday_program_id UUID

    ID of the thermostat daily program to run on Mondays.

  • saturday_program_id UUID

    ID of the thermostat daily program to run on Saturdays.

  • sunday_program_id UUID

    ID of the thermostat daily program to run on Sundays.

  • thursday_program_id UUID

    ID of the thermostat daily program to run on Thursdays.

  • tuesday_program_id UUID

    ID of the thermostat daily program to run on Tuesdays.

  • wednesday_program_id UUID

    ID of the thermostat daily program to run on Wednesdays.

hashtag
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.

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.

hashtag
Access Codes

empty_backup_access_code_pool

Indicates that the backup access code poolarrow-up-right is empty.

hashtag
Locks

august_lock_missing_bridge

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.

hashtag
Thermostats

auxiliary_heat_running

Indicates that the auxiliary heat is running.

hashtag
Warnings

device_communication_degraded

Indicates that the device appears to be unresponsive.

device_has_flaky_connection

Indicates that the device has a flaky connection.

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.

ultraloq_time_zone_unknown

Indicates that Seam does not know the time zone of the Ultraloq device. Set a time zone to enable time-bound access codes.

wyze_device_missing_gateway

Indicates that the Wyze Lock is not connected to a gateway.

hashtag
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.

hashtag
Locks

accessory_keypad_setup_required

Indicates that the accessory keypad exists, but is not linked to the Igloohome Bridge. Online access code programming will fail until the keypad is linked to the Igloohome Bridge in the Igloohome app.

hub_required_for_additional_capabilities

Indicates that a hub or relay must be connected to unlock additional capabilities such as remote unlock.

keynest_unsupported_locker

Indicates that the key is in a locker that does not support the access codes API.

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."

hashtag
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.

hashtag
Thermostats

temperature_threshold_exceeded

Indicates that the temperature threshold has been exceeded.

hashtag
The device_provider Object

A device provider resource.

hashtag
Properties

can_hvac_cool Boolean

can_hvac_heat Boolean

can_hvac_heat_cool Boolean

can_program_offline_access_codes Boolean

can_program_online_access_codes Boolean

can_program_thermostat_programs_as_different_each_day Boolean

can_program_thermostat_programs_as_same_each_day Boolean

can_program_thermostat_programs_as_weekday_weekend Boolean

can_remotely_lock Boolean

can_remotely_unlock Boolean

can_run_thermostat_programs Boolean

can_simulate_connection Boolean

can_simulate_disconnection Boolean

can_simulate_hub_connection Boolean

can_simulate_hub_disconnection Boolean

can_simulate_paid_subscription Boolean

can_simulate_removal Boolean

can_turn_off_hvac Boolean

can_unlock_with_code Boolean

device_provider_name Enum

chevron-rightEnum valueshashtag

  • hotek

  • dormakaba_community

  • legic_connect

  • akuvox

  • august

  • avigilon_alta

  • brivo

  • butterflymx

  • schlage

  • smartthings

  • yale

  • genie

  • doorking

  • salto

  • salto_ks

  • lockly

  • ttlock

  • linear

  • noiseaware

  • nuki

  • seam_relay_admin

  • igloo

  • kwikset

  • minut

  • my_2n

  • controlbyweb

  • nest

  • igloohome

  • ecobee

  • hubitat

  • four_suites

  • dormakaba_oracode

  • pti

  • wyze

  • seam_passport

  • visionline

  • assa_abloy_credential_service

  • tedee

  • honeywell_resideo

  • latch

  • akiles

  • assa_abloy_vostio

  • assa_abloy_vostio_credential_service

  • tado

  • salto_space

  • sensi

  • kwikset2

  • keynest

  • korelock

  • dormakaba_ambiance

  • ultraloq

display_name String

image_url String

provider_categories List of Enums

hashtag
Events

device.connected

The status of a device changed from offline to online. That is, the device.properties.online property changed from false to true. Note that some devices operate entirely in offline mode, so Seam never emits a device.connected event for these devices.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.connected

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.added

A device was added to Seam or was re-added to Seam after having been removed.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.added

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.converted_to_unmanaged

A managed device was successfully converted to an unmanaged device.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.converted_to_unmanaged

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.disconnected

The status of a device changed from online to offline. That is, the device.properties.online property changed from true to false.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

error_code Enum

Error code associated with the disconnection event, if any.

event_id UUID

ID of the event.

event_type Enum

Value: device.disconnected

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.tampered

A device detected that it was tampered with, for example, opened or moved.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.tampered

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.low_battery

A device battery level dropped below the low threshold.

chevron-rightPropertieshashtag

battery_level Number

Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.low_battery

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.battery_status_changed

A device battery status changed since the last battery_status_changed event.

chevron-rightPropertieshashtag

battery_level Number

Number in the range 0 to 1.0 indicating the amount of battery in the affected device, as reported by the device.

battery_status Enum

Battery status of the affected device, calculated from the numeric battery_level value.

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.battery_status_changed

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.removed

A device was removed externally from the connected account.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.removed

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.deleted

A device was deleted.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.deleted

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.third_party_integration_detected

Seam detected that a device is using a third-party integration that will interfere with Seam device management.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.third_party_integration_detected

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.third_party_integration_no_longer_detected

Seam detected that a device is no longer using a third-party integration that was interfering with Seam device management.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.third_party_integration_no_longer_detected

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.salto.privacy_mode_activated

A Salto devicearrow-up-right activated privacy mode.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.salto.privacy_mode_activated

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.salto.privacy_mode_deactivated

A Salto devicearrow-up-right deactivated privacy mode.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.salto.privacy_mode_deactivated

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.connection_became_flaky

Seam detected a flaky device connection.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.connection_became_flaky

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.connection_stabilized

Seam detected that a previously-flaky device connection stabilized.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.connection_stabilized

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.error.subscription_required

A third-party subscription is required to use all device features.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.error.subscription_required

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.error.subscription_required.resolved

A third-party subscription is active or no longer required to use all device features.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.error.subscription_required.resolved

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.accessory_keypad_connected

An accessory keypad was connected to a device.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.accessory_keypad_connected

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.accessory_keypad_disconnected

An accessory keypad was disconnected from a device.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.accessory_keypad_disconnected

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

device.name_changed

The name of a device was changed.

chevron-rightPropertieshashtag

connected_account_custom_metadata Record

Custom metadata of the connected account, present when connected_account_id is provided.

connected_account_id UUID

ID of the connected account associated with the event.

created_at Datetime

Date and time at which the event was created.

device_custom_metadata Record

Custom metadata of the device, present when device_id is provided.

device_id UUID

ID of the affected device.

device_name String

The new name of the affected device.

event_id UUID

ID of the event.

event_type Enum

Value: device.name_changed

occurred_at Datetime

Date and time at which the event occurred.

workspace_id UUID

ID of the workspace associated with the event.

hashtag
Endpoints

/devices/get

Returns a specified device.

/devices/list

Returns a list of all devices.

/devices/list_device_providers

Returns a list of all device providers.

/devices/report_provider_metadata

Updates provider-specific metadata for devices.

/devices/update

Updates a specified device.

PreviousPush Customer DataNextGet a Device

Last updated

Was this helpful?