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

# Get all schemas 

> Recupere os esquemas associados a um aplicativo específico na conta HubSpot. Este endpoint permite obter os detalhes dos esquemas, o que pode ser útil para compreender a estrutura de dados e as propriedades associadas ao aplicativo. Opcionalmente, você pode filtrar os resultados para incluir apenas os esquemas arquivados.

> **Supported products**


## OpenAPI

````yaml specs/2026-03/cms-media-bridge-v2026-03.json GET /media-bridge/2026-03/{appId}/schemas
openapi: 3.0.1
info:
  title: CMS Media Bridge
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
  - name: Batch
paths:
  /media-bridge/2026-03/{appId}/schemas:
    get:
      tags:
        - Basic
      summary: Recuperar esquemas
      description: >-
        Recupere os esquemas associados a um aplicativo específico na conta
        HubSpot. Este endpoint permite obter os detalhes dos esquemas, o que
        pode ser útil para compreender a estrutura de dados e as propriedades
        associadas ao aplicativo. Opcionalmente, você pode filtrar os resultados
        para incluir apenas os esquemas arquivados.
      operationId: get-/media-bridge/2026-03/{appId}/schemas
      parameters:
        - name: appId
          in: path
          description: >-
            O identificador exclusivo do aplicativo para o qual os esquemas são
            recuperados
          required: true
          style: simple
          explode: false
          schema:
            type: integer
            format: int32
        - name: archived
          in: query
          description: Se apenas os resultados que foram arquivados devem ser retornados.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: false
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseObjectSchemaNoPaging'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - developer_hapikey: []
components:
  schemas:
    CollectionResponseObjectSchemaNoPaging:
      required:
        - results
      type: object
      properties:
        results:
          type: array
          description: >-
            Uma matriz de esquemas de objeto incluída na resposta. Cada item na
            matriz é um esquema de objeto.
          items:
            $ref: '#/components/schemas/ObjectSchema'
    ObjectSchema:
      required:
        - allowsSensitiveProperties
        - archived
        - associations
        - fullyQualifiedName
        - id
        - labels
        - name
        - objectTypeId
        - properties
        - requiredProperties
        - searchableProperties
        - secondaryDisplayProperties
      type: object
      properties:
        allowsSensitiveProperties:
          type: boolean
          description: >-
            Um valor booleano que indica se o objeto permite propriedades
            confidenciais.
        archived:
          type: boolean
          description: Um booleano que indica se o objeto está arquivado.
        associations:
          type: array
          description: >-
            Uma referência às associações do objeto, que são definidas em outro
            lugar no esquema.
          items:
            $ref: '#/components/schemas/AssociationDefinition'
        createdAt:
          type: string
          description: >-
            Uma string no formato de data e hora que indica quando o objeto foi
            criado.
          format: date-time
        createdByUserId:
          type: integer
          description: Uma string que representa o ID do usuário que criou o objeto.
          format: int32
        description:
          type: string
          description: Uma string que fornece uma descrição do objeto.
        fullyQualifiedName:
          type: string
          description: Uma string que representa o nome totalmente qualificado do objeto.
        id:
          type: string
          description: Uma string que representa o identificador exclusivo do objeto.
        labels:
          $ref: '#/components/schemas/ObjectTypeDefinitionLabels'
        name:
          type: string
          description: Uma string que representa o nome do objeto.
        objectTypeId:
          type: string
          description: Uma string que representa o identificador de tipo do objeto.
        primaryDisplayProperty:
          type: string
          description: >-
            Uma string que representa a propriedade principal usada para exibir
            o objeto.
        properties:
          type: array
          description: >-
            Uma referência às propriedades do objeto, que são definidas em outro
            lugar no esquema.
          items:
            $ref: '#/components/schemas/Property_1'
        requiredProperties:
          type: array
          description: >-
            Uma matriz de strings que representam as propriedades necessárias
            para o objeto.
          items:
            type: string
        searchableProperties:
          type: array
          description: >-
            Uma matriz de strings que indica quais propriedades do objeto são
            pesquisáveis.
          items:
            type: string
        secondaryDisplayProperties:
          type: array
          description: >-
            Uma matriz de strings que representam propriedades adicionais usadas
            para exibir o objeto.
          items:
            type: string
        updatedAt:
          type: string
          description: >-
            Uma string no formato de data e hora que indica quando o objeto foi
            atualizado pela última vez.
          format: date-time
        updatedByUserId:
          type: integer
          description: >-
            Uma string que representa o ID do usuário que atualizou o objeto
            pela última vez.
          format: int32
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            relatórios de erro ou tickets de suporte
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: mais informações sobre o erro
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou as etapas de correção recomendadas
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    AssociationDefinition:
      required:
        - fromObjectTypeId
        - id
        - toObjectTypeId
      type: object
      properties:
        createdAt:
          type: string
          description: >-
            A data e hora em que esta definição de associação foi criada, no
            formato ISO 8601.
          format: date-time
        fromObjectTypeId:
          type: string
          description: >-
            O identificador exclusivo do tipo de objeto do qual a associação se
            origina.
        id:
          type: string
          description: O identificador exclusivo desta definição de associação.
        name:
          type: string
          description: O nome da associação, que serve como um identificador legível.
        toObjectTypeId:
          type: string
          description: >-
            O identificador exclusivo do tipo de objeto para o qual a associação
            aponta.
        updatedAt:
          type: string
          description: >-
            A data e hora em que esta definição de associação foi atualizada
            pela última vez, no formato ISO 8601.
          format: date-time
      description: The definition of an association
    ObjectTypeDefinitionLabels:
      type: object
      properties:
        plural:
          type: string
          description: >-
            O rótulo no plural para o tipo de objeto, usado para representar
            várias instâncias do objeto. É uma string.
        singular:
          type: string
          description: >-
            O rótulo no singular para o tipo de objeto, usado para representar
            uma única instância do objeto. É uma string.
    Property_1:
      required:
        - description
        - fieldType
        - groupName
        - label
        - name
        - options
        - type
      type: object
      properties:
        archived:
          type: boolean
          description: Um booleano que indica se a propriedade está arquivada.
        archivedAt:
          type: string
          description: >-
            A data e hora em que a propriedade foi arquivada, no formato ISO
            8601.
          format: date-time
        calculated:
          type: boolean
          description: Um valor booleano que indica se a propriedade é calculada.
        calculationFormula:
          type: string
          description: A fórmula usada para calcular o valor da propriedade, se aplicável.
        createdAt:
          type: string
          description: >-
            A data e a hora em que a propriedade foi criada, no formato ISO
            8601.
          format: date-time
        createdUserId:
          type: string
          description: O ID do usuário que criou a propriedade.
        currencyPropertyName:
          type: string
          description: O nome da propriedade de moeda associada a esta propriedade.
        dataSensitivity:
          type: string
          description: O nível de sensibilidade dos dados contidos na propriedade.
          enum:
            - highly_sensitive
            - non_sensitive
            - sensitive
        dateDisplayHint:
          type: string
          description: Uma dica para exibir propriedades de data.
          enum:
            - absolute
            - absolute_with_relative
            - time_since
            - time_until
        description:
          type: string
          description: Uma descrição da propriedade.
        displayOrder:
          type: integer
          description: Um número inteiro que indica a ordem de exibição da propriedade.
          format: int32
        externalOptions:
          type: boolean
          description: >-
            Um valor booleano que indica se as opções da propriedade são
            externas.
        fieldType:
          type: string
          description: >-
            O tipo de campo da propriedade, que pode ser um de
            'booleancheckbox', 'calculation_equation', 'checkbox', 'date',
            'file', 'html', 'number', 'phonenumber', 'radio', 'select', 'text'
            ou 'textarea'.
        formField:
          type: boolean
          description: Um booleano que indica se a propriedade é um campo de formulário.
        groupName:
          type: string
          description: O nome do grupo ao qual a propriedade pertence.
        hasUniqueValue:
          type: boolean
          description: Um valor booleano que indica se o valor da propriedade é exclusivo.
        hidden:
          type: boolean
          description: Um booleano que indica se a propriedade está oculta.
        hubspotDefined:
          type: boolean
          description: >-
            Um valor booleano que indica se a propriedade é definida pela
            HubSpot.
        label:
          type: string
          description: O rótulo de exibição da propriedade.
        modificationMetadata:
          $ref: '#/components/schemas/PropertyModificationMetadata'
        name:
          type: string
          description: O nome exclusivo da propriedade.
        numberDisplayHint:
          type: string
          description: >-
            Uma dica para exibir propriedades numéricas, que pode ser
            "unformatted", "formatted", "currency", "percentage", "duration" ou
            "probability".
          enum:
            - currency
            - duration
            - formatted
            - percentage
            - probability
            - unformatted
        options:
          type: array
          description: >-
            Uma matriz de opções disponíveis para a propriedade, aplicável se o
            tipo de propriedade for "enumeração".
          items:
            $ref: '#/components/schemas/Option_1'
        referencedObjectType:
          type: string
          description: O tipo de objeto que a propriedade referencia, se aplicável.
        sensitiveDataCategories:
          type: array
          description: Categorias de dados sensíveis associados à propriedade.
          items:
            type: string
        showCurrencySymbol:
          type: boolean
          description: >-
            Um booleano que indica se o símbolo da moeda deve ser exibido para a
            propriedade.
        textDisplayHint:
          type: string
          description: >-
            Uma dica para exibir propriedades de texto, que pode ser
            "unformatted_single_line", "multi_line", "email", "phone_number",
            "domain_name", "ip_address", "physical_address" ou "postal_code".
          enum:
            - domain_name
            - email
            - ip_address
            - multi_line
            - phone_number
            - physical_address
            - postal_code
            - unformatted_single_line
        type:
          type: string
          description: >-
            O tipo de dados da propriedade, como 'bool', 'date', 'datetime',
            'enumeration', 'number', 'phone_number' ou 'string'.
        updatedAt:
          type: string
          description: >-
            A data e a hora da última atualização da propriedade, no formato ISO
            8601.
          format: date-time
        updatedUserId:
          type: string
          description: O ID do usuário que atualizou a propriedade pela última vez.
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: O código de status associado ao detalhe do erro
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexto sobre a condição do erro
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: O nome do campo ou parâmetro no qual o erro foi encontrado.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém mais detalhes específicos sobre
            o erro
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
    PropertyModificationMetadata:
      required:
        - archivable
        - readOnlyDefinition
        - readOnlyValue
      type: object
      properties:
        archivable:
          type: boolean
          description: Um booleano que indica se a propriedade pode ser arquivada.
        readOnlyDefinition:
          type: boolean
          description: >-
            Um valor booleano que indica se a definição da propriedade é somente
            leitura, o que significa que não pode ser modificada.
        readOnlyOptions:
          type: boolean
          description: >-
            Um valor booleano que indica se as opções da propriedade são somente
            leitura.
        readOnlyValue:
          type: boolean
          description: >-
            Um valor booleano que indica se o valor da propriedade é somente
            leitura, o que significa que não pode ser alterado.
    Option_1:
      required:
        - hidden
        - label
        - value
      type: object
      properties:
        description:
          type: string
          description: Uma string que fornece informações adicionais sobre a opção.
        displayOrder:
          type: integer
          description: >-
            Um número inteiro que indica a ordem em que a opção deve ser exibida
            em relação a outras opções.
          format: int32
        hidden:
          type: boolean
          description: Um booleano que indica se a opção está oculta da exibição.
        label:
          type: string
          description: Uma string que representa o rótulo de exibição para a opção.
        value:
          type: string
          description: Uma string que representa o valor atribuído à opção.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    developer_hapikey:
      type: apiKey
      name: hapikey
      in: query

````