Get a Device

Get a specified device

Returns a specified device.

/devices/get

POSThttps://connect.getseam.com/devices/get

Authorization

client_sessionpat_with_workspaceconsole_session_with_workspaceapi_key

Body

application/json

device_idstring (uuid)

namestring

Response

200400401

OK

Body

application/json

device*device (object)

ok*boolean

Request

JavaScriptCurlPython

const response = await fetch('https://connect.getseam.com/devices/get', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "device": {
    "device_id": "123e4567-e89b-12d3-a456-426614174000",
    "device_type": "akuvox_lock",
    "nickname": "text",
    "display_name": "text",
    "capabilities_supported": [
      "access_code"
    ],
    "properties": {
      "online": false,
      "accessory_keypad": {
        "is_connected": false,
        "battery": {
          "level": 0
        }
      },
      "appearance": {
        "name": "text"
      },
      "model": {
        "can_connect_accessory_keypad": false,
        "display_name": "text",
        "manufacturer_display_name": "text",
        "has_built_in_keypad": false,
        "offline_access_codes_supported": false,
        "online_access_codes_supported": false
      },
      "has_direct_power": false,
      "battery_level": 0,
      "battery": {
        "level": 0,
        "status": "critical"
      },
      "manufacturer": "text",
      "image_url": "https://example.com",
      "image_alt_text": "text",
      "serial_number": "text",
      "online_access_codes_enabled": false,
      "offline_access_codes_enabled": false,
      "noise_level_decibels": 0,
      "currently_triggering_noise_threshold_ids": [
        "text"
      ],
      "assa_abloy_credential_service_metadata": {
        "has_active_endpoint": false,
        "endpoints": [
          {
            "endpoint_id": "text",
            "is_active": false
          }
        ]
      },
      "august_metadata": {
        "lock_id": "text",
        "lock_name": "text",
        "house_name": "text",
        "has_keypad": false,
        "keypad_battery_level": "text",
        "model": "text",
        "house_id": "text"
      },
      "avigilon_alta_metadata": {
        "entry_name": "text",
        "org_name": "text",
        "zone_id": 0,
        "zone_name": "text",
        "site_id": 0,
        "site_name": "text",
        "entry_relays_total_count": 0
      },
      "schlage_metadata": {
        "device_id": "text",
        "device_name": "text",
        "access_code_length": 0,
        "model": "text"
      },
      "smartthings_metadata": {
        "device_id": "text",
        "device_name": "text",
        "model": "text",
        "location_id": "text"
      },
      "lockly_metadata": {
        "device_id": "text",
        "device_name": "text",
        "model": "text"
      },
      "nuki_metadata": {
        "device_id": "text",
        "device_name": "text",
        "keypad_battery_critical": false,
        "keypad_paired": false,
        "keypad_2_paired": false
      },
      "kwikset_metadata": {
        "device_id": "text",
        "device_name": "text",
        "model_number": "text"
      },
      "salto_metadata": {
        "lock_id": "text",
        "customer_reference": "text",
        "lock_type": "text",
        "battery_level": "text",
        "locked_state": "text",
        "model": "text"
      },
      "salto_ks_metadata": {
        "lock_id": "text",
        "customer_reference": "text",
        "lock_type": "text",
        "battery_level": "text",
        "locked_state": "text",
        "model": "text"
      },
      "genie_metadata": {
        "device_name": "text",
        "door_name": "text"
      },
      "brivo_metadata": {
        "device_name": "text"
      },
      "igloo_metadata": {
        "device_id": "text",
        "bridge_id": "text",
        "model": "text"
      },
      "noiseaware_metadata": {
        "device_model": "indoor",
        "noise_level_nrs": 0,
        "noise_level_decibel": 0,
        "device_name": "text",
        "device_id": "text"
      },
      "minut_metadata": {
        "device_id": "text",
        "device_name": "text",
        "latest_sensor_values": {
          "temperature": {
            "time": "text",
            "value": 0
          },
          "sound": {
            "time": "text",
            "value": 0
          },
          "humidity": {
            "time": "text",
            "value": 0
          },
          "pressure": {
            "time": "text",
            "value": 0
          },
          "accelerometer_z": {
            "time": "text",
            "value": 0
          }
        }
      },
      "four_suites_metadata": {
        "device_id": 0,
        "device_name": "text",
        "reclose_delay_in_seconds": 0
      },
      "two_n_metadata": {
        "device_id": 0,
        "device_name": "text"
      },
      "controlbyweb_metadata": {
        "device_id": "text",
        "device_name": "text",
        "relay_name": "text"
      },
      "ttlock_metadata": {
        "lock_id": 0,
        "lock_alias": "text",
        "feature_value": "text",
        "features": {
          "passcode": false,
          "passcode_management": false,
          "unlock_via_gateway": false,
          "lock_command": false,
          "incomplete_keyboard_passcode": false
        },
        "has_gateway": false,
        "wireless_keypads": [
          {
            "wireless_keypad_id": 0,
            "wireless_keypad_name": "text"
          }
        ]
      },
      "seam_bridge_metadata": {
        "unlock_method": "bridge",
        "device_num": 0,
        "name": "text"
      },
      "igloohome_metadata": {
        "device_id": "text",
        "device_name": "text",
        "bridge_id": "text",
        "bridge_name": "text",
        "keypad_id": "text"
      },
      "nest_metadata": {
        "nest_device_id": "text",
        "device_name": "text",
        "device_custom_name": "text",
        "display_name": "text"
      },
      "ecobee_metadata": {
        "ecobee_device_id": "text",
        "device_name": "text"
      },
      "honeywell_resideo_metadata": {
        "honeywell_resideo_device_id": "text",
        "device_name": "text"
      },
      "hubitat_metadata": {
        "device_id": "text",
        "device_name": "text",
        "device_label": "text"
      },
      "dormakaba_oracode_metadata": {
        "door_id": 0,
        "door_name": "text",
        "device_id": 0,
        "door_is_wireless": false,
        "site_id": 0,
        "site_name": "text",
        "iana_timezone": "text",
        "predefined_time_slots": [
          {
            "name": "text",
            "prefix": 0,
            "check_in_time": "text",
            "check_out_time": "text",
            "is_24_hour": false,
            "is_biweekly_mode": false,
            "is_one_shot": false,
            "is_master": false,
            "ext_dormakaba_oracode_user_level_prefix": 0,
            "dormakaba_oracode_user_level_id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ]
      },
      "wyze_metadata": {
        "device_id": "text",
        "device_name": "text",
        "product_name": "text",
        "product_type": "text",
        "product_model": "text",
        "device_info_model": "text",
        "keypad_uuid": "text",
        "locker_status_hardlock": 0
      },
      "tedee_metadata": {
        "device_id": 0,
        "serial_number": "text",
        "device_name": "text",
        "device_model": "text",
        "bridge_id": 0,
        "bridge_name": "text",
        "keypad_id": 0
      },
      "visionline_metadata": {
        "encoder_id": "text"
      },
      "akiles_metadata": {
        "gadget_name": "text",
        "gadget_id": "text",
        "product_name": "text",
        "_member_group_id": "text"
      },
      "assa_abloy_vostio_metadata": {
        "encoder_name": "text"
      },
      "tado_metadata": {
        "serial_no": "text",
        "device_type": "text"
      },
      "_experimental_supported_code_from_access_codes_lengths": [
        0
      ],
      "code_constraints": [
        {
          "constraint_type": "no_zeros"
        }
      ],
      "supported_code_lengths": [
        0
      ],
      "max_active_codes_supported": 0,
      "supports_backup_access_code_pool": false,
      "has_native_entry_events": false,
      "locked": false,
      "keypad_battery": {
        "level": 0
      },
      "door_open": false,
      "temperature_fahrenheit": 0,
      "temperature_celsius": 0,
      "relative_humidity": 0,
      "available_hvac_mode_settings": [
        "off"
      ],
      "available_fan_mode_settings": [
        "auto"
      ],
      "is_heating": false,
      "is_cooling": false,
      "is_fan_running": false,
      "is_temporary_manual_override_active": false,
      "current_climate_setting": {
        "climate_preset_key": "text",
        "can_edit": false,
        "can_delete": false,
        "name": "text",
        "display_name": "text",
        "fan_mode_setting": "auto",
        "hvac_mode_setting": "off",
        "cooling_set_point_celsius": 0,
        "heating_set_point_celsius": 0,
        "cooling_set_point_fahrenheit": 0,
        "heating_set_point_fahrenheit": 0
      },
      "available_climate_presets": [
        {
          "climate_preset_key": "text",
          "can_edit": false,
          "can_delete": false,
          "name": "text",
          "display_name": "text",
          "fan_mode_setting": "auto",
          "hvac_mode_setting": "off",
          "cooling_set_point_celsius": 0,
          "heating_set_point_celsius": 0,
          "cooling_set_point_fahrenheit": 0,
          "heating_set_point_fahrenheit": 0
        }
      ],
      "fallback_climate_preset_key": "text",
      "active_thermostat_schedule": {
        "thermostat_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
        "device_id": "123e4567-e89b-12d3-a456-426614174000",
        "name": "text",
        "climate_preset_key": "text",
        "max_override_period_minutes": 0,
        "starts_at": "2024-12-26T10:40:26.481Z",
        "unstable_is_override_allowed": false,
        "ends_at": "2024-12-26T10:40:26.481Z",
        "created_at": "2024-12-26T10:40:26.481Z"
      },
      "min_cooling_set_point_celsius": 0,
      "min_cooling_set_point_fahrenheit": 0,
      "max_cooling_set_point_celsius": 0,
      "max_cooling_set_point_fahrenheit": 0,
      "min_heating_set_point_celsius": 0,
      "min_heating_set_point_fahrenheit": 0,
      "max_heating_set_point_celsius": 0,
      "max_heating_set_point_fahrenheit": 0,
      "min_heating_cooling_delta_celsius": 0,
      "min_heating_cooling_delta_fahrenheit": 0,
      "temperature_threshold": {
        "lower_limit_celsius": 0,
        "lower_limit_fahrenheit": 0,
        "upper_limit_celsius": 0,
        "upper_limit_fahrenheit": 0
      }
    },
    "location": {
      "location_name": "text",
      "timezone": "text"
    },
    "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "errors": [
      {
        "message": "text",
        "is_device_error": true,
        "error_code": "text"
      }
    ],
    "warnings": [
      {
        "message": "text",
        "warning_code": "text"
      }
    ],
    "created_at": "2024-12-26T10:40:26.481Z",
    "is_managed": true,
    "can_remotely_unlock": false,
    "can_remotely_lock": false,
    "can_program_offline_access_codes": false,
    "can_program_online_access_codes": false,
    "can_hvac_heat": false,
    "can_hvac_cool": false,
    "can_hvac_heat_cool": false,
    "can_turn_off_hvac": false,
    "can_simulate_removal": false,
    "can_simulate_connection": false,
    "can_simulate_disconnection": false
  },
  "ok": false
}

Request

Specify the desired device by including the corresponding device_id in the request body.

Request Body Parameters

Parameter	Type	Description
device_id	String Required	ID of the desired device

Sample Request

Python

pprint(seam.devices.get("30fd243b-3054-4384-a713-5487076a3826"))

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/devices/get' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "device_id": "30fd243b-3054-4384-a713-5487076a3826"
}'

