> ## 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.

# Retrieve a mapping

> Obtenha um mapeamento de URL específico usando seu identificador exclusivo. Este endpoint é útil para obter detalhes sobre uma configuração de mapeamento de URL específica em sua conta HubSpot. Ele exige o ID do mapeamento de URL como um parâmetro de caminho.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-03/cms-url-mappings-v2026-03.json GET /url-mappings/2026-03/url-mappings/{id}
openapi: 3.0.1
info:
  title: Mapeamentos de URL
  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: Basic
paths:
  /url-mappings/2026-03/url-mappings/{id}:
    get:
      tags:
        - Basic
      summary: Recuperar mapeamento de URL
      description: >-
        Obtenha um mapeamento de URL específico usando seu identificador
        exclusivo. Este endpoint é útil para obter detalhes sobre uma
        configuração de mapeamento de URL específica em sua conta HubSpot. Ele
        exige o ID do mapeamento de URL como um parâmetro de caminho.
      operationId: >-
        get-/url-mappings/2026-03/url-mappings/{id}_/url-mappings/v3/url-mappings/{id}
      parameters:
        - name: id
          in: path
          description: >-
            O identificador exclusivo do mapeamento de URL a ser recuperado.
            Deve ser um número inteiro.
          required: true
          style: simple
          explode: false
          schema:
            pattern: \d+
            type: integer
            format: int64
      responses:
        '200':
          description: successful operation
          content:
            '*/*':
              schema:
                $ref: '#/components/schemas/UrlMapping'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - content
