Zum Hauptinhalt springen
最終更新日: 2025年10月8日

Run in Postman

 HubSpotの会社レコードには、自社とやり取りする組織に関する情報が保存されます。会社エンドポイントを使用することにより、会社レコードを作成および管理したり、HubSpotと他のシステムの間で会社データを同期したりできます。 オブジェクト、レコード、プロパティー、および関連付けAPIの詳細については、CRMについてのガイドをご確認ください。HubSpotのオブジェクトとレコードに関する一般的な情報については、CRMデータベースを管理する方法をご確認ください。

​
会社レコードを作成する

新しい会社レコードを作成するには、POSTリクエストを/crm/v3/objects/companiesに送信します。 リクエスト内のpropertiesオブジェクトに会社データを含めます。また、associationsオブジェクトを追加して、新しい会社レコードを既存のレコード（コンタクト、取引など）やアクティビティー（ミーティング、メモなど）に関連付けることもできます。

​
プロパティー

会社の詳細は、会社プロパティーに保存されます。HubSpotのデフォルトの会社プロパティーがありますが、カスタムプロパティーを作成することもできます。 新しい会社レコードを作成する際は、nameまたはdomainプロパティーのうち、少なくとも1つをリクエストに含める必要があります。ドメイン名は会社レコードを一意に識別する主要なIDであるため、HubSpotで会社が重複しないようにするために、常にdomainを含めることを推奨します。会社レコードに複数のドメインが含まれている場合は、hs_additional_domainsフィールドに各ドメインをセミコロンで区切って指定することにより、API経由でドメインを追加できます。例："hs_additional_domains" : "domain.com; domain2.com; domain3.com" 利用可能な全てのプロパティーを確認するにはGETリクエストを/crm/v3/properties/companiesに送信して、アカウントの会社プロパティーのリストを取得します。詳しくはプロパティーAPIをご参照ください。
注: リクエストにlifecyclestageを含める場合、値はライフサイクルステージの内部名を参照する必要があります。デフォルトのステージの内部名はテキスト値であり、ステージのラベル（subscriberやmarketingqualifiedleadなど）を編集しても変更されません。カスタムステージの内部名は数値です。ステージの内部IDを見つけるには、ライフサイクルステージ設定を確認するか、APIを使ってライフサイクル ステージ プロパティーを取得します。
例えば、新しい会社レコードを作成する場合、リクエストの内容は次のようになります。
  • JSON
///Example request body
{
"properties": {
"name": "HubSpot",
"domain": "hubspot.com",
"city": "Cambridge",
"industry": "Technology",
"phone": "555-555-555",
"state": "Massachusetts",
"lifecyclestage": "51439524"
}
}

​
関連付け

新しい会社レコードを作成する際に、その会社レコードをassociationsオブジェクトの既存のレコードやアクティビティーに関連付けることもできます。例えば、新しい会社レコードに既存のコンタクトとEメールアドレスを関連付ける場合、リクエストの内容は次のようになります。
  • JSON
///Example request body
{
"properties": {
"name": "HubSpot",
"domain": "hubspot.com",
"city": "Cambridge",
"industry": "Technology",
"phone": "555-555-555",
"state": "Massachusetts",
"lifecyclestage": "51439524"
},
"associations": [
{
"to": {
"id": 101
},
"types": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 280
}
]
},
{
"to": {
"id": 556677
},
"types": [
{
"associationCategory": "HUBSPOT_DEFINED",
"associationTypeId": 185
}
]
}
]
}
次のものをassociationsオブジェクトに含める必要があります。
パラメーター説明
to会社レコードを関連付けるレコードまたはアクティビティー。一意のid値で指定します。
types会社とレコード／アクティビティーの間の関連付けのタイプ。associationCategoryおよびassociationTypeIdを含めます。デフォルトの関連付けタイプIDは、このページで確認できます。または、関連付けAPIを使用して、カスタム関連付けタイプ（ラベル）の値を取得することもできます。

​
会社レコードを取得する

会社レコードを個別に、または一括で取得できます。
  • 個々の会社レコードを取得するには、GETリクエストを/crm/v3/objects/companies/{companyId}に送信します。
  • 全ての会社レコードのリストを要求するには、GETリクエストを/crm/v3/objects/companiesに送信します。
