> ## Documentation Index
> Fetch the complete documentation index at: https://www.seam.co/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Get Compatible Apps

> Lists the live partner apps that support a device category, manufacturer, provider or capability through Seam. A partner appears only where Seam or the partner has declared support. Browser requests from sites other than seam.co must send an embed key; server requests may send a secret key. A manufacturer key (embed or secret) defaults `manufacturer_slug` to its own manufacturer.

This is the data that the [Compatible Apps](/docs/ui-components/overview/ecosystem-components/compatible-apps) component shows.


## OpenAPI

````yaml device-manufacturer-guidance/manufacturer-api/openapi.json GET /compatibility
openapi: 3.1.0
info:
  title: Seam Ecosystem API
  version: 1.0.0
  description: >-
    Read what Seam publishes about the devices it supports: manufacturers,
    device models with their images, variants and capabilities, the providers
    that integrate them, and the partner apps that support them through Seam.


    Every endpoint accepts `GET` with query parameters, or `POST` with the same
    parameters as a JSON body. Successful responses include `"ok": true`.
    Published content is public, so you can call most endpoints without a key.
    Send an embed key from a browser, or a secret key from your servers, to
    identify yourself.
servers:
  - url: https://ecosystem.seam.co/v1
security: []
externalDocs:
  description: Manufacturer API guide
  url: https://www.seam.co/docs/device-manufacturer-guidance/manufacturer-api
