List Devices
Get all devices
Returns a list of all devices.
Returns a list of all 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.
ID of the Connect Webview for which you want to list devices.
Device type for which you want to list devices.
Device type for smartlocks.
Manufacturer for which you want to list devices.
Array of device IDs for which you want to list devices.
Numerical limit on the number of devices to return.
500
Timestamp by which to limit returned devices. Returns devices created before this timestamp.
Your own internal user ID for the user for which you want to list devices.
Identifies the specific page of results to return, obtained from the previous page's next_page_cursor
.
ID of the space for which you want to list devices.
String for which to search. Filters returned devices to include all records that satisfy a partial match using device_id
, display_name
, custom_metadata
or location.location_name
.
POST /devices/list HTTP/1.1
Host: connect.getseam.com
Authorization: Bearer Customer Client Session Token
Content-Type: application/json
Accept: */*
Content-Length: 684
{
"customer_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
"connected_account_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"connect_webview_id": "123e4567-e89b-12d3-a456-426614174000",
"device_type": "akuvox_lock",
"device_types": [
"akuvox_lock"
],
"manufacturer": "akuvox",
"device_ids": [
"123e4567-e89b-12d3-a456-426614174000"
],
"limit": 500,
"created_before": "2025-06-27T04:15:18.668Z",
"user_identifier_key": "text",
"custom_metadata_has": {
"ANY_ADDITIONAL_PROPERTY": "text"
},
"page_cursor": "text",
"include_if": [
"can_remotely_unlock"
],
"exclude_if": [
"can_remotely_unlock"
],
"space_id": "123e4567-e89b-12d3-a456-426614174000",
"search": "text"
}
{
"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"
],
"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",
"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",
"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-06-27T04:15:18.668Z"
}
],
"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-06-27T04:15:18.668Z"
},
"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-06-27T04:15:18.668Z",
"error_code": "account_disconnected",
"is_connected_account_error": true
}
],
"warnings": [
{
"message": "text",
"created_at": "2025-06-27T04:15:18.668Z",
"warning_code": "partial_backup_access_code_pool"
}
],
"created_at": "2025-06-27T04:15:18.668Z",
"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
}
],
"pagination": {
"next_page_cursor": "text",
"has_next_page": true,
"next_page_url": "https://example.com"
},
"ok": true
}
Request
List all devices or filter the list of devices by including the corresponding filter parameter in the request body.
Request Body Parameters
connected_account_id
String Optional
ID of the connected account.
connected_account_ids
String[] Optional
IDs of the connected accounts.
device_type
String Optional
Type of device.
device_types
String[] Optional
Types of devices.
manufacturer
String Optional
Device manufacturer.
device_ids
String[] Optional
IDs of the devices to include.
limit
Number Optional
Numerical limit on the number of devices to return.
created_before
String Optional
Date threshold for devices to return. If specified, returns only devices created before the specified date.
user_identifier_key
String Optional
Your own internal user ID for the user by which to filter devices.
custom_metadata_has
JSON object Optional
Set of key:value custom metadata pairs by which you want to filter devices.
Sample Request
seam.devices.list()
Response
Returns a 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
[
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
),
...
]
Last updated
Was this helpful?