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

# Retrieve mappings

> HubSpotアカウントからURLマッピングのリストを取得します。このエンドポイントは、HubSpot CMS内でURLを管理およびリダイレクトするために使用できるURLマッピング設定へのアクセスを提供します。コンテンツ管理設定でURLがどのように構成され、リダイレクトされるかを理解するのに役立ちます。

export const ScopesList = ({scopes = [], description = "この API には、次のいずれかのスコープが必要です。"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, marketingLevel, salesLevel, serviceLevel, cmsLevel}) => {
  const translations = {
    header: "サポートされる製品",
    description: "次のいずれかの製品またはそれ以上が必要です。",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub"
    },
    tiers: {
      free: "無料ツール",
      starter: "Starter",
      professional: "Professional",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="FREE" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'content'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/2026-03/cms-url-mappings-v2026-03.json GET /url-mappings/2026-03/url-mappings
openapi: 3.0.1
info:
  title: 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:
    get:
      tags:
        - Basic
      summary: URLマッピングを一覧表示
      description: >-
        HubSpotアカウントからURLマッピングのリストを取得します。このエンドポイントは、HubSpot
        CMS内でURLを管理およびリダイレクトするために使用できるURLマッピング設定へのアクセスを提供します。コンテンツ管理設定でURLがどのように構成され、リダイレクトされるかを理解するのに役立ちます。
      operationId: get-/url-mappings/2026-03/url-mappings_/url-mappings/v3/url-mappings
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            '*/*':
              schema:
                type: array
                items:
                  $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: URLマッピングに関連するCDN消去の禁止時間を示すミリ秒単位のUnixタイムスタンプ。
          format: int64
        contentGroupId:
          type: integer
          description: URLマッピングに関連付けられたコンテンツグループを表す64ビットの整数。
          format: int64
        cosObjectType:
          type: string
          description: >-
            URLマッピングに関連付けられているコンテンツオブジェクトのタイプを表す文字列。有効な値には、「CONTENT」、「LAYOUT」、「FILE」などのさまざまなコンテンツタイプが含まれます。
          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: URLマッピングが作成された日時を示すミリ秒単位のUnixタイムスタンプ。
          format: int64
        createdById:
          type: integer
          description: URLマッピングを作成したユーザーのID。
          format: int32
        deletedAt:
          type: integer
          description: URLマッピングが削除された日時を示すミリ秒単位のUnixタイムスタンプ。
          format: int64
        destination:
          type: string
          description: routePrefixのリダイレクト先となるURL。
        id:
          type: integer
          description: URLマッピングの固有IDで、64ビットの整数として表されます。
          format: int64
        internallyCreated:
          type: boolean
          description: URLマッピングがシステムによって内部で作成されたかどうかを示すブール値。
        isActive:
          type: boolean
          description: URLマッピングが現在有効であるかどうかを示すブール値。
        isMatchFullUrl:
          type: boolean
          description: URLが完全一致する必要があるかどうかを示すブール値。
        isMatchQueryString:
          type: boolean
          description: クエリー文字列が一致する必要があるかどうかを示すブール値。
        isOnlyAfterNotFound:
          type: boolean
          description: マッピングを「404 Not Found」レスポンスの後にのみ適用するかどうかを示すブール値。
        isPattern:
          type: boolean
          description: routePrefixがパターンであるかどうかを示すブール値。
        isProtocolAgnostic:
          type: boolean
          description: マッピングでURLプロトコル (http/https) を無視するかどうかを示すブール値。
        isRegex:
          type: boolean
          description: routePrefixを正規表現として扱うかどうかを示すブール値。
        isTrailingSlashOptional:
          type: boolean
          description: URLの末尾のスラッシュが任意であるかどうかを示すブール値。
        label:
          type: string
          description: URLマッピングのラベル。
        lastUsedAt:
          type: integer
          format: int64
        name:
          type: string
          description: URLマッピングの名前。
        note:
          type: string
          description: URLマッピングに関するメモが含まれる文字列。
        portalId:
          type: integer
          description: このURLマッピングに関連付けられているHubSpotポータルのID。
          format: int32
        precedence:
          type: integer
          description: URLマッピングの優先順位を表す整数。評価順序の決定に使用されます。
          format: int32
        redirectStyle:
          type: integer
          description: 使用されるリダイレクトのスタイルを表す整数。
          format: int32
        routePrefix:
          type: string
          description: 対応付けられるURLパスの先頭文字列。
        updated:
          type: integer
          description: URLマッピングが最後に更新された日時を示すミリ秒単位のUnixタイムスタンプ。
          format: int64
        updatedById:
          type: integer
          description: URLマッピングを最後に更新したユーザーのID。
          format: int32
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: エラーカテゴリー
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: エラー条件に関する背景状況
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: リクエストの固有ID。エラー報告またはサポートチケットには必ずこの値を含めてください
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: エラーに関する詳細情報
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: エラーまたは推奨の修正手順に関するドキュメントが含まれる関連付けられたURIへのリンク名の対応付け
        message:
          type: string
          description: エラーと修正手順（該当する場合）を記した、人が理解できるメッセージ
          example: An error occurred
        subCategory:
          type: string
          description: エラーに関する具体的な詳細が含まれる特定のカテゴリー
      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: エラーの詳細に関連付けられているステータスコード
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: エラー条件に関する背景状況
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: エラーが見つかったフィールドまたはパラメーターの名前。
        message:
          type: string
          description: エラーと修正手順（該当する場合）を記した、人が理解できるメッセージ
        subCategory:
          type: string
          description: エラーに関する具体的な詳細が含まれる特定のカテゴリー
  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:
            cms-url-redirects-delete: ''
            content: ''

````