List Locks

Get all locks

Returns a list of all locks.

/locks/list

post

/locks/list

Authorizations

client_sessionpat_with_workspaceconsole_session_with_workspaceapi_key

Body

connected_account_idstring · uuid

ID of the connected account by which to filter.

connect_webview_idstring · uuid

ID of the Connect Webview by which to filter devices.

limitnumber · float · default: 500

Numerical limit on the number of devices to return.

created_beforestring · date-time

Date threshold for devices to return. If specified, returns only devices created before the specified date.

user_identifier_keystring

Your own internal user ID for the user by which to filter devices.

manufacturerstring · enum

Manufacturer by which to filter devices.

Options: akuvox, august, avigilon_alta, brivo, butterflymx, doorking, four_suites, genie, igloo, keywe, kwikset, linear, lockly, nuki, philia, salto, samsung, schlage, seam, unknown, wyze, yale, minut, two_n, ttlock, nest, igloohome, ecobee, hubitat, controlbyweb, smartthings, dormakaba_oracode, tedee, honeywell_resideo, akiles, tado

connected_account_idsstring · uuid[]

Array of IDs of the connected accounts by which to filter devices.

device_idsstring · uuid[]

Array of device IDs by which to filter devices.

include_ifstring · enum[]

exclude_ifstring · enum[]

device_typeone of

Device type by which to filter devices.

custom_metadata_hasobject

Set of key:value custom metadata pairs by which you want to filter devices.

device_typesone of[]

Array of device types by which to filter devices.

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://connect.getseam.com/locks/list' \
  --header 'Authorization: Bearer Client Session Token' \
  --header 'Content-Type: application/json' \
  --data '{"limit":500,"manufacturer":"akuvox","connected_account_ids":[null],"device_ids":[null],"include_if":["can_remotely_unlock"],"exclude_if":["can_remotely_unlock"],"device_type":"akuvox_lock","custom_metadata_has":{},"device_types":["akuvox_lock"]}'

200

400

401

200