JavaScript

console.log(await seam.devices.get({device_id: "30fd243b-3054-4384-a713-5487076a3826"}))

Ruby

puts client.devices.get(device_id: "30fd243b-3054-4384-a713-5487076a3826").inspect

C#

Device device = seam.Devices.Get("30fd243b-3054-4384-a713-5487076a3826");
Console.WriteLine(device);

Java

Device device = seam.devices()
      .get(DevicesGetRequest.builder()
              .deviceId("30fd243b-3054-4384-a713-5487076a3826")
              .build());
System.out.println(device);

Response

Returns a device that contains the set of applicable device properties. For details, see Devices.

This response also includes a Boolean ok status indicator.

Sample Response

Python

Device(device_id='30fd243b-3054-4384-a713-5487076a3826',
       device_type='august_lock',
       location={'location_name': 'My House',
                 'timezone': 'America/Los_Angeles'},
       properties={'august_metadata': {'has_keypad': True,
                                       'house_id': 'house-1',
                                       'house_name': 'My House',
                                       'keypad_battery_level': 'Not Available',
                                       'lock_id': 'lock-2',
                                       'lock_name': 'BACK DOOR'},
                   'battery': {'level': 0.9999532347993827, 'status': 'full'},
                   'battery_level': 0.9999532347993827,
                   'code_constraints': [],
                   'door_open': False,
                   'has_native_entry_events': True,
                   'image_alt_text': 'August Wifi Smart Lock 3rd Gen, Silver, '
                                     'Front',
                   'image_url': 'https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png',
                   'locked': True,
                   'manufacturer': 'august',
                   'model': {'accessory_keypad_supported': True,
                             'display_name': 'Lock',
                             'manufacturer_display_name': 'August',
                             'offline_access_codes_supported': False,
                             'online_access_codes_supported': True},
                   'name': 'BACK DOOR',
                   'offline_access_codes_enabled': False,
                   'online': True,
                   'online_access_codes_enabled': True,
                   'serial_number': '00000004-992d-45a0-bea1-9128fdcd8d12',
                   'supported_code_lengths': [4, 5, 6, 7, 8],
                   'supports_accessory_keypad': True,
                   'supports_backup_access_code_pool': True,
                   'supports_offline_access_codes': False},
       capabilities_supported=['access_code', 'lock'],
       errors=[],
       warnings=[],
       custom_metadata={'internal_account_id': 'user-1'},
       connected_account_id='f72442d2-2c16-4e3f-9882-6bff21828b1b',
       workspace_id='398d80b7-3f96-47c2-b85a-6f8ba21d07be',
       created_at='2023-10-28T09:13:08.465Z',
       is_managed=True)

