Filtering Devices by Custom Metadata

When listing devices, you can filter by custom metadata.

When you use List Devices, you can filter the list by one or more custom metadata pairs. Include the custom_metadata_has parameter with a JSON string that specifies the desired key:value pairs.

You can use the Update Connected Account method with the optional custom_metadata property to add custom metadata for a device.

JavaScript

Request:

const devices = await seam.devices.list({
  custom_metadata_has: {
    "internal_account_id": "user-1"
  }
});

console.log(devices);

Response:

[
  {
    device_id: 'f7a7fb02-9277-4354-8dd1-28e2d016a7a9',
    device_type: 'schlage_lock',
    ...
    is_managed: true,
    custom_metadata: { internal_account_id: 'user-1' }
  },
  ...
]

cURL

Python

Ruby

PHP

C#