{
  "ok": true,
  "locks": [
    {
      "device_id": "123e4567-e89b-12d3-a456-426614174000",
      "nickname": "text",
      "display_name": "text",
      "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-02-21T14:47:50.914Z",
      "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,
      "is_managed": true,
      "capabilities_supported": [
        "access_code"
      ],
      "device_type": "akuvox_lock",
      "location": {
        "location_name": "text",
        "timezone": "text"
      },
      "custom_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "errors": [
        {
          "message": "text",
          "is_device_error": true,
          "error_code": "device_offline"
        }
      ],
      "warnings": [
        {
          "message": "text",
          "warning_code": "partial_backup_access_code_pool"
        }
      ],
      "properties": {
        "online": true,
        "name": "text",
        "has_direct_power": true,
        "battery_level": 1,
        "manufacturer": "text",
        "image_url": "https://example.com",
        "image_alt_text": "text",
        "serial_number": "text",
        "online_access_codes_enabled": true,
        "offline_access_codes_enabled": true,
        "supports_accessory_keypad": true,
        "supports_offline_access_codes": true,
        "noise_level_decibels": 1,
        "currently_triggering_noise_threshold_ids": [
          "text"
        ],
        "appearance": {
          "name": "text"
        },
        "model": {
          "can_connect_accessory_keypad": true,
          "display_name": "text",
          "manufacturer_display_name": "text",
          "has_built_in_keypad": true,
          "offline_access_codes_supported": true,
          "online_access_codes_supported": true,
          "accessory_keypad_supported": true
        },
        "battery": {
          "level": 1,
          "status": "critical"
        },
        "accessory_keypad": {
          "is_connected": true,
          "battery": {
            "level": 1
          }
        },
        "salto_space_credential_service_metadata": {
          "has_active_phone": true
        },
        "assa_abloy_credential_service_metadata": {
          "has_active_endpoint": true,
          "endpoints": [
            {
              "endpoint_id": "text",
              "is_active": 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",
          "access_code_length": 1,
          "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_metadata": {
          "lock_id": "text",
          "customer_reference": "text",
          "lock_type": "text",
          "battery_level": "text",
          "locked_state": "text",
          "model": "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"
        },
        "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"
        },
        "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"
        },
        "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"
        },
        "noiseaware_metadata": {
          "noise_level_nrs": 1,
          "noise_level_decibel": 1,
          "device_name": "text",
          "device_id": "text",
          "device_model": "indoor"
        },
        "seam_bridge_metadata": {
          "device_num": 1,
          "name": "text",
          "unlock_method": "bridge"
        },
        "ttlock_metadata": {
          "lock_id": 1,
          "lock_alias": "text",
          "feature_value": "text",
          "has_gateway": true,
          "features": {
            "passcode": true,
            "passcode_management": true,
            "unlock_via_gateway": true,
            "lock_command": true,
            "incomplete_keyboard_passcode": true
          },
          "wireless_keypads": [
            {
              "wireless_keypad_id": 1,
              "wireless_keypad_name": "text"
            }
          ]
        },
        "dormakaba_oracode_metadata": {
          "door_id": 1,
          "door_name": "text",
          "door_is_wireless": true,
          "site_id": 1,
          "site_name": "text",
          "iana_timezone": "text",
          "device_id": 1,
          "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"
            }
          ]
        },
        "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
            }
          }
        },
        "max_active_codes_supported": 1,
        "supports_backup_access_code_pool": true,
        "has_native_entry_events": true,
        "locked": true,
        "door_open": true,
        "_experimental_supported_code_from_access_codes_lengths": [
          1
        ],
        "supported_code_lengths": [
          1
        ],
        "keypad_battery": {
          "level": 1
        },
        "code_constraints": [
          {
            "constraint_type": "no_zeros"
          }
        ],
        "temperature_fahrenheit": 1,
        "temperature_celsius": 1,
        "relative_humidity": 1,
        "is_heating": true,
        "is_cooling": true,
        "is_fan_running": true,
        "is_temporary_manual_override_active": true,
        "fallback_climate_preset_key": null,
        "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,
        "fan_mode_setting": "auto",
        "available_hvac_mode_settings": [
          "off"
        ],
        "available_fan_mode_settings": [
          "auto"
        ],
        "temperature_threshold": {
          "lower_limit_celsius": 1,
          "lower_limit_fahrenheit": 1,
          "upper_limit_celsius": 1,
          "upper_limit_fahrenheit": 1
        },
        "current_climate_setting": {
          "climate_preset_key": "text",
          "can_edit": true,
          "can_delete": true,
          "name": null,
          "display_name": "text",
          "cooling_set_point_celsius": 1,
          "heating_set_point_celsius": 1,
          "cooling_set_point_fahrenheit": 1,
          "heating_set_point_fahrenheit": 1,
          "manual_override_allowed": true,
          "fan_mode_setting": "auto",
          "hvac_mode_setting": "off"
        },
        "default_climate_setting": {
          "climate_preset_key": "text",
          "can_edit": true,
          "can_delete": true,
          "name": null,
          "display_name": "text",
          "cooling_set_point_celsius": 1,
          "heating_set_point_celsius": 1,
          "cooling_set_point_fahrenheit": 1,
          "heating_set_point_fahrenheit": 1,
          "manual_override_allowed": true,
          "fan_mode_setting": "auto",
          "hvac_mode_setting": "off"
        },
        "available_climate_presets": [
          {
            "climate_preset_key": "text",
            "can_edit": true,
            "can_delete": true,
            "name": null,
            "display_name": "text",
            "cooling_set_point_celsius": 1,
            "heating_set_point_celsius": 1,
            "cooling_set_point_fahrenheit": 1,
            "heating_set_point_fahrenheit": 1,
            "manual_override_allowed": true,
            "fan_mode_setting": "auto",
            "hvac_mode_setting": "off"
          }
        ],
        "active_thermostat_schedule": null
      }
    }
  ],
  "devices": [
    {
      "device_id": "123e4567-e89b-12d3-a456-426614174000",
      "nickname": "text",
      "display_name": "text",
      "connected_account_id": "123e4567-e89b-12d3-a456-426614174000",
      "workspace_id": "123e4567-e89b-12d3-a456-426614174000",
      "created_at": "2025-02-21T14:47:50.914Z",
      "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,
      "is_managed": true,
      "capabilities_supported": [
        "access_code"
      ],
      "device_type": "akuvox_lock",
      "location": {
        "location_name": "text",
        "timezone": "text"
      },
      "custom_metadata": {
        "ANY_ADDITIONAL_PROPERTY": "text"
      },
      "errors": [
        {
          "message": "text",
          "is_device_error": true,
          "error_code": "device_offline"
        }
      ],
      "warnings": [
        {
          "message": "text",
          "warning_code": "partial_backup_access_code_pool"
        }
      ],
      "properties": {
        "online": true,
        "name": "text",
        "has_direct_power": true,
        "battery_level": 1,
        "manufacturer": "text",
        "image_url": "https://example.com",
        "image_alt_text": "text",
        "serial_number": "text",
        "online_access_codes_enabled": true,
        "offline_access_codes_enabled": true,
        "supports_accessory_keypad": true,
        "supports_offline_access_codes": true,
        "noise_level_decibels": 1,
        "currently_triggering_noise_threshold_ids": [
          "text"
        ],
        "appearance": {
          "name": "text"
        },
        "model": {
          "can_connect_accessory_keypad": true,
          "display_name": "text",
          "manufacturer_display_name": "text",
          "has_built_in_keypad": true,
          "offline_access_codes_supported": true,
          "online_access_codes_supported": true,
          "accessory_keypad_supported": true
        },
        "battery": {
          "level": 1,
          "status": "critical"
        },
        "accessory_keypad": {
          "is_connected": true,
          "battery": {
            "level": 1
          }
        },
        "salto_space_credential_service_metadata": {
          "has_active_phone": true
        },
        "assa_abloy_credential_service_metadata": {
          "has_active_endpoint": true,
          "endpoints": [
            {
              "endpoint_id": "text",
              "is_active": 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",
          "access_code_length": 1,
          "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_metadata": {
          "lock_id": "text",
          "customer_reference": "text",
          "lock_type": "text",
          "battery_level": "text",
          "locked_state": "text",
          "model": "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"
        },
        "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"
        },
        "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"
        },
        "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"
        },
        "noiseaware_metadata": {
          "noise_level_nrs": 1,
          "noise_level_decibel": 1,
          "device_name": "text",
          "device_id": "text",
          "device_model": "indoor"
        },
        "seam_bridge_metadata": {
          "device_num": 1,
          "name": "text",
          "unlock_method": "bridge"
        },
        "ttlock_metadata": {
          "lock_id": 1,
          "lock_alias": "text",
          "feature_value": "text",
          "has_gateway": true,
          "features": {
            "passcode": true,
            "passcode_management": true,
            "unlock_via_gateway": true,
            "lock_command": true,
            "incomplete_keyboard_passcode": true
          },
          "wireless_keypads": [
            {
              "wireless_keypad_id": 1,
              "wireless_keypad_name": "text"
            }
          ]
        },
        "dormakaba_oracode_metadata": {
          "door_id": 1,
          "door_name": "text",
          "door_is_wireless": true,
          "site_id": 1,
          "site_name": "text",
          "iana_timezone": "text",
          "device_id": 1,
          "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"
            }
          ]
        },
        "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
            }
          }
        },
        "max_active_codes_supported": 1,
        "supports_backup_access_code_pool": true,
        "has_native_entry_events": true,
        "locked": true,
        "door_open": true,
        "_experimental_supported_code_from_access_codes_lengths": [
          1
        ],
        "supported_code_lengths": [
          1
        ],
        "keypad_battery": {
          "level": 1
        },
        "code_constraints": [
          {
            "constraint_type": "no_zeros"
          }
        ],
        "temperature_fahrenheit": 1,
        "temperature_celsius": 1,
        "relative_humidity": 1,
        "is_heating": true,
        "is_cooling": true,
        "is_fan_running": true,
        "is_temporary_manual_override_active": true,
        "fallback_climate_preset_key": null,
        "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,
        "fan_mode_setting": "auto",
        "available_hvac_mode_settings": [
          "off"
        ],
        "available_fan_mode_settings": [
          "auto"
        ],
        "temperature_threshold": {
          "lower_limit_celsius": 1,
          "lower_limit_fahrenheit": 1,
          "upper_limit_celsius": 1,
          "upper_limit_fahrenheit": 1
        },
        "current_climate_setting": {
          "climate_preset_key": "text",
          "can_edit": true,
          "can_delete": true,
          "name": null,
          "display_name": "text",
          "cooling_set_point_celsius": 1,
          "heating_set_point_celsius": 1,
          "cooling_set_point_fahrenheit": 1,
          "heating_set_point_fahrenheit": 1,
          "manual_override_allowed": true,
          "fan_mode_setting": "auto",
          "hvac_mode_setting": "off"
        },
        "default_climate_setting": {
          "climate_preset_key": "text",
          "can_edit": true,
          "can_delete": true,
          "name": null,
          "display_name": "text",
          "cooling_set_point_celsius": 1,
          "heating_set_point_celsius": 1,
          "cooling_set_point_fahrenheit": 1,
          "heating_set_point_fahrenheit": 1,
          "manual_override_allowed": true,
          "fan_mode_setting": "auto",
          "hvac_mode_setting": "off"
        },
        "available_climate_presets": [
          {
            "climate_preset_key": "text",
            "can_edit": true,
            "can_delete": true,
            "name": null,
            "display_name": "text",
            "cooling_set_point_celsius": 1,
            "heating_set_point_celsius": 1,
            "cooling_set_point_fahrenheit": 1,
            "heating_set_point_fahrenheit": 1,
            "manual_override_allowed": true,
            "fan_mode_setting": "auto",
            "hvac_mode_setting": "off"
          }
        ],
        "active_thermostat_schedule": null
      }
    }
  ]
}