cURL (bash)

{
  "device": {
    "device_id": "30fd243b-3054-4384-a713-5487076a3826",
    "device_type": "august_lock",
    "capabilities_supported": [
      "access_code",
      "lock"
    ],
    "properties": {
      "locked": true,
      "online": true,
      "door_open": false,
      "manufacturer": "august",
      "battery_level": 0.9999532347993827,
      "serial_number": "00000004-992d-45a0-bea1-9128fdcd8d12",
      "august_metadata": {
        "lock_id": "lock-2",
        "house_id": "house-1",
        "lock_name": "BACK DOOR",
        "has_keypad": true,
        "house_name": "My House",
        "keypad_battery_level": "Not Available"
      },
      "supported_code_lengths": [
        4,
        5,
        6,
        7,
        8
      ],
      "has_native_entry_events": true,
      "supports_accessory_keypad": true,
      "online_access_codes_enabled": true,
      "offline_access_codes_enabled": false,
      "supports_offline_access_codes": false,
      "name": "BACK DOOR",
      "model": {
        "display_name": "Lock",
        "manufacturer_display_name": "August",
        "accessory_keypad_supported": true,
        "offline_access_codes_supported": false,
        "online_access_codes_supported": true
      },
      "battery": {
        "level": 0.9999532347993827,
        "status": "full"
      },
      "image_url": "https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png",
      "image_alt_text": "August Wifi Smart Lock 3rd Gen, Silver, Front",
      "code_constraints": [],
      "supports_backup_access_code_pool": true
    },
    "location": {
      "timezone": "America/Los_Angeles",
      "location_name": "My House"
    },
    "connected_account_id": "f72442d2-2c16-4e3f-9882-6bff21828b1b",
    "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
    "created_at": "2023-10-28T09:13:08.465Z",
    "errors": [],
    "warnings": [],
    "custom_metadata": {
        "internal_account_id": "user-1"
    },
    "is_managed": true
  },
  "ok": true
}

