List Accessible Devices for a User Identity
List accessible devices for a specified user identity
Returns a list of all device associated with a user identity.
/user_identities/list_accessible_devices
POSThttps://connect.getseam.com/user_identities/list_accessible_devices
Authorization
Body
user_identity_id*string (uuid)
Response
OK
Body
devices*array of device (object)
ok*boolean
Request
const response = await fetch('https://connect.getseam.com/user_identities/list_accessible_devices', {
method: 'POST',
headers: {
"Authorization": "Bearer API Key",
"Content-Type": "application/json"
},
body: JSON.stringify({
"user_identity_id": "123e4567-e89b-12d3-a456-426614174000"
}),
});
const data = await response.json();Response
{
"devices": [
{
"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"
},
"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"
},
"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",
"custom_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
},
"_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"
],
"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,
"manual_override_allowed": false
},
"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,
"manual_override_allowed": false
}
],
"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",
"starts_at": "2024-09-16T19:18:07.602Z",
"ends_at": "2024-09-16T19:18:07.602Z",
"created_at": "2024-09-16T19:18:07.602Z"
},
"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
},
"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-09-16T19:18:07.602Z",
"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 user identity for which you want to retrieve all associated devices by including the corresponding user_identity_id in the request body.
Request Body Parameters
| Parameter | Type | Description |
|---|---|---|
| String Required | ID of the user identity for which you want to retrieve all accessible devices |
Sample Request
curl -X 'POST' \
'https://connect.getseam.com/user_identities/list_accessible_devices' \
-H 'accept: application/json' \
-H 'Authorization: Bearer ${API_KEY}' \
-H 'Content-Type: application/json' \
-d '{
"user_identity_id": "f3a328b4-dd04-4370-9000-d52b7a01b0bf"
}'accessibleDevices, uErr := client.UserIdentities.ListAccessibleDevices(context.Background(), &api.UserIdentitiesListAccessibleDevicesRequest{
UserIdentityId: "f3a328b4-dd04-4370-9000-d52b7a01b0bf",
})
if uErr != nil {
return uErr
}
fmt.Println(accessibleDevices)
return nilResponse
Returns an accessible_devices array, in which each returned device (device) contains the set of applicable device properties. For details, see Devices.
This response also includes a Boolean ok status indicator.
Sample Response
{
"accessible_devices": [
{
"device_id": "054765c8-a2fc-4599-b486-14c19f462c45",
"nickname": "",
"display_name": "Seam Thermostat",
"device_type": "nest_thermostat",
"capabilities_supported": [
"thermostat"
],
"properties": {
"online": true,
"is_cooling": false,
"is_heating": false,
"manufacturer": "nest",
"nest_metadata": {
"custom_name": "",
"device_name": "enterprises/nest_project_id/devices/AVPHwEvjFcX-wRmGdXApyxON24SAI0S9oU13a2GSVFLPVehUKH1ATqlASyKi2N2dbJCVW-B6-VxgbhdjUyyjA-K3Vo5C9g",
"nest_device_id": "bcca8c5f-1854-4906-9911-c877d513e00a"
},
"is_fan_running": false,
"has_direct_power": true,
"relative_humidity": 0.46,
"temperature_celsius": 24.64,
"temperature_fahrenheit": 76.352,
"current_climate_setting": {
"hvac_mode_setting": "heat_cool",
"manual_override_allowed": true,
"cooling_set_point_celsius": 21.5,
"heating_set_point_celsius": 20,
"cooling_set_point_fahrenheit": 70.7,
"heating_set_point_fahrenheit": 68
},
"available_hvac_mode_settings": [
"heat",
"cool",
"heat_cool",
"off"
],
"is_temporary_manual_override_active": false,
"name": "",
"appearance": {
"name": ""
},
"model": {
"display_name": "Thermostat",
"manufacturer_display_name": "Nest",
"accessory_keypad_supported": false
},
"image_url": "https://connect.getseam.com/assets/images/devices/unknown-lock.png",
"image_alt_text": "Placeholder Lock Image",
"is_climate_setting_schedule_active": false
},
"location": null,
"connected_account_id": "44284499-a50b-4947-86c1-58264f014be5",
"workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
"created_at": "2024-02-29T21:57:33.397Z",
"errors": [],
"warnings": [],
"is_managed": true,
"custom_metadata": {}
}
],
"ok": true
}Last updated