OK

---

Request

List all locks or filter the list of locks by including the corresponding filter parameter in the request body.

Request Body Parameters

Parameter	Type	Description
connected_account_id	String Optional	ID of the connected account.
connected_account_ids	String[] Optional	IDs of the connected accounts.
connect_webview_id	String Optional	ID of Connect Webview.
device_type	String Optional	Type of lock.
device_types	String[] Optional	Types of locks.
manufacturer	String Optional	Lock manufacturer.
device_ids	String[] Optional	IDs of the locks to include.
limit	Number Optional	Numerical limit on the number of locks to return.
created_before	String Optional	Date threshold for locks to return. If specified, returns only locks created before the specified date.
user_identifier_key	String Optional	Your own internal user ID for the user by which to filter locks.
custom_metadata_has	JSON object Optional	Set of key:value custom metadata pairs by which you want to filter locks.

---

Sample Request

Python

seam.locks.list()

cURL (bash)

# Use GET or POST.
curl -X 'GET' \
  'https://connect.getseam.com/locks/list' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{}'

JavaScript

await seam.locks.list()

Ruby

client.locks.list()

C#

seam.Locks.List();

Java

seam.locks().list();

Response

Returns a locks array, in which each returned lock contains the set of applicable lock properties. For details, see Locks.

Sample Response