JavaScript

{
  device_id: '30fd243b-3054-4384-a713-5487076a3826',
  device_type: 'august_lock',
  capabilities_supported: [ 'access_code', 'lock' ],
  properties: {
    locked: true,
    online: true,
    door_open: false,
    manufacturer: 'august',
    battery_level: 0.9999532347993827,
    serial_number: '00000004-992d-45a0-bea1-9128fdcd8d12',
    august_metadata: {
      lock_id: 'lock-2',
      house_id: 'house-1',
      lock_name: 'BACK DOOR',
      has_keypad: true,
      house_name: 'My House',
      keypad_battery_level: 'Not Available'
    },
    supported_code_lengths: [ 4, 5, 6, 7, 8 ],
    has_native_entry_events: true,
    supports_accessory_keypad: true,
    online_access_codes_enabled: true,
    offline_access_codes_enabled: false,
    supports_offline_access_codes: false,
    name: 'BACK DOOR',
    model: {
      display_name: 'Lock',
      manufacturer_display_name: 'August',
      accessory_keypad_supported: true,
      offline_access_codes_supported: false,
      online_access_codes_supported: true
    },
    battery: { level: 0.9999532347993827, status: 'full' },
    image_url: 'https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png',
    image_alt_text: 'August Wifi Smart Lock 3rd Gen, Silver, Front',
    code_constraints: [],
    supports_backup_access_code_pool: true
  },
  location: { timezone: 'America/Los_Angeles', location_name: 'My House' },
  connected_account_id: 'f72442d2-2c16-4e3f-9882-6bff21828b1b',
  workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be',
  created_at: '2023-10-28T09:13:08.465Z',
  errors: [],
  warnings: [],
  custom_metadata: {'internal_account_id': 'user-1'},
  is_managed: true
}