paths:
  /compatibility:
    get:
      tags:
        - compatibility
      summary: Compatibility
      description: >-
        Lists the live partner apps that support a device category,
        manufacturer, provider or capability through Seam. A partner appears
        only where Seam or the partner has declared support. Browser requests
        from sites other than seam.co must send an embed key; server requests
        may send a secret key. A manufacturer key (embed or secret) defaults
        `manufacturer_slug` to its own manufacturer.
      parameters:
        - name: device_category
          in: query
          required: true
          schema:
            type: string
            pattern: ^[a-z0-9_]+$
            description: smartlock, thermostat, sensor, intercom, camera, acs, ...
        - name: manufacturer_slug
          in: query
          required: false
          schema:
            default: ''
            description: >-
              Manufacturer slug; defaults to the manufacturer of a manufacturer
              key.
            type: string
        - name: provider_slug
          in: query
          required: false
          schema:
            default: ''
            description: Provider slug, e.g. `salto-ks`, to narrow support to one provider.
            type: string
        - name: capability
          in: query
          required: false
          schema:
            default: ''
            description: >-
              Capability name, e.g. `can_provision_mobile_keys`, to narrow
              support to one capability.
            type: string
        - name: industry
          in: query
          required: false
          schema:
            description: Only partners serving this industry slug.
            type: string
        - name: include_unsupported
          in: query
          required: false
          schema:
            default: false
            description: >-
              Also return live partners resolved as not supported, with the
              reason.
            type: boolean
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  partners:
                    type: array
                    items:
                      type: object
                      properties:
                        partner_id:
                          type: string
                          format: uuid
                          pattern: >-
                            ^([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)$
                          description: Ecosystem UUID of the partner.
                        slug:
                          type: string
                          description: Stable identifier, e.g. `hospitable`.
                        display_name:
                          type: string
                          description: Display name.
                        website:
                          description: Website URL, when recorded.
                          type:
                            - string
                            - 'null'
                        description_md:
                          description: Markdown description written by Seam or the partner.
                          type:
                            - string
                            - 'null'
                        is_live:
                          type: boolean
                          description: >-
                            The partner's Seam integration is live for its
                            customers.
                        is_featured:
                          type: boolean
                          description: Featured by Seam in partner listings.
                        legacy_industry_featured:
                          type: boolean
                          description: >-
                            Legacy per-industry featured flag; use
                            `is_featured`.
                        industries:
                          type: array
                          items:
                            type: object
                            properties:
                              industry_id:
                                type: string
                                format: uuid
                                pattern: >-
                                  ^([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)$
                                description: Ecosystem UUID of the industry.
                              slug:
                                type: string
                                description: Stable identifier, e.g. `short-term-rental`.
                              display_name:
                                type: string
                                description: Display name.
                              short_name:
                                description: Short display name, when set.
                                type:
                                  - string
                                  - 'null'
                            required:
                              - industry_id
                              - slug
                              - display_name
                              - short_name
                            additionalProperties: false
                          description: Industries the partner serves.
                        solutions:
                          type: array
                          items:
                            type: object
                            properties:
                              solution_id:
                                type: string
                                format: uuid
                                pattern: >-
                                  ^([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)$
                                description: Ecosystem UUID of the solution.
                              slug:
                                type: string
                                description: >-
                                  Stable identifier, e.g.
                                  `property-management-system`.
                              display_name:
                                type: string
                                description: Display name.
                              short_name:
                                description: Short display name, when set.
                                type:
                                  - string
                                  - 'null'
                              type:
                                type: string
                                enum:
                                  - software
                                  - service
                                description: '`software` or `service`.'
                            required:
                              - solution_id
                              - slug
                              - display_name
                              - short_name
                              - type
                            additionalProperties: false
                          description: Kinds of software or service the partner offers.
                        assets:
                          type: array
                          items:
                            type: object
                            properties:
                              partner_asset_id:
                                type: string
                                format: uuid
                                pattern: >-
                                  ^([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)$
                                description: Ecosystem UUID of the asset.
                              kind:
                                type: string
                                enum:
                                  - square_logo
                                  - square_logo_mono
                                  - horizontal_logo
                                  - horizontal_logo_mono
                                  - product_image
                                description: Logo kind or `product_image`.
                              url:
                                type: string
                                format: uri
                                description: Public URL of the asset.
                              mime:
                                type: string
                                description: Media type.
                              width:
                                anyOf:
                                  - type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  - type: 'null'
                                description: Width in pixels, when known.
                              height:
                                anyOf:
                                  - type: integer
                                    minimum: -9007199254740991
                                    maximum: 9007199254740991
                                  - type: 'null'
                                description: Height in pixels, when known.
                              sort_order:
                                type: integer
                                minimum: -9007199254740991
                                maximum: 9007199254740991
                                description: Display order within the partner.
                            required:
                              - partner_asset_id
                              - kind
                              - url
                              - mime
                              - width
                              - height
                              - sort_order
                            additionalProperties: false
                          description: Logos and product images in display order.
                        created_at:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                          description: Creation time (ISO 8601).
                        updated_at:
                          type: string
                          format: date-time
                          pattern: >-
                            ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
                          description: Last update time (ISO 8601).
                        support:
                          type: object
                          properties:
                            supported:
                              type: boolean
                              description: >-
                                Whether the partner is listed for the requested
                                scope.
                            resolved_level:
                              anyOf:
                                - type: string
                                  enum:
                                    - device_category
                                    - manufacturer
                                    - provider
                                    - capability
                                - type: 'null'
                              description: >-
                                The most specific level with a declaration that
                                decided the outcome; null when nothing is
                                declared.
                            declared_status:
                              anyOf:
                                - type: string
                                  enum:
                                    - enabled
                                    - disabled
                                    - not_via_seam
                                - type: 'null'
                              description: >-
                                The deciding declaration: `enabled`, `disabled`
                                or `not_via_seam`.
                            observed_status:
                              anyOf:
                                - type: string
                                  enum:
                                    - active
                                    - trace
                                    - none
                                    - unknown
                                - type: 'null'
                              description: >-
                                What the nightly usage sync observed at that
                                scope; informational only.
                            note:
                              description: >-
                                Note recorded with the deciding declaration,
                                when any.
                              type:
                                - string
                                - 'null'
                          required:
                            - supported
                            - resolved_level
                            - declared_status
                            - observed_status
                            - note
                          additionalProperties: false
                          description: >-
                            How the support matrix resolved for the requested
                            scope, with the partner's note.
                      required:
                        - partner_id
                        - slug
                        - display_name
                        - website
                        - description_md
                        - is_live
                        - is_featured
                        - legacy_industry_featured
                        - industries
                        - solutions
                        - assets
                        - created_at
                        - updated_at
                        - support
                      additionalProperties: false
                    description: Live partners that support the requested scope.
                  ok:
                    type: boolean
                    const: true
                    description: Always `true` on success.
                required:
                  - partners
                  - ok
                additionalProperties: false
        '400':
          description: Invalid parameters
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  ok:
                    type: boolean
                    const: false
                    description: Always `false` on error.
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                        description: Machine-readable error type.
                      message:
                        type: string
                        description: Human-readable error message.
                      request_id:
                        type: string
                        description: Request ID to include when you contact Seam.
                      data:
                        description: >-
                          Details for some error types, such as validation
                          issues.
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - type
                      - message
                      - request_id
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
        '401':
          description: The key is unknown, revoked or unsupported
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  ok:
                    type: boolean
                    const: false
                    description: Always `false` on error.
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                        description: Machine-readable error type.
                      message:
                        type: string
                        description: Human-readable error message.
                      request_id:
                        type: string
                        description: Request ID to include when you contact Seam.
                      data:
                        description: >-
                          Details for some error types, such as validation
                          issues.
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - type
                      - message
                      - request_id
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
        '403':
          description: >-
            The key does not allow this request, such as an origin that is not
            allowed
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  ok:
                    type: boolean
                    const: false
                    description: Always `false` on error.
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                        description: Machine-readable error type.
                      message:
                        type: string
                        description: Human-readable error message.
                      request_id:
                        type: string
                        description: Request ID to include when you contact Seam.
                      data:
                        description: >-
                          Details for some error types, such as validation
                          issues.
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - type
                      - message
                      - request_id
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
        '429':
          description: Rate limited
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  ok:
                    type: boolean
                    const: false
                    description: Always `false` on error.
                  error:
                    type: object
                    properties:
                      type:
                        type: string
                        description: Machine-readable error type.
                      message:
                        type: string
                        description: Human-readable error message.
                      request_id:
                        type: string
                        description: Request ID to include when you contact Seam.
                      data:
                        description: >-
                          Details for some error types, such as validation
                          issues.
                        type: object
                        propertyNames:
                          type: string
                        additionalProperties: {}
                    required:
                      - type
                      - message
                      - request_id
                    additionalProperties: false
                required:
                  - ok
                  - error
                additionalProperties: false
          headers:
            Retry-After:
              description: Seconds to wait before retrying.
              schema:
                type: integer
      security:
        - {}
        - secret_key: []
        - embed_key: []
        - embed_key_param: []
components:
  securitySchemes:
    secret_key:
      type: http
      scheme: bearer
      bearerFormat: eco_sk_…
      description: >-
        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.
    embed_key:
      type: apiKey
      in: header
      name: X-Embed-Key
      description: >-
        An embed key (`eco_live_…`) for browser requests; the request's `Origin`
        must match one of the key's allowed origins. Optional on most endpoints,
        but `embed/resolve` always needs one, and so does `compatibility` from a
        browser on a site other than seam.co. A manufacturer embed key implies
        its manufacturer.
    embed_key_param:
      type: apiKey
      in: query
      name: embed_key
      description: >-
        An embed key sent as the `embed_key` query parameter instead of the
        `X-Embed-Key` header.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.