> ## 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 a Provider

> Returns one published provider by `slug` or `provider_id`, with its integrations (support level and capability flags per feature), industries, manufacturers and logos.



## OpenAPI

````yaml device-manufacturer-guidance/manufacturer-api/openapi.json GET /providers/get
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:
  /providers/get:
    get:
      tags:
        - providers
      summary: Get a provider
      description: >-
        Returns one published provider by `slug` or `provider_id`, with its
        integrations (support level and capability flags per feature),
        industries, manufacturers and logos.
      parameters:
        - name: slug
          in: query
          required: false
          schema:
            description: Provider slug; provide this or `provider_id`.
            type: string
        - name: provider_id
          in: query
          required: false
          schema:
            description: Provider UUID; provide this or `slug`.
            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)$
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $schema: https://json-schema.org/draft/2020-12/schema
                type: object
                properties:
                  provider:
                    type: object
                    properties:
                      provider_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 provider.
                      slug:
                        type: string
                        description: Stable identifier, e.g. `salto-ks`.
                      display_name:
                        description: Display name.
                        type:
                          - string
                          - 'null'
                      description_md:
                        description: Description in markdown, when recorded.
                        type:
                          - string
                          - 'null'
                      is_acs:
                        description: >-
                          Access control system provider; null where not
                          established.
                        type:
                          - boolean
                          - 'null'
                      has_requirements:
                        description: >-
                          Whether integration requirements apply; null where not
                          established.
                        type:
                          - boolean
                          - 'null'
                      requirements_md:
                        description: >-
                          Free-text integration requirements, verbatim from the
                          source.
                        type:
                          - string
                          - 'null'
                      logos:
                        type: array
                        items:
                          type: object
                          properties:
                            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
                                - default_device_image
                                - featured
                                - variant_image
                              description: >-
                                Asset role: a logo kind, a manufacturer default
                                device image, a model featured image, or a
                                variant image.
                            object_key:
                              type: string
                              description: Immutable object-storage key.
                            url:
                              type: string
                              description: Public URL of the original image.
                            mime:
                              description: Media type, when known.
                              type:
                                - string
                                - 'null'
                            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.
                            bytes:
                              anyOf:
                                - type: integer
                                  minimum: -9007199254740991
                                  maximum: 9007199254740991
                                - type: 'null'
                              description: Size in bytes, when known.
                            sha256:
                              description: SHA-256 of the original bytes, when recorded.
                              type:
                                - string
                                - 'null'
                            sort_order:
                              type: integer
                              minimum: -9007199254740991
                              maximum: 9007199254740991
                              description: Ordering within the owning version's assets.
                            formats:
                              type: object
                              propertyNames:
                                type: string
                                enum:
                                  - thumbnail
                                  - small
                                  - medium
                                  - large
                              additionalProperties:
                                type: object
                                properties:
                                  object_key:
                                    type: string
                                    description: >-
                                      Immutable object-storage key of this
                                      format.
                                  url:
                                    type: string
                                    description: Public URL of this format.
                                  mime:
                                    description: Media type, when known.
                                    type:
                                      - string
                                      - 'null'
                                  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.
                                  bytes:
                                    anyOf:
                                      - type: integer
                                        minimum: -9007199254740991
                                        maximum: 9007199254740991
                                      - type: 'null'
                                    description: Size in bytes, when known.
                                  sha256:
                                    description: >-
                                      SHA-256 of this format's bytes, when
                                      recorded.
                                    type:
                                      - string
                                      - 'null'
                                required:
                                  - object_key
                                  - url
                                  - mime
                                  - width
                                  - height
                                  - bytes
                                  - sha256
                                additionalProperties: false
                              description: >-
                                Derived image formats actually present in the
                                source; an empty object means the source held
                                none (e.g. SVG logos).
                            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).
                          required:
                            - asset_id
                            - kind
                            - object_key
                            - url
                            - mime
                            - width
                            - height
                            - bytes
                            - sha256
                            - sort_order
                            - formats
                            - created_at
                            - updated_at
                          additionalProperties: false
                        description: Square logos in color and monochrome variants.
                      integrations:
                        type: array
                        items:
                          type: object
                          properties:
                            provider_integration_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 integration.
                            kind:
                              type: string
                              enum:
                                - access
                                - climate
                                - sensor
                              description: >-
                                Integration kind: `access`, `climate`, or
                                `sensor`.
                            feature:
                              type: string
                              description: >-
                                Integration feature, e.g. `lock_unlock` or
                                `hvac`.
                            integration_support_level:
                              anyOf:
                                - type: string
                                  enum:
                                    - inquire
                                    - unavailable
                                    - planned
                                    - in-progress
                                    - beta
                                    - stable
                                - type: 'null'
                              description: >-
                                Support level for this feature; null where the
                                source has none.
                            flags:
                              type: object
                              propertyNames:
                                type: string
                              additionalProperties:
                                type:
                                  - boolean
                                  - 'null'
                              description: >-
                                Per-feature capability flags exactly as
                                authored; null means not established by
                                research.
                            extra_info:
                              anyOf:
                                - 9cd736b6-42ea-4e3f-9b02-e712b78d9821
                                - type: 'null'
                              description: >-
                                Additional integration data verbatim from the
                                source.
                          required:
                            - provider_integration_id
                            - kind
                            - feature
                            - integration_support_level
                            - flags
                            - extra_info
                          additionalProperties: false
                        description: >-
                          One entry per integration feature with its support
                          level and flags.
                      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 this provider serves.
                      manufacturers:
                        type: array
                        items:
                          type: object
                          properties:
                            manufacturer_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 manufacturer.
                            slug:
                              type: string
                              description: Stable identifier, e.g. `schlage`.
                            display_name:
                              description: Display name.
                              type:
                                - string
                                - 'null'
                          required:
                            - manufacturer_id
                            - slug
                            - display_name
                          additionalProperties: false
                        description: >-
                          Manufacturers whose devices this provider integrates
                          with.
                      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).
                    required:
                      - provider_id
                      - slug
                      - display_name
                      - description_md
                      - is_acs
                      - has_requirements
                      - requirements_md
                      - logos
                      - integrations
                      - industries
                      - manufacturers
                      - created_at
                      - updated_at
                    additionalProperties: false
                    description: The published provider.
                  ok:
                    type: boolean
                    const: true
                    description: Always `true` on success.
                required:
                  - provider
                  - ok
                additionalProperties: false
                $defs:
                  __schema0:
                    anyOf:
                      - type: string
                      - type: number
                      - type: boolean
                      - type: 'null'
                      - type: array
                        items:
                          $ref: >-
                            #/paths/~1providers~1get/get/responses/200/content/application~1json/schema/$defs/__schema0
                      - type: object
                        propertyNames:
                          type: string
                        additionalProperties:
                          $ref: >-
                            #/paths/~1providers~1get/get/responses/200/content/application~1json/schema/$defs/__schema0
        '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.