Ruby

<Seam::Device:0x00438
  device_id="30fd243b-3054-4384-a713-5487076a3826"
  device_type="august_lock"
  capabilities_supported=["access_code", "lock"]
  properties={"locked"=>true, "online"=>true, "door_open"=>false, "manufacturer"=>"august", "battery_level"=>0.9999532347993827, "serial_number"=>"00000004-992d-45a0-bea1-9128fdcd8d12", "august_metadata"=>{"lock_id"=>"lock-2", "house_id"=>"house-1", "lock_name"=>"BACK DOOR", "has_keypad"=>true, "house_name"=>"My House", "keypad_battery_level"=>"Not Available"}, "supported_code_lengths"=>[4, 5, 6, 7, 8], "has_native_entry_events"=>true, "supports_accessory_keypad"=>true, "online_access_codes_enabled"=>true, "offline_access_codes_enabled"=>false, "supports_offline_access_codes"=>false, "name"=>"BACK DOOR", "model"=>{"display_name"=>"Lock", "manufacturer_display_name"=>"August", "accessory_keypad_supported"=>true, "offline_access_codes_supported"=>false, "online_access_codes_supported"=>true}, "battery"=>{"level"=>0.9999532347993827, "status"=>"full"}, "image_url"=>"https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png", "image_alt_text"=>"August Wifi Smart Lock 3rd Gen, Silver, Front", "code_constraints"=>[], "supports_backup_access_code_pool"=>true}
  connected_account_id="f72442d2-2c16-4e3f-9882-6bff21828b1b"
  workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be"
  created_at=2023-10-28 09:13:08.465 UTC
  errors=[]
  warnings=[]
  custom_metadata={"internal_account_id"=>"user-1"}
  is_managed=true>

