{
  "device_models": [
    {
      "device_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "display_name": "<string>",
      "description_md": "<string>",
      "product_url": "<string>",
      "is_forbidden_to_3dparty": true,
      "no_longer_sold": true,
      "shop_listings": "<unknown>",
      "last_commerce_search_at": "2023-11-07T05:31:56Z",
      "manufacturer": {
        "manufacturer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "display_name": "<string>"
      },
      "device_type": {
        "device_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "display_name": "<string>",
        "is_accessory": true
      },
      "device_type_properties": "<unknown>",
      "variants": [
        {
          "device_model_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "color_name": "<string>",
          "style_name": "<string>",
          "primary_color_hex": "<string>",
          "manufacturer_model_id": "<string>",
          "asin": "<string>",
          "gtins": "<unknown>",
          "marketplace_listings": "<unknown>",
          "sort_order": 0,
          "images": [
            {
              "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "kind": "square_logo",
              "object_key": "<string>",
              "url": "<string>",
              "mime": "<string>",
              "width": 0,
              "height": 0,
              "bytes": 0,
              "sha256": "<string>",
              "sort_order": 0,
              "formats": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "featured_image": {
        "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "square_logo",
        "object_key": "<string>",
        "url": "<string>",
        "mime": "<string>",
        "width": 0,
        "height": 0,
        "bytes": 0,
        "sha256": "<string>",
        "sort_order": 0,
        "formats": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "providers": [
        {
          "provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "display_name": "<string>"
        }
      ],
      "capabilities_by_provider": [
        {
          "provider": {
            "provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "slug": "<string>",
            "display_name": "<string>"
          },
          "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"
            }
          ]
        }
      ],
      "capabilities_stale": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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": {}
  }
}

API Reference

List Device Models

Lists published device models with variants, properties, featured image, providers and capabilities grouped by provider, ordered by slug. Filters combine with AND. A manufacturer key (embed or secret) defaults manufacturer to its own manufacturer; pass another slug to list that manufacturer’s models. Device models hidden from third parties are excluded; with a manufacturer secret key, include_forbidden adds that manufacturer’s own hidden models. Capability reports are resolved per locale, with the raw translation keys in report_raw.

GET

device_models

list

{
  "device_models": [
    {
      "device_model_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "slug": "<string>",
      "display_name": "<string>",
      "description_md": "<string>",
      "product_url": "<string>",
      "is_forbidden_to_3dparty": true,
      "no_longer_sold": true,
      "shop_listings": "<unknown>",
      "last_commerce_search_at": "2023-11-07T05:31:56Z",
      "manufacturer": {
        "manufacturer_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "display_name": "<string>"
      },
      "device_type": {
        "device_type_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "slug": "<string>",
        "display_name": "<string>",
        "is_accessory": true
      },
      "device_type_properties": "<unknown>",
      "variants": [
        {
          "device_model_variant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "color_name": "<string>",
          "style_name": "<string>",
          "primary_color_hex": "<string>",
          "manufacturer_model_id": "<string>",
          "asin": "<string>",
          "gtins": "<unknown>",
          "marketplace_listings": "<unknown>",
          "sort_order": 0,
          "images": [
            {
              "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
              "kind": "square_logo",
              "object_key": "<string>",
              "url": "<string>",
              "mime": "<string>",
              "width": 0,
              "height": 0,
              "bytes": 0,
              "sha256": "<string>",
              "sort_order": 0,
              "formats": {},
              "created_at": "2023-11-07T05:31:56Z",
              "updated_at": "2023-11-07T05:31:56Z"
            }
          ],
          "created_at": "2023-11-07T05:31:56Z",
          "updated_at": "2023-11-07T05:31:56Z"
        }
      ],
      "featured_image": {
        "asset_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "kind": "square_logo",
        "object_key": "<string>",
        "url": "<string>",
        "mime": "<string>",
        "width": 0,
        "height": 0,
        "bytes": 0,
        "sha256": "<string>",
        "sort_order": 0,
        "formats": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z"
      },
      "providers": [
        {
          "provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "slug": "<string>",
          "display_name": "<string>"
        }
      ],
      "capabilities_by_provider": [
        {
          "provider": {
            "provider_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "slug": "<string>",
            "display_name": "<string>"
          },
          "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"
            }
          ]
        }
      ],
      "capabilities_stale": true,
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z"
    }
  ],
  "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": {}
  }
}

This endpoint returns device models in the full shape, with storage details and the raw translation keys of capability reports. For product pages and widgets, use the slimmer List Device Model Summaries.

Authorizations

Authorization

string

header

required

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

slugs

string[]

Only device models with these slugs.

manufacturer

string

Manufacturer slug. Defaults to the manufacturer of a manufacturer key.

device_type

string

Device type slug.

provider

string

Provider slug.

capability

enum<string>

Only models with a computed capability of this name.

Available options:

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

supported

enum<string>

With capability, the required support value.

Available options:

yes,

no,

conditionally

is_accessory

Filter by the pinned device type's accessory flag.

include_forbidden

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

string

Locale for resolved capability report text; unknown locales fall back to the default locale.

limit

integer

default:100

Maximum number of device models to return (1-500).

Required range: 1 <= x <= 500

page_cursor

string

The next_page_cursor from the previous page.

Response

device_models

object[]

required

Published device models.

Show child attributes

pagination

object

required

Pagination for this page.

Show child attributes

boolean

required

Always true on success.

Getting Started

Use Cases

Core Concepts

Capability Guides

UI Components

Developer Tools

Industry Guides

Device Manufacturer Guidance

Low-Level APIs

List Device Models

Authorizations

Query Parameters

Response