> ## 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 all subscription status definitions

> アカウントから配信登録ステータス定義のリストを取得します。

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="STARTER" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'communication_preferences.read',
  'communication_preferences.read_write'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/2026-03/communication-preferences-subscriptions-v2026-03.json GET /communication-preferences/2026-03/definitions
openapi: 3.0.1
info:
  title: Communication Preferences Subscriptions
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: STARTER
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Batch
  - name: Definitions
  - name: Status
paths:
  /communication-preferences/2026-03/definitions:
    get:
      tags:
        - Definitions
      summary: 全ての配信登録ステータス定義を取得
      description: アカウントから配信登録ステータス定義のリストを取得します。
      operationId: get-/communication-preferences/2026-03/definitions
      parameters:
        - name: businessUnitId
          in: query
          description: 配信登録定義を取得するビジネスユニットのIDを表す整数。
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int64
        - name: includeTranslations
          in: query
          description: レスポンスにコミュニケーション設定定義の翻訳を含めるかどうかを示すブール値。
          required: false
          style: form
          explode: true
          schema:
            type: boolean
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/ActionResponseWithResultsSubscriptionDefinition
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - communication_preferences.read_write
        - oauth2:
            - communication_preferences.read
components:
  schemas:
    ActionResponseWithResultsSubscriptionDefinition:
      required:
        - completedAt
        - results
        - startedAt
        - status
      type: object
      properties:
        completedAt:
          type: string
          description: 処理が完了した日時。
          format: date-time
        errors:
          type: array
          description: 処理中に発生したエラーの配列。
          items:
            $ref: '#/components/schemas/StandardError'
        links:
          type: object
          additionalProperties:
            type: string
          description: 処理に関連付けられた関連リンクのコレクション。
        numErrors:
          type: integer
          description: 処理中に発生したエラーの数。
          format: int32
        requestedAt:
          type: string
          description: 処理がリクエストされた日時。
          format: date-time
        results:
          type: array
          description: 処理の結果が格納される配列。
          items:
            $ref: '#/components/schemas/SubscriptionDefinition'
        startedAt:
          type: string
          description: 処理が開始された日時。
          format: date-time
        status:
          type: string
          description: 処理の現在のステータス（PENDING、PROCESSING、CANCELED、COMPLETEを取り得る）。
          enum:
            - CANCELED
            - COMPLETE
            - PENDING
            - PROCESSING
    StandardError:
      required:
        - category
        - context
        - errors
        - links
        - message
        - status
      type: object
      properties:
        category:
          type: string
          description: エラーの種類を分類する文字列。
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: エラー条件に関する追加の背景情報を含むオブジェクト。キーは背景情報名、値は文字列の配列です。
        errors:
          type: array
          description: エラーに関する詳細情報を提供するErrorDetailの配列。
          items:
            $ref: '#/components/schemas/ErrorDetail'
        id:
          type: string
          description: エラーの一意の識別子を表す文字列。
        links:
          type: object
          additionalProperties:
            type: string
          description: エラーまたは推奨の修正手順に関するドキュメントを含む、リンク名と関連付けられたURIを対応付けるオブジェクト。
        message:
          type: string
          description: エラーを説明する人間が判読可能なメッセージを含む文字列。
        status:
          type: string
          description: エラーのステータスを示す文字列。
        subCategory:
          type: object
          properties: {}
          description: エラーのより具体的な分類を提供するオブジェクト。
      description: Ye olde error
    SubscriptionDefinition:
      required:
        - createdAt
        - description
        - id
        - isActive
        - isDefault
        - isInternal
        - name
        - updatedAt
      type: object
      properties:
        businessUnitId:
          type: integer
          description: 配信登録に関連付けられたビジネスユニットのID。
          format: int64
        communicationMethod:
          type: string
          description: 配信登録のコミュニケーション方法。
        createdAt:
          type: string
          description: 配信登録が作成された日時。
          format: date-time
        description:
          type: string
          description: 配信登録の説明。
        id:
          type: string
          description: 配信登録の固有ID。
        isActive:
          type: boolean
          description: 配信登録が有効かどうかを示します。
        isDefault:
          type: boolean
          description: 配信登録がデフォルトのオプションかどうかを示します。
        isInternal:
          type: boolean
          description: 配信登録が内部向けかどうかを示します。
        name:
          type: string
          description: 配信登録の名前。
        purpose:
          type: string
          description: 配信登録の目的。
        subscriptionTranslations:
          type: array
          description: 配信登録に関連付けられた翻訳のリスト。
          items:
            $ref: '#/components/schemas/PublicSubscriptionTranslation'
        updatedAt:
          type: string
          description: 配信登録が最後に更新された日時。
          format: date-time
    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: エラーに関する具体的な詳細が含まれる特定のカテゴリー
    PublicSubscriptionTranslation:
      required:
        - createdAt
        - description
        - languageCode
        - name
        - subscriptionId
        - updatedAt
      type: object
      properties:
        createdAt:
          type: integer
          description: 配信登録の翻訳が作成されたタイミングを示すタイムスタンプ。
          format: int64
        description:
          type: string
          description: 配信登録の翻訳のテキスト説明。
        languageCode:
          type: string
          description: 配信登録の翻訳の言語を表すコード。
        name:
          type: string
          description: 配信登録の翻訳の名前。
        subscriptionId:
          type: integer
          description: 翻訳と関連付けられた配信登録の固有ID。
          format: int64
        updatedAt:
          type: integer
          description: 配信登録の翻訳が最後に更新されたタイミングを示すタイムスタンプ。
          format: int64
  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:
            communication_preferences.read_write: ''
            communication_preferences.statuses.batch.read: ''
            communication_preferences.statuses.batch.write: ''

````