C#

{
  "device_id": "30fd243b-3054-4384-a713-5487076a3826",
  "device_type": "august_lock",
  "capabilities_supported": [
    "access_code",
    "lock"
  ],
  "properties": {
    "online": true,
    "name": "BACK DOOR",
    "model": {
      "display_name": "Lock",
      "manufacturer_display_name": "August",
      "offline_access_codes_supported": false,
      "accessory_keypad_supported": true
    },
    "battery_level": 0.9999532,
    "battery": {
      "level": 0.9999532,
      "status": "full"
    },
    "manufacturer": "august",
    "image_url": "https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png",
    "image_alt_text": "August Wifi Smart Lock 3rd Gen, Silver, Front",
    "serial_number": "00000004-992d-45a0-bea1-9128fdcd8d12",
    "online_access_codes_enabled": true,
    "offline_access_codes_enabled": false,
    "supports_accessory_keypad": true,
    "supports_offline_access_codes": false,
    "august_metadata": {
      "lock_id": "lock-2",
      "lock_name": "BACK DOOR",
      "house_name": "My House",
      "has_keypad": true,
      "keypad_battery_level": "Not Available",
      "house_id": "house-1"
    },
    "code_constraints": [],
    "supported_code_lengths": [
      4.0,
      5.0,
      6.0,
      7.0,
      8.0
    ],
    "supports_backup_access_code_pool": true,
    "has_native_entry_events": true,
    "locked": true,
    "door_open": false
  },
  "location": {
    "location_name": "My House",
    "timezone": "America/Los_Angeles"
  },
  "connected_account_id": "f72442d2-2c16-4e3f-9882-6bff21828b1b",
  "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
  "errors": [],
  "warnings": [],
  "custom_metadata": {
    "internal_account_id": "user-1"
  },
  "created_at": "2023-10-28T09:13:08.465Z",
  "is_managed": true
}

Java

{
  "device_id" : "30fd243b-3054-4384-a713-5487076a3826",
  "device_type" : "august_lock",
  "capabilities_supported" : [ "access_code", "lock" ],
  "properties" : {
    "online" : true,
    "name" : "BACK DOOR",
    "model" : {
      "display_name" : "Lock",
      "online_access_codes_supported" : true,
      "accessory_keypad_supported" : true,
      "offline_access_codes_supported" : false,
      "manufacturer_display_name" : "August"
    },
    "august_metadata" : {
      "lock_id" : "lock-2",
      "lock_name" : "BACK DOOR",
      "house_name" : "My House",
      "house_id" : "house-1",
      "has_keypad" : true,
      "keypad_battery_level" : "Not Available"
    },
    "offline_access_codes_enabled" : false,
    "battery_level" : 0.9999532347993827,
    "image_url" : "https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png",
    "supports_accessory_keypad" : true,
    "serial_number" : "00000004-992d-45a0-bea1-9128fdcd8d12",
    "battery" : {
      "level" : 0.9999532347993827,
      "status" : "full"
    },
    "code_constraints" : [ ],
    "has_native_entry_events" : true,
    "image_alt_text" : "August Wifi Smart Lock 3rd Gen, Silver, Front",
    "manufacturer" : "august",
    "door_open" : false,
    "online_access_codes_enabled" : true,
    "supported_code_lengths" : [ 4, 5, 6, 7, 8 ],
    "locked" : true,
    "supports_offline_access_codes" : false,
    "supports_backup_access_code_pool" : true
  },
  "location" : {
    "timezone" : "America/Los_Angeles",
    "location_name" : "My House"
  },
  "connected_account_id" : "f72442d2-2c16-4e3f-9882-6bff21828b1b",
  "workspace_id" : "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
  "custom_metadata": {
    "internal_account_id": "user-1"
  },
  "created_at" : "2023-10-28T09:13:08.465Z",
  "is_managed" : true
}