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

# CRM APIについて

> HubSpotのCRMは、顧客の関係性やデータを管理するためのシステムです。CRMオブジェクトと関連するCRM APIについて確認しましょう。

HubSpotアカウントの基盤となるのは、CRM（顧客関係管理）と呼ばれる、ビジネス上の関係性とプロセスのデータベースです。このデータを管理するために、HubSpotアカウントには関係やプロセスのタイプを表すオブジェクトが含まれています。レコードと呼ばれるオブジェクトの個々のインスタンスは、各オブジェクトタイプに属する個々のエンティティーを表します（例：山田太郎は「コンタクト」です）。各レコードにデータを格納するには、プロパティー（Eメールプロパティーなど）を使用します。個々のエンティティー間の関係を表すには、レコードを互いに関連付けることができます（例：山田太郎を海山商事に関連付ける）。CRMレコードには、Eメール、コール、ミーティングなどの関連付けられたエンゲージメントやアクティビティーを介したインタラクションに関する情報を格納することもできます。以下では、CRMオブジェクト、レコード、プロパティー、関連付け、パイプライン、およびCRM検索について説明します。HubSpot内からCRMデータベースを管理する方法の詳細については、[HubSpotのナレッジベース](https://knowledge.hubspot.com/ja/get-started/manage-your-crm-database)をご確認ください。

## オブジェクトAPI

オブジェクトAPIは、レコードとアクティビティーへのアクセスを提供します。サポートされるオブジェクトについては、オブジェクトエンドポイントを使用して、リクエストURLの`{objectTypeId}`を目的のオブジェクトに置き換えることができます。例えば、コンタクトを作成するには`POST`リクエストを`crm/v3/objects/0-1`に送信し、コースを作成するには`crm/v3/objects/0-410`に送信します。さまざまなオブジェクト用にオブジェクトエンドポイントを使用する方法については、[こちらの記事](/api-reference/crm-objects-v3/guide)をご参照ください。

<Warning>
  ### 注：

  一部のオブジェクトではAPI機能に制限があります。詳細については、以下の表にあるオブジェクトのエンドポイントのリファレンスドキュメントへのリンクをクリックしてください。表内にオブジェクト固有のドキュメントが掲載されていない場合は、[オブジェクトAPIのドキュメント](https://developers.hubspot.jp/docs/reference/api/crm/objects/objects)を参照して、各エンドポイントの`{objectTypeId}`を目的のオブジェクトに置き換えます。
</Warning>

### オブジェクトタイプID

CRM APIやその他のAPIを使用する場合は、`objectTypeId`フィールドを使用する必要があります。これは、各オブジェクトに割り当てられる固有の数値です。例えば、レコードを取得するには`GET`リクエストを`/crm/v3/objects/{objectTypeId}`に送信し、オブジェクトのプロパティーを作成するときには`POST`リクエストを`/crm/v3/properties/{objectTypeId}`に送信します。オブジェクトタイプIDの値を以下の表に示します。

| タイプID   | オブジェクト      | 説明                                                                                                                                                                                                                                                      |
| ------- | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `0-2`   | 会社          | 企業や組織についての情報を格納します。詳細は[会社API](/api-reference/crm-companies-v3/guide)をご確認ください。                                                                                                                                                                           |
| `0-1`   | コンタクト       | 個人に関する情報を格納します。[コンタクトAPI](/api-reference/crm-contacts-v3/guide)を確認してください。                                                                                                                                                                               |
| `0-3`   | 取引          | パイプラインステージを通じて追跡される営業の商談と取引を表します。詳細は[取引API](/api-reference/crm-deals-v3/guide)をご確認ください。                                                                                                                                                                 |
| `0-5`   | チケット        | パイプラインステータスを通じて追跡される顧客からのサポート依頼を表します。詳細は[チケットAPI](/api-reference/crm-tickets-v3/guide)をご確認ください。                                                                                                                                                         |
| `0-421` | アポイントメント    | 個人向けに予定されている会合やサービスを表します。詳細は[オブジェクトAPI](https://developers.hubspot.jp/docs/reference/api/crm/objects/objects)をご確認ください。                                                                                                                                  |
| `0-48`  | コール         | レコードに関連付けられている通話のやりとりを表すアクティビティーの一種です。詳細は[コールAPI](/api-reference/crm-calls-v3/guide)をご確認ください。                                                                                                                                                           |
| `0-18`  | コミュニケーション   | レコードに関連付けられているSMS、LinkedIn、WhatsAppメッセージのやりとりを表すアクティビティーの一種です。[コミュニケーションAPI](/api-reference/crm-communications-v3/guide)を確認してください。                                                                                                                      |
| `0-410` | コース         | 構造化されたプログラムまたは一連のレッスン、トレーニング、または教育関連モジュールを表します。詳細は[オブジェクトAPI](https://developers.hubspot.jp/docs/reference/api/crm/objects/objects)をご確認ください。                                                                                                            |
| `2-XXX` | カスタムオブジェクト  | 既存のオブジェクトに適合しないデータを格納します。カスタムオブジェクトの`objectTypeId`を確認するには、`GET`リクエストを`/crm/v3/schemas`に送信します。詳細は[オブジェクトAPI](https://developers.hubspot.jp/docs/reference/api/crm/objects/objects)をご確認ください。                                                              |
| `0-49`  | Eメール        | レコードに関連付けられている1対1のEメールのやりとりを表すアクティビティーの一種です。詳細は[EメールAPI](/api-reference/crm-emails-v3/guide)をご確認ください。                                                                                                                                                   |
| `0-19`  | フィードバック送信   | フィードバックアンケートに送信された情報を格納します。フィードバック送信はコンタクトレコードに関連付けられます。詳細は[フィードバック送信API](/api-reference/crm-feedback-submissions-v3/guide)をご確認ください。                                                                                                                    |
| `0-53`  | 請求書         | 販売取引に関して送信された請求書を表します。請求書には、コンタクト、会社、取引、商品項目、割引、手数料、および税金を関連付けることができます。詳細は[請求書API](/api-reference/crm-invoices-v3/guide)をご確認ください。                                                                                                                       |
| `0-136` | リード         | 製品やサービスに関心を示した潜在顧客を表します。詳細は[リードAPI](/api-reference/crm-leads-v3/guide)をご確認ください。                                                                                                                                                                         |
| `0-8`   | 商品項目        | 取引において販売する個々の製品とサービスを表します。商品項目は、製品ライブラリーに登録されている既存の製品から作成したり、単独で作成したりすることができます。詳細は[商品項目API](/api-reference/crm-line-items-v3/guide)をご確認ください。                                                                                                            |
| `0-420` | 掲載情報        | 購入、販売、賃貸する不動産や設備を表します。詳細は[オブジェクトAPI](https://developers.hubspot.jp/docs/reference/api/crm/objects/objects)をご確認ください。                                                                                                                                     |
| `0-54`  | マーケティングイベント | マーケティング活動に関連するイベント、具体的には、接続した連携機能からのイベントなどを表します。コンタクトがマーケティングイベントに出席、参加登録、キャンセルしたかどうかを指定できます。詳細は[マーケティングイベントAPI](/api-reference/marketing-marketing-events-v3/guide)をご確認ください。                                                                           |
| `0-47`  | ミーティング      | レコードに関連付けられているミーティングのやりとりを表すアクティビティーの一種です。詳細は[ミーティングAPI](/api-reference/crm-meetings-v3/guide)をご確認ください。                                                                                                                                                 |
| `0-46`  | メモ          | レコードに関連付けられたメモを表すアクティビティーの一種。詳細は[メモAPI](/api-reference/crm-notes-v3/guide)をご確認ください。                                                                                                                                                                     |
| `0-123` | 注文          | eコマース購入をHubSpotで表します。詳細は[注文API](/api-reference/crm-orders-v3/guide)をご確認ください。                                                                                                                                                                            |
| `0-101` | 支払い         | 請求書、支払いリンク、見積もりを通じて購入者が行う支払いです。支払いには、コンタクト、会社、取引、請求書、見積もり、商品項目、サブスクリプション、割引、手数料、および税金を関連付けることができます。詳細は[支払いAPI](/api-reference/crm-commerce-payments-v3/guide)をご確認ください。                                                                                  |
| `0-116` | 郵便          | レコードに関連付けられた郵便物のやりとりを表すアクティビティーの一種です。詳細は[郵便API](/api-reference/crm-postal-mail-v3/guide)をご確認ください。                                                                                                                                                       |
| `0-7`   | 製品          | 販売する商品やサービスを表します。製品を他のCRMオブジェクトに関連付けることはできませんが、製品に基づいて商品項目を作成し、それらを取引や見積もりに関連付けることができます。詳細は[製品API](/api-reference/crm-products-v3/guide)を確認してください。                                                                                                      |
| `0-14`  | 見積もり        | 潜在顧客に共有する価格情報を表します。見積もりを取引、商品項目、見積もりテンプレート（`0-64`）に[関連付ける](https://developers.hubspot.jp/docs/guides/api/crm/objects/quotes#adding-associations)必要がありますが、見積もりをコンタクト、会社、割引、手数料、税金に関連付けることもできます。詳細は[見積もりAPI](/api-reference/crm-quotes-v3/guide)をご確認ください。 |
| `0-162` | サービス        | 顧客に提供される無形の製品を表します。例としては、導入支援やコンサルティング、修理やメンテナンス、パーソナルケアなどがあります。詳細は[オブジェクトAPI](https://developers.hubspot.jp/docs/reference/api/crm/objects/objects)をご確認ください。                                                                                           |
| `0-69`  | サブスクリプション   | 支払いリンクと見積もりを通じて予定されている定期的な支払いを表します。サブスクリプションには、コンタクト、会社、取引、見積もり、商品項目、支払い、割引、手数料、および税金を関連付けることができます。詳細は[サブスクリプションAPI](/api-reference/crm-commerce-subscriptions-v3/guide)をご確認ください。                                                                       |
| `0-27`  | タスク         | レコードに関連付けられるTo Doを表すアクティビティーの一種です。[タスクAPI](/api-reference/crm-tasks-v3/guide)を確認してください。                                                                                                                                                                 |
| `0-115` | ユーザー        | HubSpotアカウントのユーザーを表します。ユーザーを他のCRMオブジェクトに関連付けることはできませんが、APIを介して取得および更新することはできます。[ユーザーの詳細API](/api-reference/crm-users-v3/guide)を確認してください。                                                                                                                |

数値タイプのID値はいつでも使用できますが、コンタクト、会社、取引、チケット、メモはオブジェクト名を使用できる場合もあります。以下に例を示します。

* [インポートAPI](/api-reference/crm-imports-v3/guide)でインポートを開始するときは、ファイル内のデータがどのオブジェクトに属するかを`columnObjectTypeId`に指定します。コンタクトのデータをインポートするには、`columnObjectTypeId`の値として`contact`または`0-1`を使用できます。
* [関連付けAPI](/api-reference/crm-associations-v4/guide)を使用するときは、`fromObjectType`と`toObjectType`の値でオブジェクトと関連付けの方向を指定します。コンタクトと会社との関連付けタイプを確認するには、`GET`リクエストURLとして`crm/v4/associations/contact/company/labels`または`crm/v4/associations/0-1/0-2/labels`を使用できます。

### 固有IDとレコードID

固有IDとは、CRM内のあるレコードを別のレコードと（仮にID以外の情報が同一であっても）区別するための値です。例えば、データベース内に名前が同じ2人の山田太郎さんのレコードが存在するとします。誤って他方の山田太郎さんに送金されることがないように、各レコードには「レコードID」として番号が割り当てられます。

HubSpotでレコードが作成されると、その「レコードID」（`hs_object_id`）が自動的に生成され、文字列として扱われます。レコードIDはオブジェクト内で一意です。したがって、コンタクトと会社のIDが同じになる場合があります。コンタクトと会社には、コンタクトのEメール（`email`）や会社のドメイン名（`domain`）など、他にも固有のIDがあります。また、[カスタムの固有IDプロパティーを作成する](https://developers.hubspot.jp/docs/guides/api/crm/properties#create-unique-identifier-properties)こともできます。

CRM APIでは固有のID値を使用して特定のレコードを識別し、管理します。レコードの`hs_object_id`値は常に使用できますが、`idProperty`パラメーターで指定された特定のエンドポイントに対してカスタムの固有IDプロパティーを使用することもできます。例えば、コンタクトを編集するには`PATCH`リクエストを`/crm/v3/objects/0-1/{contactId}`または`/crm/v3/objects/0-1/{contactEmail}?idProperty=email`に送信します。HubSpotで重複の削除が処理される方法については、[ナレッジベース](https://knowledge.hubspot.com/ja/records/deduplication-of-records)をご確認ください。

## 関連付けAPI

HubSpotでは、オブジェクトがどのように相互に関連しているかを示すために、レコードを関連付けることができます。例えば、複数のコンタクトを会社に関連付けて、会社および関連するコンタクトを取引に関連付けることができます。

[関連付けAPIエンドポイント](/api-reference/crm-associations-v4/guide)を使用するときには、リクエストURLとリクエスト本文の中の`{toObjectTypeId}`や`{fromObjectTypeId}`をオブジェクトに置き換えることができます。オブジェクト間でレコードを関連付ける前に、どのオブジェクトを相互に関連付けることができるかを理解するために、[関連付けタイプを取得](/api-reference/crm-associations-v4/guide#association-type-id-values)できます。例えば、コンタクトをほとんどのオブジェクトに関連付けることができますが、請求書を関連付けることができるのはコンタクト、会社、取引、商品項目、割引、手数料、および税金だけです。ご使用のサブスクリプションに応じて、[関係ラベル](https://knowledge.hubspot.com/ja/object-settings/create-and-use-association-labels)を使用してレコード間の特定の関係の種類を記述できます。アカウントによっては、他の標準的なオブジェクトに関連付けることのできる追加のカスタムオブジェクトが存在することがあります。オブジェクト関係について、また[関連付けエンドポイント](/api-reference/crm-associations-v4/guide)による関連付けの管理について詳しくご確認ください。

HubSpotアカウントへのアクセス権をお持ちの場合は、[データモデルツール](https://knowledge.hubspot.com/ja/data-management/view-a-model-of-your-crm-object-and-activity-relationships)に移動して、アカウント固有のオブジェクト関係を確認することもできます。

<Frame>
  <img src="https://www.hubspot.jp/hubfs/Knowledge_Base_2023/data-model-overview-updated.gif" alt="データモデルの概要-更新版" />
</Frame>

## プロパティーAPI

レコードに関する情報は、プロパティーと呼ばれるフィールドに格納された後、[グループ](https://knowledge.hubspot.com/ja/properties/create-and-edit-properties)に分類されます。HubSpotでは、各オブジェクトにデフォルトのプロパティーセットが用意されています。オブジェクトごとのデフォルトのプロパティーに加え、[カスタムプロパティーを作成](https://knowledge.hubspot.com/ja/properties/create-and-edit-properties)することによって、カスタムのデータを格納できます。

プロパティーAPIを使用する場合は、エンドポイント内でオブジェクトに置き換えて、オブジェクトのプロパティーを作成および管理できます。例えば、コンタクトプロパティーの場合は`/crm/v3/properties/0-1`、チケットプロパティーの場合は`/crm/v3/properties/0-5`です。プロパティーAPIの使用について詳しくは、[この記事](/api-reference/crm-properties-v3/guide)をご確認ください。

## 検索API

プロパティーと関連付けに基づいてレコードやアクティビティーのフィルタリングおよび並び替えを行うには、検索APIを使用できます。検索エンドポイントを使用する場合は、`{objectTypeId}`の値を検索したいオブジェクトに置き換えます。例えば、コールを検索するにはPOSTリクエストを`/crm/v3/objects/0-48/search`に送信します。CRM検索APIの詳しい使用方法については、[こちらの記事](https://developers.hubspot.jp/docs/guides/api/crm/search)をご参照ください。

## パイプラインAPI

HubSpotでは、パイプラインを使用してプロセスにおけるレコードの進捗を追跡できます。例えば、営業プロセスの段階によって取引を追跡したり、サポートステータスによってチケットを追跡したりできます。パイプラインAPIを使用すると、パイプラインとパイプラインステージを作成、取得、編集、削除できます。パイプラインに対応するオブジェクトと、パイプラインAPIの使用方法については、[こちらの記事](/api-reference/crm-pipelines-v3/guide)をご確認ください。