components:
  schemas:
    UrlMapping:
      required:
        - cdnPurgeEmbargoTime
        - contentGroupId
        - cosObjectType
        - created
        - createdById
        - deletedAt
        - destination
        - id
        - internallyCreated
        - isActive
        - isMatchFullUrl
        - isMatchQueryString
        - isOnlyAfterNotFound
        - isPattern
        - isProtocolAgnostic
        - isRegex
        - isTrailingSlashOptional
        - label
        - lastUsedAt
        - name
        - note
        - portalId
        - precedence
        - redirectStyle
        - routePrefix
        - updated
        - updatedById
      type: object
      properties:
        cdnPurgeEmbargoTime:
          type: integer
          description: >-
            Uma data/hora Unix em milissegundos indicando o tempo de embargo
            para a limpeza de CDN relacionada ao mapeamento de URL.
          format: int64
        contentGroupId:
          type: integer
          description: >-
            Um número inteiro de 64 bits que representa o grupo de conteúdo
            associado ao mapeamento de URL.
          format: int64
        cosObjectType:
          type: string
          description: >-
            Uma string que representa o tipo de objeto de conteúdo associado ao
            mapeamento de URL. Os valores válidos incluem vários tipos de
            conteúdo, como "CONTENT", "LAYOUT", "FILE" etc.
          enum:
            - ACCESS_GROUP_MEMBERSHIP
            - APP_PAGE
            - BLOCK
            - BLOG
            - BLOG_AUTHOR
            - BRAND_BUSINESS_UNIT
            - BRAND_SETTINGS
            - CONTACT_MEMBERSHIP
            - CONTENT
            - CONTENT_EMBED
            - CONTENT_FOLDER
            - CONTENT_GROUP
            - CRM_OBJECT
            - CRM_OBJECT_TYPE
            - CUSTOM_WIDGET
            - CUSTOMER_PORTAL
            - DATA_QUERY
            - DESIGN_FOLDER
            - DOMAIN
            - DOMAIN_SETTINGS
            - EMAIL_ADDRESS
            - EXTENSION_RESOURCE
            - FILE
            - FOLDER
            - FOLLOW_ME
            - FORM
            - GLOBAL_CONTENT
            - GLOBAL_STYLES_THEME
            - HUBDB_TABLE
            - HUBDB_TABLE_ROW
            - IMAGE
            - JS_PROJECT_COMPONENT
            - KNOWLEDGE_BASE
            - KNOWLEDGE_CATEGORY
            - KNOWLEDGE_CATEGORY_TRANSLATION
            - KNOWLEDGE_HOMEPAGE_CATEGORY
            - LAYOUT
            - LAYOUT_SECTION
            - LIST_MEMBERSHIP
            - MARKETPLACE_LISTING
            - PASSWORD_PROTECTED
            - PAYMENT
            - PERSONALIZATION_TOKEN
            - PLACEMENT
            - PROJECT
            - QUOTE_TEMPLATE
            - RAW_ASSET
            - REDIRECT_URL
            - SECTION
            - SERVERLESS_FUNCTION
            - SITE_MAP
            - SITE_MENU
            - SITE_SETTINGS
            - SUBSCRIPTIONS_SETTINGS
            - TAG
            - THEME
            - THEME_SETTINGS
            - UNRESTRICTED_ACCESS
            - URL_MAPPING
            - VIDEO_PLAYER
            - WIDGET
            - WORKFLOW
        created:
          type: integer
          description: >-
            A data/hora Unix em milissegundos indicando quando o mapeamento de
            URL foi criado.
          format: int64
        createdById:
          type: integer
          description: O identificador do usuário que criou o mapeamento de URL.
          format: int32
        deletedAt:
          type: integer
          description: >-
            A data/hora Unix em milissegundos indicando quando o mapeamento de
            URL foi excluído.
          format: int64
        destination:
          type: string
          description: O URL de destino para o qual o routePrefix é redirecionado.
        id:
          type: integer
          description: >-
            O identificador exclusivo do mapeamento de URL, representado como um
            número inteiro de 64 bits.
          format: int64
        internallyCreated:
          type: boolean
          description: >-
            Um booleano que indica se o mapeamento de URL foi criado
            internamente pelo sistema.
        isActive:
          type: boolean
          description: Um booleano que indica se o mapeamento de URL está ativo no momento.
        isMatchFullUrl:
          type: boolean
          description: Um booleano que indica se o URL completo deve ser correspondido.
        isMatchQueryString:
          type: boolean
          description: >-
            Um booleano que indica se a string de consulta deve ser
            correspondida.
        isOnlyAfterNotFound:
          type: boolean
          description: >-
            Um booleano que indica se o mapeamento deve ser aplicado somente
            após uma resposta "404 Não encontrado".
        isPattern:
          type: boolean
          description: Um booleano que indica se o routePrefix é um padrão.
        isProtocolAgnostic:
          type: boolean
          description: >-
            Um booleano que indica se o mapeamento deve ignorar o protocolo de
            URL (http/https).
        isRegex:
          type: boolean
          description: >-
            Um booleano que indica se o routePrefix deve ser tratado como uma
            expressão regular.
        isTrailingSlashOptional:
          type: boolean
          description: Um booleano que indica se a barra final no URL é opcional.
        label:
          type: string
          description: Um rótulo para o mapeamento de URL.
        lastUsedAt:
          type: integer
          description: >-
            Uma data/hora Unix em milissegundos indicando a última vez que o
            mapeamento de URL foi usado.
          format: int64
        name:
          type: string
          description: O nome do mapeamento de URL.
        note:
          type: string
          description: Uma string que contém observações sobre o mapeamento de URL.
        portalId:
          type: integer
          description: >-
            O identificador do portal HubSpot associado a este mapeamento de
            URL.
          format: int32
        precedence:
          type: integer
          description: >-
            Um número inteiro que representa a precedência do mapeamento de URL,
            usado para determinar a ordem de avaliação.
          format: int32
        redirectStyle:
          type: integer
          description: Um número inteiro que representa o estilo de redirecionamento usado.
          format: int32
        routePrefix:
          type: string
          description: O prefixo do caminho da URL que está sendo mapeado.
        updated:
          type: integer
          description: >-
            A data/hora Unix em milissegundos indicando quando o mapeamento de
            URL foi atualizado pela última vez.
          format: int64
        updatedById:
          type: integer
          description: >-
            O identificador do usuário que atualizou o mapeamento de URL 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
    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.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            content: ''

````