Python

[
  Lock(
    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
  ),
  ...
]

cURL (bash)

{
  "locks": [
    {
      "device_id": "30fd243b-3054-4384-a713-5487076a3826",
      "device_type": "august_lock",
      "capabilities_supported": [
        "access_code",
        "lock"
      ],
      "properties": {
        "locked": true,
        "online": true,
        "door_open": false,
        "manufacturer": "august",
        "battery_level": 0.9999532347993827,
        "serial_number": "00000004-992d-45a0-bea1-9128fdcd8d12",
        "august_metadata": {
          "lock_id": "lock-2",
          "house_id": "house-1",
          "lock_name": "BACK DOOR",
          "has_keypad": true,
          "house_name": "My House",
          "keypad_battery_level": "Not Available"
        },
        "supported_code_lengths": [
          4,
          5,
          6,
          7,
          8
        ],
        "has_native_entry_events": true,
        "supports_accessory_keypad": true,
        "online_access_codes_enabled": true,
        "offline_access_codes_enabled": false,
        "supports_offline_access_codes": false,
        "name": "BACK DOOR",
        "model": {
          "display_name": "Lock",
          "manufacturer_display_name": "August",
          "accessory_keypad_supported": true,
          "offline_access_codes_supported": false,
          "online_access_codes_supported": true
        },
        "battery": {
          "level": 0.9999532347993827,
          "status": "full"
        },
        "image_url": "https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png",
        "image_alt_text": "August Wifi Smart Lock 3rd Gen, Silver, Front",
        "code_constraints": [],
        "supports_backup_access_code_pool": true
      },
      "location": {
        "timezone": "America/Los_Angeles",
        "location_name": "My House"
      },
      "connected_account_id": "f72442d2-2c16-4e3f-9882-6bff21828b1b",
      "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
      "created_at": "2023-10-28T09:13:08.465Z",
      "errors": [],
      "warnings": [],
      "custom_metadata": {
          "internal_account_id": "user-1"
      },
      "is_managed": true
    },
    ...
  ],
  "ok": true
}

