Provider Metadata

When integrating with a provider, Seam adds any information that doesn’t fit nicely into a cross-provider standard field into the provider metadata for a device or system. Provider metadata is an object named as follows on a device or system: [device or acs_system].properties.[provider]_metadata Examples of provider metadata include august_metadata, schlage_metadata, and visionline_metadata. Sometimes provider metadata contains fields where Seam is still coming up with a standard representation, so you can use these fields to “get ahead” of Seam’s standardized implementation.

Do not use [provider]_metadata.model because it is being deprecated and is likely to be changed or removed in the future.

Getting Provider Metadata

To access provider metadata, make any call that returns device properties, such as /devices/get or /devices/list.

Provider metadata is also available in sandbox workspaces, so if you want to see typical examples of provider metadata, you can just create a webview and connect devices in a sandbox workspace to read the properties.

For example, to get SmartThings metadata:

const devices = await seam.devices.list()

console.log(devices[0].properties.smartthings_metadata)
/*
{
  "model": "0129-8002-0600",
  "device_id": "750ed15f-93f2-4ff1-8944-47e93b10f7d6",
  "device_name": "Yale Door Lock"
}
*/

curl \
  -H 'Authorization: Bearer MY_API_KEY' \
  https://connect.getseam.com/devices/list

#{
#  "devices": [
#    {
#      "device_id": "3c196474-d2eb-4e07-b1d0-e2996eeb40d0",
#      "device_type": "smartthings_lock",
#      "properties": {
#        "smartthings_metadata": {
#          "model": "0129-8002-0600",
#          "device_id": "750ed15f-93f2-4ff1-8944-47e93b10f7d6",
#          "device_name": "Yale Door Lock"
#        },
# ...