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

post

Returns a list of all devices associated with a specified user identity.

Authorizations
Body
user_identity_idstring · uuidRequired

ID of the user identity for which you want to retrieve all accessible devices.

Responses
200
OK
application/json
post
POST /user_identities/list_accessible_devices HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer API Key
Content-Type: application/json
Accept: */*
Content-Length: 59

{
  "user_identity_id": "123e4567-e89b-12d3-a456-426614174000"
}
{
  "devices": [
    {
      "device_id": "123e4567-e89b-12d3-a456-426614174000",
      "device_type": "akuvox_lock",
      "nickname": "text",
      "display_name": "text",
      "capabilities_supported": [
        "access_code"
      ],
      "properties": {
        "online": true,
        "accessory_keypad": {
          "is_connected": true,
          "battery": {
            "level": 1
          }
        },
        "appearance": {
          "name": "text"
        },
        "model": {
          "can_connect_accessory_keypad": true,
          "display_name": "text",
          "manufacturer_display_name": "text",
          "has_built_in_keypad": true
        },
        "has_direct_power": true,
        "battery_level": 1,
        "battery": {
          "level": 1,
          "status": "critical"
        },
        "manufacturer": "text",
        "image_url": "https://example.com",
        "image_alt_text": "text",
        "serial_number": "text",
        "online_access_codes_enabled": true,
        "offline_access_codes_enabled": true,
        "noise_level_decibels": 1,
        "currently_triggering_noise_threshold_ids": [
          "text"
        ],
        "assa_abloy_credential_service_metadata": {
          "has_active_endpoint": true,
          "endpoints": [
            {
              "endpoint_id": "text",
              "is_active": true
            }
          ]
        },
        "salto_space_credential_service_metadata": {
          "has_active_phone": true
        },
        "august_metadata": {
          "lock_id": "text",
          "lock_name": "text",
          "house_name": "text",
          "has_keypad": true,
          "keypad_battery_level": "text",
          "model": "text",
          "house_id": "text"
        },
        "avigilon_alta_metadata": {
          "entry_name": "text",
          "org_name": "text",
          "zone_id": 1,
          "zone_name": "text",
          "site_id": 1,
          "site_name": "text",
          "entry_relays_total_count": 1
        },
        "schlage_metadata": {
          "device_id": "text",
          "device_name": "text",
          "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": true,
          "keypad_paired": true,
          "keypad_2_paired": true
        },
        "kwikset_metadata": {
          "device_id": "text",
          "device_name": "text",
          "model_number": "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": 1,
          "noise_level_decibel": 1,
          "device_name": "text",
          "device_id": "text"
        },
        "minut_metadata": {
          "device_id": "text",
          "device_name": "text",
          "latest_sensor_values": {
            "temperature": {
              "time": "text",
              "value": 1
            },
            "sound": {
              "time": "text",
              "value": 1
            },
            "humidity": {
              "time": "text",
              "value": 1
            },
            "pressure": {
              "time": "text",
              "value": 1
            },
            "accelerometer_z": {
              "time": "text",
              "value": 1
            }
          }
        },
        "four_suites_metadata": {
          "device_id": 1,
          "device_name": "text",
          "reclose_delay_in_seconds": 1
        },
        "two_n_metadata": {
          "device_id": 1,
          "device_name": "text"
        },
        "controlbyweb_metadata": {
          "device_id": "text",
          "device_name": "text",
          "relay_name": "text"
        },
        "ttlock_metadata": {
          "lock_id": 1,
          "lock_alias": "text",
          "feature_value": "text",
          "features": {
            "passcode": true,
            "passcode_management": true,
            "unlock_via_gateway": true,
            "lock_command": true,
            "incomplete_keyboard_passcode": true,
            "wifi": true
          },
          "has_gateway": true,
          "wireless_keypads": [
            {
              "wireless_keypad_id": 1,
              "wireless_keypad_name": "text"
            }
          ]
        },
        "seam_bridge_metadata": {
          "unlock_method": "bridge",
          "device_num": 1,
          "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": 1,
          "door_name": "text",
          "device_id": 1,
          "door_is_wireless": true,
          "site_name": "text",
          "iana_timezone": "text",
          "predefined_time_slots": [
            {
              "name": "text",
              "prefix": 1,
              "check_in_time": "text",
              "check_out_time": "text",
              "is_24_hour": true,
              "is_biweekly_mode": true,
              "is_one_shot": true,
              "is_master": true,
              "ext_dormakaba_oracode_user_level_prefix": 1,
              "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": 1
        },
        "tedee_metadata": {
          "device_id": 1,
          "serial_number": "text",
          "device_name": "text",
          "device_model": "text",
          "bridge_id": 1,
          "bridge_name": "text",
          "keypad_id": 1
        },
        "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"
        },
        "sensi_metadata": {
          "device_id": "text",
          "device_name": "text",
          "product_type": "text"
        },
        "_experimental_supported_code_from_access_codes_lengths": [
          1
        ],
        "code_constraints": [
          {
            "constraint_type": "no_zeros"
          }
        ],
        "supported_code_lengths": [
          1
        ],
        "max_active_codes_supported": 1,
        "supports_backup_access_code_pool": true,
        "has_native_entry_events": true,
        "locked": true,
        "keypad_battery": {
          "level": 1
        },
        "door_open": true,
        "temperature_fahrenheit": 1,
        "temperature_celsius": 1,
        "relative_humidity": 1,
        "available_hvac_mode_settings": [
          "off"
        ],
        "available_fan_mode_settings": [
          "auto"
        ],
        "available_climate_preset_modes": [
          "home"
        ],
        "is_heating": true,
        "is_cooling": true,
        "is_fan_running": true,
        "is_temporary_manual_override_active": true,
        "current_climate_setting": {
          "climate_preset_key": "text",
          "can_edit": true,
          "can_delete": true,
          "can_program": true,
          "name": "text",
          "display_name": "text",
          "climate_preset_mode": "home",
          "fan_mode_setting": "auto",
          "hvac_mode_setting": "off",
          "cooling_set_point_celsius": 1,
          "heating_set_point_celsius": 1,
          "cooling_set_point_fahrenheit": 1,
          "heating_set_point_fahrenheit": 1
        },
        "available_climate_presets": [
          {
            "climate_preset_key": "text",
            "can_edit": true,
            "can_delete": true,
            "can_program": true,
            "name": "text",
            "display_name": "text",
            "climate_preset_mode": "home",
            "fan_mode_setting": "auto",
            "hvac_mode_setting": "off",
            "cooling_set_point_celsius": 1,
            "heating_set_point_celsius": 1,
            "cooling_set_point_fahrenheit": 1,
            "heating_set_point_fahrenheit": 1
          }
        ],
        "fallback_climate_preset_key": "text",
        "active_thermostat_schedule_id": "123e4567-e89b-12d3-a456-426614174000",
        "thermostat_daily_programs": [
          {
            "thermostat_daily_program_id": "123e4567-e89b-12d3-a456-426614174000",
            "device_id": "123e4567-e89b-12d3-a456-426614174000",
            "name": "text",
            "periods": [
              {
                "starts_at_time": "text",
                "climate_preset_key": "text"
              }
            ],
            "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
            "created_at": "2025-07-01T04:35:54.685Z"
          }
        ],
        "thermostat_weekly_program": {
          "monday_program_id": "123e4567-e89b-12d3-a456-426614174000",
          "tuesday_program_id": "123e4567-e89b-12d3-a456-426614174000",
          "wednesday_program_id": "123e4567-e89b-12d3-a456-426614174000",
          "thursday_program_id": "123e4567-e89b-12d3-a456-426614174000",
          "friday_program_id": "123e4567-e89b-12d3-a456-426614174000",
          "saturday_program_id": "123e4567-e89b-12d3-a456-426614174000",
          "sunday_program_id": "123e4567-e89b-12d3-a456-426614174000",
          "created_at": "2025-07-01T04:35:54.685Z"
        },
        "min_cooling_set_point_celsius": 1,
        "min_cooling_set_point_fahrenheit": 1,
        "max_cooling_set_point_celsius": 1,
        "max_cooling_set_point_fahrenheit": 1,
        "min_heating_set_point_celsius": 1,
        "min_heating_set_point_fahrenheit": 1,
        "max_heating_set_point_celsius": 1,
        "max_heating_set_point_fahrenheit": 1,
        "min_heating_cooling_delta_celsius": 1,
        "min_heating_cooling_delta_fahrenheit": 1,
        "temperature_threshold": {
          "lower_limit_celsius": 1,
          "lower_limit_fahrenheit": 1,
          "upper_limit_celsius": 1,
          "upper_limit_fahrenheit": 1
        }
      },
      "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": false,
          "created_at": "2025-07-01T04:35:54.685Z",
          "error_code": "account_disconnected",
          "is_connected_account_error": true
        }
      ],
      "warnings": [
        {
          "message": "text",
          "created_at": "2025-07-01T04:35:54.685Z",
          "warning_code": "partial_backup_access_code_pool"
        }
      ],
      "created_at": "2025-07-01T04:35:54.685Z",
      "is_managed": true,
      "custom_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "can_remotely_unlock": true,
      "can_remotely_lock": true,
      "can_program_offline_access_codes": true,
      "can_program_online_access_codes": true,
      "can_hvac_heat": true,
      "can_hvac_cool": true,
      "can_hvac_heat_cool": true,
      "can_turn_off_hvac": true,
      "can_simulate_removal": true,
      "can_simulate_connection": true,
      "can_simulate_disconnection": true,
      "can_unlock_with_code": true
    }
  ],
  "ok": true
}

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

user_identity_id

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

Response

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

Was this helpful?

Revision created

Merge branch 'main' into beta