Get an Unmanaged Device

Get a specified unmanaged device

Returns a specified unmanaged device. An unmanaged device has a limited set of visible properties and a subset of supported events. You cannot control an unmanaged device. Any access codes on an unmanaged device are unmanaged. To control an unmanaged device with Seam, convert it to a managed device.

/devices/unmanaged/get

POSThttps://connect.getseam.com/devices/unmanaged/get
Authorization
Body
device_idstring (uuid)
namestring
Response

OK

Body
device*unmanaged_device (object)
ok*boolean
Request
const response = await fetch('https://connect.getseam.com/devices/unmanaged/get', {
    method: 'POST',
    headers: {
      "Authorization": "Bearer Client Session Token",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();
Response
{
  "device": {
    "device_id": "123e4567-e89b-12d3-a456-426614174000",
    "device_type": "akuvox_lock",
    "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
    "capabilities_supported": [
      "access_code"
    ],
    "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
    "errors": [
      {
        "error_code": "text",
        "message": "text"
      }
    ],
    "warnings": [
      {
        "warning_code": "text",
        "message": "text"
      }
    ],
    "created_at": "2024-06-12T21:35:01.639Z",
    "is_managed": false,
    "properties": {
      "accessory_keypad": {
        "is_connected": false,
        "battery": {
          "level": 0
        }
      },
      "name": "text",
      "online": false,
      "manufacturer": "text",
      "image_url": "https://example.com",
      "image_alt_text": "text",
      "battery_level": 0,
      "battery": {
        "level": 0,
        "status": "critical"
      },
      "online_access_codes_enabled": false,
      "offline_access_codes_enabled": false,
      "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,
        "accessory_keypad_supported": false
      }
    },
    "can_remotely_unlock": false,
    "can_remotely_lock": false,
    "can_program_offline_access_codes": false,
    "can_program_online_access_codes": false,
    "can_simulate_removal": false
  },
  "ok": false
}

Request

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

Request Body Parameters

ParameterTypeDescription

device_id

String Required

ID of the desired device.

Sample Request

pprint(seam.devices.unmanaged.get("882dd63f-db9b-4210-bac2-68372aa0aff7"))

Response

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

This response also includes a Boolean ok status indicator.

Sample Response

UnmanagedDevice(device_id='882dd63f-db9b-4210-bac2-68372aa0aff7',
                device_type='august_lock',
                properties={'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',
                            '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': 'GARAGE',
                            'online': True},
                connected_account_id='f72442d2-2c16-4e3f-9882-6bff21828b1b',
                workspace_id='398d80b7-3f96-47c2-b85a-6f8ba21d07be',
                created_at='2023-10-28T09:13:08.836Z',
                errors=[],
                warnings=[],
                capabilities_supported=['access_code', 'lock'],
                is_managed=False)

Last updated

Logo

Š Seam Labs, Inc. All rights reserved.