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

# Read

> 「{dealId}」によって特定されるオブジェクトを読み取ります。「{dealId}」はデフォルトで内部オブジェクトIDを参照しますが、「idProperty」クエリーパラメーターによって指定することで、必要に応じて任意の固有のプロパティー値を参照できます。「properties」クエリーパラメーターを使用して返される内容を制御します。

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={[
  'crm.objects.deals.read'
]}
    />
  </Accordion>
</AccordionGroup>


## OpenAPI

````yaml specs/legacy/v3/crm-deals-v3.json GET /crm/v3/objects/0-3/{dealId}
openapi: 3.0.1
info:
  title: 取引
  description: >-
    CRM objects such as companies, contacts, deals, line items, products,
    tickets, and quotes are standard objects in HubSpot’s CRM. These core
    building blocks support custom properties, store critical information, and
    play a central role in the HubSpot application.


    ## Supported Object Types


    This API provides access to collections of CRM objects, which return a map
    of property names to values. Each object type has its own set of default
    properties, which can be found by exploring the [CRM Object Properties
    API](https://developers.hubspot.com/docs/methods/crm-properties/crm-properties-overview).


    |Object Type |Properties returned by default |

    |--|--|

    | `companies` | `name`, `domain` |

    | `contacts` | `firstname`, `lastname`, `email` |

    | `deals` | `dealname`, `amount`, `closedate`, `pipeline`, `dealstage` |

    | `products` | `name`, `description`, `price` |

    | `tickets` | `content`, `hs_pipeline`, `hs_pipeline_stage`,
    `hs_ticket_category`, `hs_ticket_priority`, `subject` |


    Find a list of all properties for an object type using the [CRM Object
    Properties](https://developers.hubspot.com/docs/methods/crm-properties/get-properties)
    API. e.g. `GET https://api.hubapi.com/properties/v2/companies/properties`.
    Change the properties returned in the response using the `properties` array
    in the request body.
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    営業担当が見込み客への対応を開始するときに、交渉プロセスを追跡する取引レコードを作成します。その後、顧客が購入を行ったら、取引をクローズ済みステージに更新できます。
  x-hubspot-related-documentation:
    - name: Deals Guide
      url: https://developers.hubspot.com/docs/guides/api/crm/objects/deals
  x-hubspot-introduction: >-
    取引APIを使用して、コンタクトや会社とのトランザクションを表すCRMレコードの作成や管理を行います。取引はパイプラインステージを進み、取引が完了したか、現在進行中であるか、失注になったかが反映されます。
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Batch
  - name: Search
paths:
  /crm/v3/objects/0-3/{dealId}:
    get:
      tags:
        - Basic
      summary: 読み取り
      description: >-
        「{dealId}」によって特定されるオブジェクトを読み取ります。「{dealId}」はデフォルトで内部オブジェクトIDを参照しますが、「idProperty」クエリーパラメーターによって指定することで、必要に応じて任意の固有のプロパティー値を参照できます。「properties」クエリーパラメーターを使用して返される内容を制御します。
      operationId: get-/crm/v3/objects/0-3/{dealId}_getById
      parameters:
        - name: dealId
          in: path
          required: true
          schema:
            pattern: .+
            type: string
        - name: archived
          in: query
          description: アーカイブ済みの結果のみを返すかどうか。
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: false
        - name: associations
          in: query
          description: 関連付けられているIDを取得するオブジェクトタイプのカンマ区切りリスト。指定された関連付けが存在しない場合は、無視されます。
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: idProperty
          in: query
          description: このオブジェクトタイプについて値が固有のプロパティーの名前
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: properties
          in: query
          description: >-
            レスポンスで返されるプロパティーのカンマ区切りリスト。指定されたプロパティーがリクエストされたオブジェクトに存在しない場合は、無視されます。
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: propertiesWithHistory
          in: query
          description: >-
            以前の値の履歴と一緒に返されるプロパティーのカンマ区切りリスト。指定されたプロパティーがリクエストされたオブジェクトに存在しない場合は、無視されます。
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/SimplePublicObjectWithAssociations'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.objects.deals.read
components:
  schemas:
    SimplePublicObjectWithAssociations:
      required:
        - archived
        - createdAt
        - id
        - properties
        - updatedAt
      type: object
      properties:
        archived:
          type: boolean
          description: オブジェクトがアーカイブされているかどうか。
        archivedAt:
          type: string
          description: オブジェクトがアーカイブされた時点のタイムスタンプ（ISO 8601形式）。
          format: date-time
        associations:
          type: object
          additionalProperties:
            $ref: '#/components/schemas/CollectionResponseAssociatedId'
          description: 他のオブジェクトとの関係を定義するリスト。
        createdAt:
          type: string
          description: オブジェクトが作成された時点のタイムスタンプ（ISO 8601形式）。
          format: date-time
        id:
          type: string
          description: オブジェクトの固有ID。
        objectWriteTraceId:
          type: string
          description: オブジェクトの作成リクエストまたは更新リクエストをトレースするために使用されるID。
        properties:
          type: object
          additionalProperties:
            type: string
          description: オブジェクトのプロパティーを表す、キーと値のペア。
        propertiesWithHistory:
          type: object
          additionalProperties:
            type: array
            items:
              $ref: '#/components/schemas/ValueWithTimestamp'
          description: オブジェクトのプロパティーとその履歴を表すキーと値のペア。
        updatedAt:
          type: string
          description: オブジェクトが最後に更新された時点のタイムスタンプ（ISO 8601形式）。
          format: date-time
        url:
          type: string
          description: コネクターの対応するUIページに直接移動できるAPIのURL。
        warnings:
          type: array
          items:
            $ref: '#/components/schemas/PublicObjectWarning'
      description: プロパティー、タイムスタンプ、および関連付けタイプ別にグループ化された関連オブジェクトIDのセットを含むCRMオブジェクトを表します。
    CollectionResponseAssociatedId:
      required:
        - results
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          items:
            $ref: '#/components/schemas/AssociatedId'
    ValueWithTimestamp:
      required:
        - sourceType
        - timestamp
        - value
      type: object
      properties:
        sourceId:
          type: string
          description: プロパティーの固有ID。
        sourceLabel:
          type: string
          description: 人間が読めるラベル。
        sourceType:
          type: string
          description: プロパティーのタイプ。
        timestamp:
          type: string
          description: プロパティーが更新された時刻のタイムスタンプ（ISO 8601形式）。
          format: date-time
        updatedByUserId:
          type: integer
          description: プロパティーを最後に更新したユーザーのID。
          format: int32
        value:
          type: string
          description: プロパティー値。
      description: タイムスタンプを含むプロパティーモデル。
    PublicObjectWarning:
      required:
        - category
        - context
        - message
      type: object
      properties:
        category:
          type: string
        context:
          type: object
          additionalProperties:
            type: string
        message:
          type: string
    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
    Paging:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
        prev:
          $ref: '#/components/schemas/PreviousPage'
    AssociatedId:
      required:
        - id
        - type
      type: object
      properties:
        id:
          type: string
          description: 関連付けタイプのID。
        type:
          type: string
          description: 関連付けのタイプ。
          example: deal_to_contact
      description: 関連付けのIDとタイプが含まれます
    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: エラーに関する具体的な詳細が含まれる特定のカテゴリー
    NextPage:
      required:
        - after
      type: object
      properties:
        after:
          type: string
          description: 後続のページを取得するためのページングカーソルトークン。
        link:
          type: string
          description: 次ページの結果を取得するために使用できるURL。
      description: ページ分割されたAPIレスポンスで次の結果セットを取得するために必要なページ設定情報を指定します
      example:
        after: NTI1Cg%3D%3D
        link: '?after=NTI1Cg%3D%3D'
    PreviousPage:
      required:
        - before
      type: object
      properties:
        before:
          type: string
          description: 前のページを取得するためのページ操作カーソルトークン。
        link:
          type: string
          description: 前のページの結果を取得するために使用できるURL。
      description: ページ分割されたAPIレスポンスで前の結果セットを取得するために必要なページ設定情報を指定します
  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:
            crm.objects.commercepayments.read: ''
            crm.objects.deals.read: ''
            crm.objects.deals.write: ''
            oauth: ''

````