これらのエンドポイントに対し、リクエストのURLに次のクエリーパラメーターを含めることができます。
パラメーター説明
propertiesレスポンスで返されるプロパティーのカンマ区切りリスト。リクエスト対象の会社レコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。
propertiesWithHistoryレスポンスで返される現在および過去のプロパティーのカンマ区切りリスト。リクエスト対象の会社レコードで、指定したプロパティーに値が設定されていない場合、そのプロパティーはレスポンスに含まれません。
associations関連付けられているIDが取得されるオブジェクトのカンマ区切りリスト。存在しない関連付けを指定した場合、その関連付けはレスポンスで返されません。詳しくは関連付けAPIをご参照ください。
  • レコードIDまたはカスタムの固有IDプロパティーを指定して、特定の会社レコードを一括で取得するには、POSTリクエストをcrm/v3/objects/companies/batch/readに送信します。このバッチエンドポイントは関連付けを取得できません。関連付けAPIを使用して関連付けを一括で読み取る方法について説明します。
一括読み取りエンドポイントの場合は、任意指定のidPropertyパラメーターを使用し、カスタムの固有IDプロパティーを指定して、会社レコードを取得することもできます。デフォルトで、リクエストのid値はレコードID（hs_object_id）を参照するため、レコードIDを使って取得するときにはidPropertyパラメーターは不要です。カスタムの固有の値のプロパティーを使用して会社レコードを取得するには、idPropertyパラメーターを含める必要があります。 例えば、会社レコードを一括で取得する場合のリクエストは、次のいずれかのようになります。 プロパティーの現在の値と過去の値を含む会社を取得する場合のリクエストは、次のようになります。 
///Example request body with record ID (current and historical values)
{
  "propertiesWithHistory": ["name"],
  "inputs": [
    {
      "id": "56789"
    },
    {
      "id": "23456"
    }
  ]
}

​
会社レコードを更新する

会社レコードを個別に、または一括で更新できます。既存の会社の場合、APIを介して会社レコードを更新するために使用可能な固有の値は、会社のレコードIDです。 会社IDを基に会社レコードを個別に更新するには、PATCHリクエストに更新対象のデータを含めて/crm/v3/objects/companies/{companyId}に送信します。
**注 **：lifecyclestageプロパティーを更新する場合、ライフサイクルステージの先のステージにのみ値を設定できます。ライフサイクルステージの前のステージに設定するには、まずレコードの既存のライフサイクルステージの値をクリアする必要があります。この値は手動でクリアできます。または、ワークフローやコンタクトデータを同期する連携機能によってこの値を自動的にクリアすることもできます。

​
既存の会社レコードを他のレコードまたはアクティビティーに関連付ける

会社レコードを他のCRMレコードまたはアクティビティーに関連付けるには、PUTリクエストを/crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}に送信します。
associationTypeId値を取得するには、デフォルト値のこのリストを参照するか、GETリクエストを/crm/v4/associations/{fromObjectType}/{toObjectType}/labelsに送信します。
レコード関連付けの詳細については関連付けAPIをご確認ください。

​
関連付けを削除する

会社レコードと他のレコードまたはアクティビティーの関連付けを削除するには、DELETEリクエストを/crm/v3/objects/companies/{companyId}/associations/{toObjectType}/{toObjectId}/{associationTypeId}に送信します。

​
会社レコードでアクティビティーをピン留めする

リクエストにhs_pinned_engagement_idフィールドを含めることで、APIを介して会社レコードでアクティビティーをピン留めできます。フィールドに、ピン留めするアクティビティーのidを含めます。これはエンゲージメントAPIを介して取得できます。レコードごとに1つのアクティビティーをピン留めすることができ、そのアクティビティーはピン留めする前にすでに会社レコードに関連付けられている必要があります。 会社にピン留めするアクティビティーを設定または更新する場合、リクエストは次のようになります。 
///Example request body PATCH /crm/v3/objects/companies/{companyId}
{
  "properties": {
    "hs_pinned_engagement_id": 123456789
  }
}
同じリクエスト内で、会社を作成し、既存のアクティビティーに関連付け、アクティビティーをピン留めすることもできます。以下に例を示します。 
///Example request body POST /crm/v3/objects/companies
{
  "properties": {
    "domain": "example.com",
    "name": "Example Company",
    "hs_pinned_engagement_id": 123456789
  },
  "associations": [
    {
      "to": {
        "id": 123456789
      },
      "types": [
        {
          "associationCategory": "HUBSPOT_DEFINED",
          "associationTypeId": 189
        }
      ]
    }
  ]
}

​
会社レコードを削除する

会社レコードを個別に、または一括で削除できます。削除した会社レコードは、HubSpot内のごみ箱に追加されます。そのため、必要に応じて後でHubSpot内で会社レコードを復元できます。 IDを基準に会社レコードを個別に削除するには、DELETEリクエストを/crm/v3/objects/companies/{companyId}に送信します。 会社を一括で削除する方法について詳しくは、 リファレンスドキュメントをご確認ください。