{
"capabilities": [
{
"capability_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "device_connectivity",
"supported": "yes",
"integration_support_level": "inquire",
"report": {
"details": "<string>",
"requirements": {},
"dependencies": [
"<string>"
]
},
"report_raw": {
"details": "<string>",
"requirements": {},
"dependencies": [
"<string>"
]
},
"locale": "<string>",
"computed_at": "2023-11-07T05:31:56Z",
"device_model": {
"device_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>"
},
"provider": {
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>"
}
}
],
"pagination": {
"has_next_page": true,
"next_page_cursor": "<string>"
},
"ok": true
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}List Capabilities
Lists computed capabilities for one device model or across models, ordered by device model, provider and capability name. Capability reports are resolved per locale, with the raw translation keys in report_raw. Device models hidden from third parties are excluded; with a manufacturer secret key, include_forbidden adds that manufacturer’s own hidden models.
{
"capabilities": [
{
"capability_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "device_connectivity",
"supported": "yes",
"integration_support_level": "inquire",
"report": {
"details": "<string>",
"requirements": {},
"dependencies": [
"<string>"
]
},
"report_raw": {
"details": "<string>",
"requirements": {},
"dependencies": [
"<string>"
]
},
"locale": "<string>",
"computed_at": "2023-11-07T05:31:56Z",
"device_model": {
"device_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>"
},
"provider": {
"provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"display_name": "<string>"
}
}
],
"pagination": {
"has_next_page": true,
"next_page_cursor": "<string>"
},
"ok": true
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}{
"ok": false,
"error": {
"type": "<string>",
"message": "<string>",
"request_id": "<string>",
"data": {}
}
}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
Device model slug; omit to read across models.
Device model UUID.
^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$Only capabilities for device models with these slugs.
Provider slug.
Capability names to include.
device_connectivity, can_program_online_access_codes, can_program_offline_access_codes, can_remotely_unlock, can_remotely_lock, can_encode_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 Only capabilities with this support value.
yes, no, conditionally 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 capabilities to return (1-500).
1 <= x <= 500The next_page_cursor from the previous page.
Was this page helpful?