JavaScript

[
  {
    device_id: '30fd243b-3054-4384-a713-5487076a3826',
    device_type: 'august_lock',
    capabilities_supported:[
      'access_code',
      'lock'
    ],
    properties: {
      locked: true,
      online: true,
      door_open: false,
      manufacturer: 'august',
      battery_level: 0.9999532347993827,
      serial_number: '00000004-992d-45a0-bea1-9128fdcd8d12',
      august_metadata: [Object],
      supported_code_lengths: [Array],
      has_native_entry_events: true,
      supports_accessory_keypad: true,
      online_access_codes_enabled: true,
      offline_access_codes_enabled: false,
      supports_offline_access_codes: false,
      name: 'BACK DOOR',
      model: [Object],
      battery: [Object],
      image_url: 'https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png',
      image_alt_text: 'August Wifi Smart Lock 3rd Gen, Silver, Front',
      code_constraints: [],
      supports_backup_access_code_pool: true
    },
    location:{
      timezone: 'America/Los_Angeles',
      location_name: 'My House'
    },
    connected_account_id: 'f72442d2-2c16-4e3f-9882-6bff21828b1b',
    workspace_id: '398d80b7-3f96-47c2-b85a-6f8ba21d07be',
    created_at: '2023-10-28T09:13:08.465Z',
    errors: [],
    warnings: [],
    custom_metadata:{
      'internal_account_id': 'user-1'
    },
    is_managed: true
  },
  ...
]

Ruby

[
  <Seam::Lock:0x006b8
    device_id="30fd243b-3054-4384-a713-5487076a3826"
    device_type="august_lock"
    capabilities_supported=[
      "access_code",
      "lock"
    ]
    properties={
      "locked"=>true,
      "online"=>true,
      "door_open"=>false,
      "manufacturer"=>"august",
      "battery_level"=>0.9999532347993827,
      "serial_number"=>"00000004-992d-45a0-bea1-9128fdcd8d12",
      "august_metadata"=>{
        "lock_id"=>"lock-2",
        "house_id"=>"house-1",
        "lock_name"=>"BACK DOOR",
        "has_keypad"=>true,
        "house_name"=>"My House",
        "keypad_battery_level"=>"Not Available"
      },
      "supported_code_lengths"=>[
        4,
        5,
        6,
        7,
        8
      ],
      "has_native_entry_events"=>true,
      "supports_accessory_keypad"=>true,
      "online_access_codes_enabled"=>true,
      "offline_access_codes_enabled"=>false,
      "supports_offline_access_codes"=>false,
      "name"=>"BACK DOOR",
      "model"=>{
        "display_name"=>"Lock",
        "manufacturer_display_name"=>"August",
        "accessory_keypad_supported"=>true,
        "offline_access_codes_supported"=>false,
        "online_access_codes_supported"=>true
      },
      "battery"=>{
        "level"=>0.9999532347993827,
        "status"=>"full"
      },
      "image_url"=> "https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png",
      "image_alt_text"=>"August Wifi Smart Lock 3rd Gen, Silver, Front",
      "code_constraints"=>[],
      "supports_backup_access_code_pool"=>true
    }
    connected_account_id="f72442d2-2c16-4e3f-9882-6bff21828b1b"
    workspace_id="398d80b7-3f96-47c2-b85a-6f8ba21d07be"
    created_at=2023-10-28 09:13:08.465 UTC
    errors=[]
    warnings=[]
    custom_metadata={
      "internal_account_id"=>"user-1"
    }
    is_managed=true
  >,
  ...
]

