List Device Model Summaries

GET https://ecosystem.seam.co/v1/device_models/summaries/list

Lists published device models in a slim shape built for product pages and widgets. Use it to filter models by device type, provider, or capability, or to fetch specific models by slug. With a manufacturer key, it lists your device models unless you set manufacturer. The endpoint also accepts POST with the same parameters as a JSON body.

Examples

Your smart locks that support online access codes, using your manufacturer secret key:

curl --compressed -G \
  -H "Authorization: Bearer eco_sk_your_secret_key" \
  "https://ecosystem.seam.co/v1/device_models/summaries/list" \
  -d device_type=smartlock \
  -d capability=can_program_online_access_codes \
  -d supported=yes

Specific models, without a key:

curl --compressed -G \
  "https://ecosystem.seam.co/v1/device_models/summaries/list" \
  -d slugs=connected-keypads,camelot-trim-connected-keypad-deadbolt

Parameters

Parameter	Type	Default	Description
`manufacturer`	string	Your manufacturer key’s brand	A manufacturer slug, for example `schlage`.
`device_type`	string	—	A device type slug, for example `smartlock`, `thermostat`, or `intercom`.
`provider`	string	—	A provider slug, for example `schlage-engage`.
`capability`	string	—	Only models that have a result for this capability, whatever its value. Add `supported` to match a value.
`supported`	string	—	With `capability`, the support value to match: `yes`, `no`, or `conditionally`. For example, `capability=can_remotely_unlock&supported=yes`.
`slugs`	string[]	—	Only these device models.
`is_accessory`	boolean	—	`true` for accessories, such as keypads and bridges, or `false` for primary devices.
`locale`	string	`en`	The language for capability reports: `en` or `fr`.
`include`	string[]	—	`commerce` adds shop and marketplace listings, ASINs, and GTINs.
`include_forbidden`	boolean	`false`	Include your own device models that are hidden from third parties. Takes effect only with your manufacturer secret key. See Hidden Device Models.
`limit`	number	`100`	The number of device models per page, from 1 to 500.
`page_cursor`	string	—	The `pagination.next_page_cursor` from the previous page.

Response

{
  "device_models": [
    {
      "device_model_id": "…",
      "slug": "camelot-trim-connected-keypad-deadbolt",
      "display_name": "Camelot Trim Connected Keypad Deadbolt",
      "manufacturer": { "slug": "schlage", "display_name": "Schlage" },
      "device_type": { "slug": "smartlock", "display_name": "Smartlock" },
      "variants": [],
      "providers": [],
      "capabilities_by_provider": []
    }
  ],
  "pagination": {
    "has_next_page": true,
    "next_page_cursor": "camelot-trim-connected-keypad-deadbolt"
  },
  "ok": true
}

Device models are ordered by slug. When pagination.has_next_page is true, pass pagination.next_page_cursor as page_cursor to get the next page.

Device Model Summary

Each device model in this endpoint and in manufacturer_content/get has these fields:

Field	Description
`device_model_id`	The device model’s ID.
`slug`	A stable identifier, for example `camelot-trim-connected-keypad-deadbolt`.
`display_name`	The model name.
`description_md`	A description in Markdown, when recorded.
`product_url`	The manufacturer’s product page, when recorded.
`no_longer_sold`	Whether the model is discontinued, or `null` if not known.
`is_forbidden_to_3dparty`	Whether the model is hidden from third parties. See Hidden Device Models.
`manufacturer`	The manufacturer’s `slug` and `display_name`.
`device_type`	The device type’s `slug`, `display_name`, and `is_accessory`.
`device_type_properties`	Properties specific to the device type, when recorded.
`featured_image`	The main image, with `url`, `mime`, `width`, `height`, and smaller renditions in `formats` (`thumbnail`, `small`, `medium`, `large`).
`variants`	Each color or style of the model, with `color_name`, `style_name`, `primary_color_hex`, `manufacturer_model_id` (your model number), and `images`. With `include=commerce`, also `asin`, `gtins`, and `marketplace_listings`.
`providers`	The providers that connect this model to Seam.
`capabilities_by_provider`	For each provider, the model’s capabilities through that provider.
`capabilities_stale`	`true` while Seam is recalculating some of the model’s capabilities. Those providers are left out of `capabilities_by_provider` until then.
`shop_listings`, `last_commerce_search_at`	Shop listings and when they were last checked. Only with `include=commerce`.
`updated_at`	When the model was last updated.

Capabilities

Each capability in capabilities_by_provider has:

name: the capability, for example can_remotely_unlock.
supported: yes, no, or conditionally.
integration_support_level: the support level of the provider integration behind it, for example stable or beta.
report: an explanation in the requested locale, with details and any requirements, or null.

Capability names match the capability flags the Seam API reports on devices: device_connectivity, can_remotely_unlock, can_remotely_lock, can_program_online_access_codes, can_program_offline_access_codes, can_provision_mobile_keys, can_provision_wallet_keys, can_encode_plastic_cards, can_hvac_heat, can_hvac_cool, can_hvac_auto, can_hvac_fan, can_program_thermostat_weekly_programs, and can_monitor.

Next Steps

Get your whole catalog, integrations, and compatible apps in one call with Get Manufacturer Content.
Show your device models on your website with Supported Devices.

Getting Started

Use Cases

Core Concepts

Capability Guides

UI Components

Developer Tools

Industry Guides

Device Manufacturer Guidance

Low-Level APIs

List Device Model Summaries

Examples

Parameters

Response

Device Model Summary

Capabilities

Next Steps

​Examples

​Parameters

​Response

​Device Model Summary

​Capabilities

​Next Steps

Examples

Parameters

Response

Device Model Summary

Capabilities

Next Steps