await seam.noiseSensors.list({ limit: 10 });
/*
[
{
"capabilities_supported": [
"noise_detection"
],
"connected_account_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
"created_at": "2025-05-16T16:54:17.946049Z",
"custom_metadata": {
"id": "internalId1"
},
"device_id": "f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f",
"device_type": "minut_sensor",
"display_name": "Living Room",
"errors": [],
"is_managed": true,
"location": {
"location_name": "Jane's Test Home",
"timezone": "America/Los_Angeles"
},
"nickname": "Living Room",
"properties": {
"appearance": {
"name": "Living Room"
},
"battery": {
"level": 1,
"status": "full"
},
"battery_level": 1,
"currently_triggering_noise_threshold_ids": [],
"image_alt_text": "Minut Sensor",
"image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128",
"manufacturer": "minut",
"minut_metadata": {
"device_id": "770cd3153deca3dee0fe0614",
"device_location": {
"latitude": 0,
"longitude": 0
},
"device_name": "Living Room",
"home_address": {
"city": "San Francisco",
"country": "US",
"notes": "string",
"post_code": "44210",
"region": "San Francisco County",
"street_name1": "2258 24th Street",
"street_name2": ""
},
"home_id": "2978b6d5dba395ec08300e46",
"home_location": {
"latitude": 0,
"longitude": 0
},
"home_name": "Jane's Test Home",
"latest_sensor_values": {
"accelerometer_z": {
"time": "2025-06-16T16:54:17.946049Z",
"value": -1.00390625
},
"humidity": {
"time": "2025-06-16T16:54:17.946049Z",
"value": 31.110000610351562
},
"pressure": {
"time": "2025-06-16T16:54:17.946049Z",
"value": 101923
},
"sound": {
"time": "2025-06-16T16:54:17.946049Z",
"value": 47.7117919921875
},
"temperature": {
"time": "2025-06-16T16:54:17.946049Z",
"value": 21.270000457763672
}
}
},
"model": {
"display_name": "Noise Sensor",
"manufacturer_display_name": "Minut"
},
"name": "Living Room",
"noise_level_decibels": 47.7117919921875,
"online": true
},
"warnings": [],
"workspace_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
}
]
*/{
"devices": [
{
"capabilities_supported": [],
"connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"custom_metadata": {},
"device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"errors": [
{
"error_code": "<string>",
"message": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"is_managed": true,
"properties": {
"appearance": {
"name": "<string>"
},
"model": {
"display_name": "<string>",
"manufacturer_display_name": "<string>",
"accessory_keypad_supported": true,
"can_connect_accessory_keypad": true,
"has_built_in_keypad": true,
"offline_access_codes_supported": true,
"online_access_codes_supported": true
},
"name": "<string>",
"online": true,
"accessory_keypad": {
"is_connected": true,
"battery": {
"level": 0.5
}
},
"battery": {
"level": 0.5
},
"battery_level": 0.5,
"currently_triggering_noise_threshold_ids": [
"<string>"
],
"has_direct_power": true,
"image_alt_text": "<string>",
"image_url": "<string>",
"manufacturer": "<string>",
"noise_level_decibels": 123,
"offline_access_codes_enabled": true,
"online_access_codes_enabled": true,
"serial_number": "<string>",
"supports_accessory_keypad": true,
"supports_offline_access_codes": true,
"assa_abloy_credential_service_metadata": {
"endpoints": [
{
"endpoint_id": "<string>",
"is_active": true
}
],
"has_active_endpoint": true
},
"salto_space_credential_service_metadata": {
"has_active_phone": true
},
"akiles_metadata": {
"_member_group_id": "<string>",
"gadget_id": "<string>",
"gadget_name": "<string>",
"product_name": "<string>"
},
"assa_abloy_vostio_metadata": {
"encoder_name": "<string>"
},
"august_metadata": {
"has_keypad": true,
"house_id": "<string>",
"house_name": "<string>",
"keypad_battery_level": "<string>",
"lock_id": "<string>",
"lock_name": "<string>",
"model": "<string>"
},
"avigilon_alta_metadata": {
"entry_name": "<string>",
"entry_relays_total_count": 123,
"org_name": "<string>",
"site_id": 123,
"site_name": "<string>",
"zone_id": 123,
"zone_name": "<string>"
},
"brivo_metadata": {
"activation_enabled": true,
"device_name": "<string>"
},
"controlbyweb_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"relay_name": "<string>"
},
"dormakaba_oracode_metadata": {
"device_id": 123,
"door_id": 123,
"door_is_wireless": true,
"door_name": "<string>",
"iana_timezone": "<string>",
"predefined_time_slots": [
{
"check_in_time": "<string>",
"check_out_time": "<string>",
"dormakaba_oracode_user_level_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dormakaba_oracode_user_level_prefix": 123,
"is_24_hour": true,
"is_biweekly_mode": true,
"is_master": true,
"is_one_shot": true,
"name": "<string>",
"prefix": 123
}
],
"site_id": 123,
"site_name": "<string>"
},
"ecobee_metadata": {
"device_name": "<string>",
"ecobee_device_id": "<string>"
},
"four_suites_metadata": {
"device_id": 123,
"device_name": "<string>",
"reclose_delay_in_seconds": 123
},
"genie_metadata": {
"device_name": "<string>",
"door_name": "<string>"
},
"honeywell_resideo_metadata": {
"device_name": "<string>",
"honeywell_resideo_device_id": "<string>"
},
"igloo_metadata": {
"bridge_id": "<string>",
"device_id": "<string>",
"model": "<string>"
},
"igloohome_metadata": {
"bridge_id": "<string>",
"bridge_name": "<string>",
"device_id": "<string>",
"device_name": "<string>",
"is_accessory_keypad_linked_to_bridge": true,
"keypad_id": "<string>"
},
"keynest_metadata": {
"address": "<string>",
"current_or_last_store_id": 123,
"current_status": "<string>",
"current_user_company": "<string>",
"current_user_email": "<string>",
"current_user_name": "<string>",
"current_user_phone_number": "<string>",
"default_office_id": 123,
"device_name": "<string>",
"fob_id": 123,
"handover_method": "<string>",
"has_photo": true,
"is_quadient_locker": true,
"key_id": "<string>",
"key_notes": "<string>",
"keynest_app_user": "<string>",
"last_movement": "<string>",
"property_id": "<string>",
"property_postcode": "<string>",
"status_type": "<string>",
"subscription_plan": "<string>"
},
"kisi_metadata": {
"description": "<string>",
"lock_id": 123,
"lock_name": "<string>",
"place_name": "<string>"
},
"korelock_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"firmware_version": "<string>",
"location_id": "<string>",
"model_code": "<string>",
"serial_number": "<string>",
"wifi_signal_strength": 123
},
"kwikset_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"model_number": "<string>"
},
"lockly_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"model": "<string>"
},
"minut_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"latest_sensor_values": {
"accelerometer_z": {
"time": "<string>",
"value": 123
},
"humidity": {
"time": "<string>",
"value": 123
},
"pressure": {
"time": "<string>",
"value": 123
},
"sound": {
"time": "<string>",
"value": 123
},
"temperature": {
"time": "<string>",
"value": 123
}
}
},
"nest_metadata": {
"device_custom_name": "<string>",
"device_name": "<string>",
"display_name": "<string>",
"nest_device_id": "<string>"
},
"noiseaware_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"noise_level_decibel": 123,
"noise_level_nrs": 123
},
"nuki_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"keypad_2_paired": true,
"keypad_battery_critical": true,
"keypad_paired": true
},
"omnitec_metadata": {
"has_gateway": true,
"lock_alias": "<string>",
"lock_id": 123,
"lock_mac": "<string>",
"lock_name": "<string>",
"time_zone": "<string>",
"timezone_raw_offset_ms": 123
},
"ring_metadata": {
"device_id": "<string>",
"device_name": "<string>"
},
"salto_ks_metadata": {
"battery_level": "<string>",
"customer_reference": "<string>",
"has_custom_pin_subscription": true,
"lock_id": "<string>",
"lock_type": "<string>",
"locked_state": "<string>",
"model": "<string>",
"site_id": "<string>",
"site_name": "<string>"
},
"salto_metadata": {
"battery_level": "<string>",
"customer_reference": "<string>",
"lock_id": "<string>",
"lock_type": "<string>",
"locked_state": "<string>",
"model": "<string>",
"site_id": "<string>",
"site_name": "<string>"
},
"schlage_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"model": "<string>"
},
"seam_bridge_metadata": {
"device_num": 123,
"name": "<string>"
},
"sensi_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"dual_setpoints_not_supported": true,
"enforced_setpoint_range_celsius": "<unknown>",
"product_type": "<string>"
},
"smartthings_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"location_id": "<string>",
"model": "<string>"
},
"tado_metadata": {
"device_type": "<string>",
"serial_no": "<string>"
},
"tedee_metadata": {
"bridge_id": 123,
"bridge_name": "<string>",
"device_id": 123,
"device_model": "<string>",
"device_name": "<string>",
"keypad_id": 123,
"serial_number": "<string>"
},
"ttlock_metadata": {
"feature_value": "<string>",
"features": {
"auto_lock_time_config": true,
"incomplete_keyboard_passcode": true,
"lock_command": true,
"passcode": true,
"passcode_management": true,
"unlock_via_gateway": true,
"wifi": true
},
"has_gateway": true,
"lock_alias": "<string>",
"lock_id": 123,
"timezone_raw_offset_ms": 123,
"wireless_keypads": [
{
"wireless_keypad_id": 123,
"wireless_keypad_name": "<string>"
}
]
},
"two_n_metadata": {
"device_id": 123,
"device_name": "<string>"
},
"ultraloq_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"device_type": "<string>",
"time_zone": "<string>"
},
"visionline_metadata": {
"encoder_id": "<string>"
},
"wyze_metadata": {
"device_id": "<string>",
"device_info_model": "<string>",
"device_name": "<string>",
"keypad_uuid": "<string>",
"locker_status_hardlock": 123,
"product_model": "<string>",
"product_name": "<string>",
"product_type": "<string>"
},
"auto_lock_delay_seconds": 123,
"auto_lock_enabled": true,
"backup_access_code_pool_enabled": true,
"code_constraints": [
{}
],
"door_open": true,
"has_native_entry_events": true,
"keypad_battery": {
"level": 123
},
"locked": true,
"max_active_codes_supported": 123,
"offline_time_frame_options": [
{
"display_name": "<string>",
"end_date_recurrence_rule": "<string>",
"matching_start_end_time": true,
"max_duration": "<string>",
"min_duration": "<string>",
"start_date_recurrence_rule": "<string>",
"time_pairs": [
{
"display_name": "<string>",
"end_time": "<string>",
"start_time": "<string>"
}
],
"time_zone": "<string>"
}
],
"online_time_frame_options": [
{
"display_name": "<string>",
"end_date_recurrence_rule": "<string>",
"matching_start_end_time": true,
"max_duration": "<string>",
"min_duration": "<string>",
"start_date_recurrence_rule": "<string>",
"time_pairs": [
{
"display_name": "<string>",
"end_time": "<string>",
"start_time": "<string>"
}
],
"time_zone": "<string>"
}
],
"supported_code_lengths": [
123
],
"supports_backup_access_code_pool": true,
"active_thermostat_schedule": {
"climate_preset_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ends_at": "2023-11-07T05:31:56Z",
"errors": [
{
"error_code": "<string>",
"message": "<string>"
}
],
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"thermostat_schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_override_allowed": true,
"max_override_period_minutes": 1
},
"active_thermostat_schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"available_climate_preset_modes": [],
"available_climate_presets": [
{
"can_delete": true,
"can_edit": true,
"can_use_with_thermostat_daily_programs": true,
"climate_preset_key": "<string>",
"display_name": "<string>",
"manual_override_allowed": true,
"cooling_set_point_celsius": 123,
"cooling_set_point_fahrenheit": 123,
"ecobee_metadata": {
"climate_ref": "<string>",
"is_optimized": true
},
"heating_set_point_celsius": 123,
"heating_set_point_fahrenheit": 123,
"name": null
}
],
"available_fan_mode_settings": [],
"available_hvac_mode_settings": [],
"current_climate_setting": {
"can_delete": true,
"can_edit": true,
"can_use_with_thermostat_daily_programs": true,
"climate_preset_key": "<string>",
"cooling_set_point_celsius": 123,
"cooling_set_point_fahrenheit": 123,
"display_name": "<string>",
"ecobee_metadata": {
"climate_ref": "<string>",
"is_optimized": true
},
"heating_set_point_celsius": 123,
"heating_set_point_fahrenheit": 123,
"manual_override_allowed": true,
"name": null
},
"default_climate_setting": {
"can_delete": true,
"can_edit": true,
"can_use_with_thermostat_daily_programs": true,
"climate_preset_key": "<string>",
"cooling_set_point_celsius": 123,
"cooling_set_point_fahrenheit": 123,
"display_name": "<string>",
"ecobee_metadata": {
"climate_ref": "<string>",
"is_optimized": true
},
"heating_set_point_celsius": 123,
"heating_set_point_fahrenheit": 123,
"manual_override_allowed": true,
"name": null
},
"fallback_climate_preset_key": "<string>",
"is_cooling": true,
"is_fan_running": true,
"is_heating": true,
"is_temporary_manual_override_active": true,
"max_cooling_set_point_celsius": 123,
"max_cooling_set_point_fahrenheit": 123,
"max_heating_set_point_celsius": 123,
"max_heating_set_point_fahrenheit": 123,
"max_thermostat_daily_program_periods_per_day": 123,
"max_unique_climate_presets_per_thermostat_weekly_program": 123,
"min_cooling_set_point_celsius": 123,
"min_cooling_set_point_fahrenheit": 123,
"min_heating_cooling_delta_celsius": 123,
"min_heating_cooling_delta_fahrenheit": 123,
"min_heating_set_point_celsius": 123,
"min_heating_set_point_fahrenheit": 123,
"relative_humidity": 0.5,
"temperature_celsius": 123,
"temperature_fahrenheit": 123,
"temperature_threshold": {
"lower_limit_celsius": 123,
"lower_limit_fahrenheit": 123,
"upper_limit_celsius": 123,
"upper_limit_fahrenheit": 123
},
"thermostat_daily_program_period_precision_minutes": 123,
"thermostat_daily_programs": [
{
"created_at": "2023-11-07T05:31:56Z",
"device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"periods": [
{
"climate_preset_key": "<string>",
"starts_at_time": "<string>"
}
],
"thermostat_daily_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"thermostat_weekly_program": {
"created_at": "2023-11-07T05:31:56Z",
"friday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"monday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"saturday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sunday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thursday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tuesday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"wednesday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"space_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"warnings": [
{
"error_code": "<string>",
"message": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"can_configure_auto_lock": true,
"can_hvac_cool": true,
"can_hvac_heat": true,
"can_hvac_heat_cool": true,
"can_program_offline_access_codes": true,
"can_program_online_access_codes": true,
"can_program_thermostat_programs_as_different_each_day": true,
"can_program_thermostat_programs_as_same_each_day": true,
"can_program_thermostat_programs_as_weekday_weekend": true,
"can_remotely_lock": true,
"can_remotely_unlock": true,
"can_run_thermostat_programs": true,
"can_simulate_connection": true,
"can_simulate_disconnection": true,
"can_simulate_hub_connection": true,
"can_simulate_hub_disconnection": true,
"can_simulate_paid_subscription": true,
"can_simulate_removal": true,
"can_turn_off_hvac": true,
"can_unlock_with_code": true,
"device_manufacturer": {
"display_name": "<string>",
"manufacturer": "<string>",
"image_url": "<string>"
},
"device_provider": {
"device_provider_name": "<string>",
"display_name": "<string>",
"provider_category": "<string>",
"image_url": "<string>"
},
"location": {
"location_name": "<string>",
"time_zone": "<string>",
"timezone": "<string>"
},
"nickname": "<string>"
}
]
}Noise Sensors
List Noise Sensors
Returns a list of all noise sensors.
POST
/
noise_sensors
/
list
await seam.noiseSensors.list({ limit: 10 });
/*
[
{
"capabilities_supported": [
"noise_detection"
],
"connected_account_id": "9a8b7c6d-5e4f-3a2b-1c0d-9e8f7a6b5c4d",
"created_at": "2025-05-16T16:54:17.946049Z",
"custom_metadata": {
"id": "internalId1"
},
"device_id": "f1e2d3c4-b5a6-4d7c-8e9f-0a1b2c3d4e5f",
"device_type": "minut_sensor",
"display_name": "Living Room",
"errors": [],
"is_managed": true,
"location": {
"location_name": "Jane's Test Home",
"timezone": "America/Los_Angeles"
},
"nickname": "Living Room",
"properties": {
"appearance": {
"name": "Living Room"
},
"battery": {
"level": 1,
"status": "full"
},
"battery_level": 1,
"currently_triggering_noise_threshold_ids": [],
"image_alt_text": "Minut Sensor",
"image_url": "https://connect.getseam.com/_next/image?url=https://connect.getseam.com/assets/images/devices/minut_gen-3_front.png&q=75&w=128",
"manufacturer": "minut",
"minut_metadata": {
"device_id": "770cd3153deca3dee0fe0614",
"device_location": {
"latitude": 0,
"longitude": 0
},
"device_name": "Living Room",
"home_address": {
"city": "San Francisco",
"country": "US",
"notes": "string",
"post_code": "44210",
"region": "San Francisco County",
"street_name1": "2258 24th Street",
"street_name2": ""
},
"home_id": "2978b6d5dba395ec08300e46",
"home_location": {
"latitude": 0,
"longitude": 0
},
"home_name": "Jane's Test Home",
"latest_sensor_values": {
"accelerometer_z": {
"time": "2025-06-16T16:54:17.946049Z",
"value": -1.00390625
},
"humidity": {
"time": "2025-06-16T16:54:17.946049Z",
"value": 31.110000610351562
},
"pressure": {
"time": "2025-06-16T16:54:17.946049Z",
"value": 101923
},
"sound": {
"time": "2025-06-16T16:54:17.946049Z",
"value": 47.7117919921875
},
"temperature": {
"time": "2025-06-16T16:54:17.946049Z",
"value": 21.270000457763672
}
}
},
"model": {
"display_name": "Noise Sensor",
"manufacturer_display_name": "Minut"
},
"name": "Living Room",
"noise_level_decibels": 47.7117919921875,
"online": true
},
"warnings": [],
"workspace_id": "1a2b3c4d-5e6f-7a8b-9c0d-1e2f3a4b5c6d"
}
]
*/{
"devices": [
{
"capabilities_supported": [],
"connected_account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"custom_metadata": {},
"device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"display_name": "<string>",
"errors": [
{
"error_code": "<string>",
"message": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"is_managed": true,
"properties": {
"appearance": {
"name": "<string>"
},
"model": {
"display_name": "<string>",
"manufacturer_display_name": "<string>",
"accessory_keypad_supported": true,
"can_connect_accessory_keypad": true,
"has_built_in_keypad": true,
"offline_access_codes_supported": true,
"online_access_codes_supported": true
},
"name": "<string>",
"online": true,
"accessory_keypad": {
"is_connected": true,
"battery": {
"level": 0.5
}
},
"battery": {
"level": 0.5
},
"battery_level": 0.5,
"currently_triggering_noise_threshold_ids": [
"<string>"
],
"has_direct_power": true,
"image_alt_text": "<string>",
"image_url": "<string>",
"manufacturer": "<string>",
"noise_level_decibels": 123,
"offline_access_codes_enabled": true,
"online_access_codes_enabled": true,
"serial_number": "<string>",
"supports_accessory_keypad": true,
"supports_offline_access_codes": true,
"assa_abloy_credential_service_metadata": {
"endpoints": [
{
"endpoint_id": "<string>",
"is_active": true
}
],
"has_active_endpoint": true
},
"salto_space_credential_service_metadata": {
"has_active_phone": true
},
"akiles_metadata": {
"_member_group_id": "<string>",
"gadget_id": "<string>",
"gadget_name": "<string>",
"product_name": "<string>"
},
"assa_abloy_vostio_metadata": {
"encoder_name": "<string>"
},
"august_metadata": {
"has_keypad": true,
"house_id": "<string>",
"house_name": "<string>",
"keypad_battery_level": "<string>",
"lock_id": "<string>",
"lock_name": "<string>",
"model": "<string>"
},
"avigilon_alta_metadata": {
"entry_name": "<string>",
"entry_relays_total_count": 123,
"org_name": "<string>",
"site_id": 123,
"site_name": "<string>",
"zone_id": 123,
"zone_name": "<string>"
},
"brivo_metadata": {
"activation_enabled": true,
"device_name": "<string>"
},
"controlbyweb_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"relay_name": "<string>"
},
"dormakaba_oracode_metadata": {
"device_id": 123,
"door_id": 123,
"door_is_wireless": true,
"door_name": "<string>",
"iana_timezone": "<string>",
"predefined_time_slots": [
{
"check_in_time": "<string>",
"check_out_time": "<string>",
"dormakaba_oracode_user_level_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"dormakaba_oracode_user_level_prefix": 123,
"is_24_hour": true,
"is_biweekly_mode": true,
"is_master": true,
"is_one_shot": true,
"name": "<string>",
"prefix": 123
}
],
"site_id": 123,
"site_name": "<string>"
},
"ecobee_metadata": {
"device_name": "<string>",
"ecobee_device_id": "<string>"
},
"four_suites_metadata": {
"device_id": 123,
"device_name": "<string>",
"reclose_delay_in_seconds": 123
},
"genie_metadata": {
"device_name": "<string>",
"door_name": "<string>"
},
"honeywell_resideo_metadata": {
"device_name": "<string>",
"honeywell_resideo_device_id": "<string>"
},
"igloo_metadata": {
"bridge_id": "<string>",
"device_id": "<string>",
"model": "<string>"
},
"igloohome_metadata": {
"bridge_id": "<string>",
"bridge_name": "<string>",
"device_id": "<string>",
"device_name": "<string>",
"is_accessory_keypad_linked_to_bridge": true,
"keypad_id": "<string>"
},
"keynest_metadata": {
"address": "<string>",
"current_or_last_store_id": 123,
"current_status": "<string>",
"current_user_company": "<string>",
"current_user_email": "<string>",
"current_user_name": "<string>",
"current_user_phone_number": "<string>",
"default_office_id": 123,
"device_name": "<string>",
"fob_id": 123,
"handover_method": "<string>",
"has_photo": true,
"is_quadient_locker": true,
"key_id": "<string>",
"key_notes": "<string>",
"keynest_app_user": "<string>",
"last_movement": "<string>",
"property_id": "<string>",
"property_postcode": "<string>",
"status_type": "<string>",
"subscription_plan": "<string>"
},
"kisi_metadata": {
"description": "<string>",
"lock_id": 123,
"lock_name": "<string>",
"place_name": "<string>"
},
"korelock_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"firmware_version": "<string>",
"location_id": "<string>",
"model_code": "<string>",
"serial_number": "<string>",
"wifi_signal_strength": 123
},
"kwikset_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"model_number": "<string>"
},
"lockly_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"model": "<string>"
},
"minut_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"latest_sensor_values": {
"accelerometer_z": {
"time": "<string>",
"value": 123
},
"humidity": {
"time": "<string>",
"value": 123
},
"pressure": {
"time": "<string>",
"value": 123
},
"sound": {
"time": "<string>",
"value": 123
},
"temperature": {
"time": "<string>",
"value": 123
}
}
},
"nest_metadata": {
"device_custom_name": "<string>",
"device_name": "<string>",
"display_name": "<string>",
"nest_device_id": "<string>"
},
"noiseaware_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"noise_level_decibel": 123,
"noise_level_nrs": 123
},
"nuki_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"keypad_2_paired": true,
"keypad_battery_critical": true,
"keypad_paired": true
},
"omnitec_metadata": {
"has_gateway": true,
"lock_alias": "<string>",
"lock_id": 123,
"lock_mac": "<string>",
"lock_name": "<string>",
"time_zone": "<string>",
"timezone_raw_offset_ms": 123
},
"ring_metadata": {
"device_id": "<string>",
"device_name": "<string>"
},
"salto_ks_metadata": {
"battery_level": "<string>",
"customer_reference": "<string>",
"has_custom_pin_subscription": true,
"lock_id": "<string>",
"lock_type": "<string>",
"locked_state": "<string>",
"model": "<string>",
"site_id": "<string>",
"site_name": "<string>"
},
"salto_metadata": {
"battery_level": "<string>",
"customer_reference": "<string>",
"lock_id": "<string>",
"lock_type": "<string>",
"locked_state": "<string>",
"model": "<string>",
"site_id": "<string>",
"site_name": "<string>"
},
"schlage_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"model": "<string>"
},
"seam_bridge_metadata": {
"device_num": 123,
"name": "<string>"
},
"sensi_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"dual_setpoints_not_supported": true,
"enforced_setpoint_range_celsius": "<unknown>",
"product_type": "<string>"
},
"smartthings_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"location_id": "<string>",
"model": "<string>"
},
"tado_metadata": {
"device_type": "<string>",
"serial_no": "<string>"
},
"tedee_metadata": {
"bridge_id": 123,
"bridge_name": "<string>",
"device_id": 123,
"device_model": "<string>",
"device_name": "<string>",
"keypad_id": 123,
"serial_number": "<string>"
},
"ttlock_metadata": {
"feature_value": "<string>",
"features": {
"auto_lock_time_config": true,
"incomplete_keyboard_passcode": true,
"lock_command": true,
"passcode": true,
"passcode_management": true,
"unlock_via_gateway": true,
"wifi": true
},
"has_gateway": true,
"lock_alias": "<string>",
"lock_id": 123,
"timezone_raw_offset_ms": 123,
"wireless_keypads": [
{
"wireless_keypad_id": 123,
"wireless_keypad_name": "<string>"
}
]
},
"two_n_metadata": {
"device_id": 123,
"device_name": "<string>"
},
"ultraloq_metadata": {
"device_id": "<string>",
"device_name": "<string>",
"device_type": "<string>",
"time_zone": "<string>"
},
"visionline_metadata": {
"encoder_id": "<string>"
},
"wyze_metadata": {
"device_id": "<string>",
"device_info_model": "<string>",
"device_name": "<string>",
"keypad_uuid": "<string>",
"locker_status_hardlock": 123,
"product_model": "<string>",
"product_name": "<string>",
"product_type": "<string>"
},
"auto_lock_delay_seconds": 123,
"auto_lock_enabled": true,
"backup_access_code_pool_enabled": true,
"code_constraints": [
{}
],
"door_open": true,
"has_native_entry_events": true,
"keypad_battery": {
"level": 123
},
"locked": true,
"max_active_codes_supported": 123,
"offline_time_frame_options": [
{
"display_name": "<string>",
"end_date_recurrence_rule": "<string>",
"matching_start_end_time": true,
"max_duration": "<string>",
"min_duration": "<string>",
"start_date_recurrence_rule": "<string>",
"time_pairs": [
{
"display_name": "<string>",
"end_time": "<string>",
"start_time": "<string>"
}
],
"time_zone": "<string>"
}
],
"online_time_frame_options": [
{
"display_name": "<string>",
"end_date_recurrence_rule": "<string>",
"matching_start_end_time": true,
"max_duration": "<string>",
"min_duration": "<string>",
"start_date_recurrence_rule": "<string>",
"time_pairs": [
{
"display_name": "<string>",
"end_time": "<string>",
"start_time": "<string>"
}
],
"time_zone": "<string>"
}
],
"supported_code_lengths": [
123
],
"supports_backup_access_code_pool": true,
"active_thermostat_schedule": {
"climate_preset_key": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"ends_at": "2023-11-07T05:31:56Z",
"errors": [
{
"error_code": "<string>",
"message": "<string>"
}
],
"name": "<string>",
"starts_at": "2023-11-07T05:31:56Z",
"thermostat_schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"is_override_allowed": true,
"max_override_period_minutes": 1
},
"active_thermostat_schedule_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"available_climate_preset_modes": [],
"available_climate_presets": [
{
"can_delete": true,
"can_edit": true,
"can_use_with_thermostat_daily_programs": true,
"climate_preset_key": "<string>",
"display_name": "<string>",
"manual_override_allowed": true,
"cooling_set_point_celsius": 123,
"cooling_set_point_fahrenheit": 123,
"ecobee_metadata": {
"climate_ref": "<string>",
"is_optimized": true
},
"heating_set_point_celsius": 123,
"heating_set_point_fahrenheit": 123,
"name": null
}
],
"available_fan_mode_settings": [],
"available_hvac_mode_settings": [],
"current_climate_setting": {
"can_delete": true,
"can_edit": true,
"can_use_with_thermostat_daily_programs": true,
"climate_preset_key": "<string>",
"cooling_set_point_celsius": 123,
"cooling_set_point_fahrenheit": 123,
"display_name": "<string>",
"ecobee_metadata": {
"climate_ref": "<string>",
"is_optimized": true
},
"heating_set_point_celsius": 123,
"heating_set_point_fahrenheit": 123,
"manual_override_allowed": true,
"name": null
},
"default_climate_setting": {
"can_delete": true,
"can_edit": true,
"can_use_with_thermostat_daily_programs": true,
"climate_preset_key": "<string>",
"cooling_set_point_celsius": 123,
"cooling_set_point_fahrenheit": 123,
"display_name": "<string>",
"ecobee_metadata": {
"climate_ref": "<string>",
"is_optimized": true
},
"heating_set_point_celsius": 123,
"heating_set_point_fahrenheit": 123,
"manual_override_allowed": true,
"name": null
},
"fallback_climate_preset_key": "<string>",
"is_cooling": true,
"is_fan_running": true,
"is_heating": true,
"is_temporary_manual_override_active": true,
"max_cooling_set_point_celsius": 123,
"max_cooling_set_point_fahrenheit": 123,
"max_heating_set_point_celsius": 123,
"max_heating_set_point_fahrenheit": 123,
"max_thermostat_daily_program_periods_per_day": 123,
"max_unique_climate_presets_per_thermostat_weekly_program": 123,
"min_cooling_set_point_celsius": 123,
"min_cooling_set_point_fahrenheit": 123,
"min_heating_cooling_delta_celsius": 123,
"min_heating_cooling_delta_fahrenheit": 123,
"min_heating_set_point_celsius": 123,
"min_heating_set_point_fahrenheit": 123,
"relative_humidity": 0.5,
"temperature_celsius": 123,
"temperature_fahrenheit": 123,
"temperature_threshold": {
"lower_limit_celsius": 123,
"lower_limit_fahrenheit": 123,
"upper_limit_celsius": 123,
"upper_limit_fahrenheit": 123
},
"thermostat_daily_program_period_precision_minutes": 123,
"thermostat_daily_programs": [
{
"created_at": "2023-11-07T05:31:56Z",
"device_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"periods": [
{
"climate_preset_key": "<string>",
"starts_at_time": "<string>"
}
],
"thermostat_daily_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
],
"thermostat_weekly_program": {
"created_at": "2023-11-07T05:31:56Z",
"friday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"monday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"saturday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"sunday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"thursday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tuesday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"wednesday_program_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
},
"space_ids": [
"3c90c3cc-0d44-4b50-8888-8dd25736052a"
],
"warnings": [
{
"error_code": "<string>",
"message": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}
],
"workspace_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"can_configure_auto_lock": true,
"can_hvac_cool": true,
"can_hvac_heat": true,
"can_hvac_heat_cool": true,
"can_program_offline_access_codes": true,
"can_program_online_access_codes": true,
"can_program_thermostat_programs_as_different_each_day": true,
"can_program_thermostat_programs_as_same_each_day": true,
"can_program_thermostat_programs_as_weekday_weekend": true,
"can_remotely_lock": true,
"can_remotely_unlock": true,
"can_run_thermostat_programs": true,
"can_simulate_connection": true,
"can_simulate_disconnection": true,
"can_simulate_hub_connection": true,
"can_simulate_hub_disconnection": true,
"can_simulate_paid_subscription": true,
"can_simulate_removal": true,
"can_turn_off_hvac": true,
"can_unlock_with_code": true,
"device_manufacturer": {
"display_name": "<string>",
"manufacturer": "<string>",
"image_url": "<string>"
},
"device_provider": {
"device_provider_name": "<string>",
"display_name": "<string>",
"provider_category": "<string>",
"image_url": "<string>"
},
"location": {
"location_name": "<string>",
"time_zone": "<string>",
"timezone": "<string>"
},
"nickname": "<string>"
}
]
}Authorizations
client_sessionpat_with_workspaceconsole_session_with_workspaceapi_key
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
ID of the Connect Webview for which you want to list devices.
ID of the connected account for which you want to list devices.
Array of IDs of the connected accounts for which you want to list devices.
Timestamp by which to limit returned devices. Returns devices created before this timestamp.
Set of key:value custom metadata pairs for which you want to list devices.
Show child attributes
Show child attributes
Customer key for which you want to list devices.
Array of device IDs for which you want to list devices.
Device type of the noise sensors that you want to list.
Available options:
noiseaware_activity_zone, minut_sensor Device types of the noise sensors that you want to list.
Device type for noise sensors.
Available options:
noiseaware_activity_zone, minut_sensor Numerical limit on the number of devices to return.
Manufacturers of the noise sensors that you want to list.
Available options:
minut, noiseaware Identifies the specific page of results to return, obtained from the previous page's next_page_cursor.
String for which to search. Filters returned devices to include all records that satisfy a partial match using device_id (full or partial UUID prefix, minimum 4 characters), connected_account_id, display_name, custom_metadata or location.location_name.
Minimum string length:
1ID of the space for which you want to list devices.
Deprecated. Use space_id.
Your own internal user ID for the user for which you want to list devices.
Response
OK
Show child attributes
Show child attributes
Was this page helpful?
⌘I