C#

{
  "device_id": "30fd243b-3054-4384-a713-5487076a3826",
  "device_type": "august_lock",
  "capabilities_supported": [
    "access_code",
    "lock"
  ],
  "properties": {
    "online": true,
    "name": "BACK DOOR",
    "model": {
      "display_name": "Lock",
      "manufacturer_display_name": "August",
      "offline_access_codes_supported": false,
      "accessory_keypad_supported": true
    },
    "battery_level": 0.9999532,
    "battery": {
      "level": 0.9999532,
      "status": "full"
    },
    "manufacturer": "august",
    "image_url": "https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png",
    "image_alt_text": "August Wifi Smart Lock 3rd Gen, Silver, Front",
    "serial_number": "00000004-992d-45a0-bea1-9128fdcd8d12",
    "online_access_codes_enabled": true,
    "offline_access_codes_enabled": false,
    "supports_accessory_keypad": true,
    "supports_offline_access_codes": false,
    "august_metadata": {
      "lock_id": "lock-2",
      "lock_name": "BACK DOOR",
      "house_name": "My House",
      "has_keypad": true,
      "keypad_battery_level": "Not Available",
      "house_id": "house-1"
    },
    "code_constraints": [],
    "supported_code_lengths": [
      4.0,
      5.0,
      6.0,
      7.0,
      8.0
    ],
    "supports_backup_access_code_pool": true,
    "has_native_entry_events": true,
    "locked": true,
    "door_open": false
  },
  "location": {
    "location_name": "My House",
    "timezone": "America/Los_Angeles"
  },
  "connected_account_id": "f72442d2-2c16-4e3f-9882-6bff21828b1b",
  "workspace_id": "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
  "errors": [],
  "warnings": [],
  "custom_metadata": {
    "internal_account_id": "user-1"
  },
  "created_at": "2023-10-28T09:13:08.465Z",
  "is_managed": true
}
...

Java

[
  {
    "device_id" : "30fd243b-3054-4384-a713-5487076a3826",
    "device_type" : "august_lock",
    "capabilities_supported" : [
      "access_code",
      "lock"
    ],
    "properties" : {
      "online" : true,
      "name" : "BACK DOOR",
      "model" : {
        "display_name" : "Lock",
        "online_access_codes_supported" : true,
        "accessory_keypad_supported" : true,
        "offline_access_codes_supported" : false,
        "manufacturer_display_name" : "August"
      },
      "august_metadata" : {
        "lock_id" : "lock-2",
        "lock_name" : "BACK DOOR",
        "house_name" : "My House",
        "house_id" : "house-1",
        "has_keypad" : true,
        "keypad_battery_level" : "Not Available"
      },
      "offline_access_codes_enabled" : false,
      "battery_level" : 0.9999532347993827,
      "image_url" : "https://connect.getseam.com/assets/images/devices/august_wifi-smart-lock-3rd-gen_silver_front.png",
      "supports_accessory_keypad" : true,
      "serial_number" : "00000004-992d-45a0-bea1-9128fdcd8d12",
      "battery" : {
        "level" : 0.9999532347993827,
        "status" : "full"
      },
      "code_constraints" : [ ],
      "has_native_entry_events" : true,
      "image_alt_text" : "August Wifi Smart Lock 3rd Gen, Silver, Front",
      "manufacturer" : "august",
      "door_open" : false,
      "online_access_codes_enabled" : true,
      "supported_code_lengths" : [
        4,
        5,
        6,
        7,
        8
      ],
      "locked" : true,
      "supports_offline_access_codes" : false,
      "supports_backup_access_code_pool" : true
    },
    "location" : {
      "timezone" : "America/Los_Angeles",
      "location_name" : "My House"
    },
    "connected_account_id" : "f72442d2-2c16-4e3f-9882-6bff21828b1b",
    "workspace_id" : "398d80b7-3f96-47c2-b85a-6f8ba21d07be",
    "custom_metadata": {
      "internal_account_id": "user-1"
    },
    "created_at" : "2023-10-28T09:13:08.465Z",
    "is_managed" : true
  },
  ...
]