> ## Documentation Index
> Fetch the complete documentation index at: https://www.seam.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Filtering Devices by Custom Metadata

> When listing devices, you can filter by custom metadata.

When you use [List Devices](https://www.seam.co/docs/api/devices/list.md), you can filter the list by one or more [custom metadata](https://www.seam.co/docs/core-concepts/devices.md) pairs. Include the `custom_metadata_has` parameter with a JSON string that specifies the desired key:value pairs.

> [!NOTE]
>
> You can use the [Update Connected
> Account](https://www.seam.co/docs/api/connected_accounts/update.md) method
> with the optional `custom_metadata` property to [add custom metadata for a
> device](https://www.seam.co/docs/core-concepts/devices/adding-custom-metadata-to-a-device.md).

**Request:**

```javascript JavaScript theme={"dark"}
const devices = await seam.devices.list({
  custom_metadata_has: {
    internal_account_id: 'user-1',
  },
})

console.log(devices)
```

```bash cURL theme={"dark"}
curl -X 'POST' \
  'https://connect.getseam.com/devices/list' \
  -H 'accept: application/json' \
  -H 'Authorization: Bearer ${API_KEY}' \
  -H 'Content-Type: application/json' \
  -d '{
  "custom_metadata_has": {
    "internal_account_id": "user-1"
  },
}'
```

```python Python theme={"dark"}
devices = seam.devices.list(
  custom_metadata_has = {
    "internal_account_id": "user-1"
  }
)

pprint(devices)
```

```ruby Ruby theme={"dark"}
devices = client.devices.list(
  custom_metadata_has: {
    "internal_account_id": "user-1"
  }
)

puts devices.inspect
```

```php PHP theme={"dark"}
$devices = $seam->devices->list(
  custom_metadata_has: array('internal_account_id' => 'user-1')
);

echo json_encode($devices);
```

```csharp C# theme={"dark"}
var customMetadata = new Dictionary<string, string>()
{
  {"internal_account_id", "user-1"}
};

var devices = seam.Devices.List(
  customMetadataHas: customMetadata
);

foreach (var device in devices)
{
  Console.WriteLine(device);
}
```

**Response:**

```json JavaScript theme={"dark"}
[
  {
    device_id: 'f7a7fb02-9277-4354-8dd1-28e2d016a7a9',
    device_type: 'schlage_lock',
    ...
    is_managed: true,
    custom_metadata: { internal_account_id: 'user-1' }
  },
  ...
]
```

```json cURL theme={"dark"}
{
  "devices": [
    {
      "device_id": "f7a7fb02-9277-4354-8dd1-28e2d016a7a9",
      "device_type": "schlage_lock",
      ...
      "is_managed": true,
      "custom_metadata": {
        "internal_account_id": "user-1"
      }
    }
  ],
  "ok": true
}
```

```json Python theme={"dark"}
[Device(device_id='f7a7fb02-9277-4354-8dd1-28e2d016a7a9',
        device_type='schlage_lock',
        ...
        is_managed=True,
        custom_metadata={"internal_account_id": "user-1"}),
...]
```

```json Ruby theme={"dark"}
[<Seam::Device:0x004d8
  device_id="f7a7fb02-9277-4354-8dd1-28e2d016a7a9"
  device_type="schlage_lock"
  ...
  is_managed=true
  custom_metadata={"internal_account_id"=>"user-1"}>, ...]
```

```json PHP theme={"dark"}
[{"device_id":"f7a7fb02-9277-4354-8dd1-28e2d016a7a9","device_type":"schlage_lock",..."is_managed":true,"custom_metadata":{"internal_account_id":"user-1"}},...]
```

```json C# theme={"dark"}
{
  "device_id": "f7a7fb02-9277-4354-8dd1-28e2d016a7a9",
  "device_type": "schlage_lock",
  ...
  "is_managed": true,
  "custom_metadata": {
    "internal_account_id": "user-1"
  }
}
...
```


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.