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
curl --compressed -G \
"https://ecosystem.seam.co/v1/device_models/summaries/list" \
-d slugs=connected-keypads,camelot-trim-connected-keypad-deadbolt
{
"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
}
List Device Model Summaries
Lists published device models in the slim summary shape built for product pages and widgets, with the same filters, pagination and key rules as device_models/list, ordered by slug. Images keep their URLs and renditions, capabilities keep their resolved reports, and commerce data (marketplace and shop listings, ASINs, GTINs) is added only with include=commerce.
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
curl --compressed -G \
"https://ecosystem.seam.co/v1/device_models/summaries/list" \
-d slugs=connected-keypads,camelot-trim-connected-keypad-deadbolt
{
"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
}
manufacturer.
capability matches every model that has a result for that capability, including no. To list only the models that support it, also set supported=yes.
Capabilities
Each capability incapabilities_by_provider has a name, a supported value (yes, no, or conditionally), the integration_support_level of the provider integration behind it, and a report that explains it in the requested locale. 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.
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
curl --compressed -G \
"https://ecosystem.seam.co/v1/device_models/summaries/list" \
-d slugs=connected-keypads,camelot-trim-connected-keypad-deadbolt
{
"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
}
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.
Authorizations
Optional on endpoints that serve published content. A secret key (eco_sk_…), sent as Authorization: Bearer eco_sk_… from your servers only. A manufacturer secret key implies its manufacturer and can include that manufacturer's device models hidden from third parties.
Query Parameters
Only device models with these slugs.
Manufacturer slug. Defaults to the manufacturer of a manufacturer key.
Device type slug.
Provider slug.
Only models with a computed capability of this name.
device_connectivity, can_program_online_access_codes, can_program_offline_access_codes, can_remotely_unlock, can_remotely_lock, can_encode_plastic_cards, can_assign_plastic_cards, can_provision_mobile_keys, can_provision_wallet_keys, can_hvac_cool, can_hvac_heat, can_hvac_auto, can_hvac_fan, can_program_thermostat_weekly_programs, can_monitor With capability, the required support value.
yes, no, conditionally Filter by the pinned device type's accessory flag.
Include models forbidden to third parties (is_forbidden_to_3dparty): all of them for Seam callers, its own for a manufacturer secret key, none otherwise. Defaults to false.
Locale for resolved capability report text; unknown locales fall back to the default locale.
Maximum number of device models to return (1-500).
1 <= x <= 500The next_page_cursor from the previous page.
Optional data to add: commerce adds marketplace and shop listings, ASINs and GTINs.
commerce Was this page helpful?