はじめに

このページでは、CData Cloud でのHubSpot への接続の確立のガイド、利用可能なリソースに関する情報、および使用可能な接続プロパティのリファレンスについて説明します。

HubSpot への接続

接続の確立は、CData Cloud にデータベースを作成するためのHubSpot への認証方法と必要な接続プロパティの設定方法について示します。

CData Cloud サービスからデータにアクセス

利用可能な標準サービスを経由してHubSpot からデータにアクセスする方法と、CData Cloud の管理については、CData Cloud ドキュメントで詳しく説明します。

接続の確立

Database タブで対応するアイコンを選択して、HubSpot に接続します。必須プロパティはSettings にリストされています。Advanced タブには、通常は必要ない接続プロパティが表示されます。

HubSpot への認証

HubSpot はOAuth 認証をサポートします。

OAuth

HubSpot は埋め込みOAuth 認証情報を提供しており、デスクトップアプリケーションからの接続を簡単にします。 Web アプリケーションから接続するには、カスタムOAuth アプリケーションの作成で説明するようにカスタムOAuth アプリケーションを作成する必要があります。

すべての認証フローで、OAuth 経由で接続するにはAuthScheme をOAuth に設定する必要があります。

以下のサブセクションでは、利用可能なOAuth フローでのHubSpot への認証について詳しく説明します。カスタムOAuth アプリケーションの作成についての情報と、すでに埋め込みOAuth 認証情報を持つ認証フローでもカスタムOAuth アプリケーションを作成したほうがよい場合の説明については、カスタムOAuth アプリケーションの作成を参照してください。

HubSpot で利用可能な接続文字列プロパティの全リストは、Connection を参照してください。

データアクセスのファインチューニング

カスタムフィールドへのアクセス

多数のカスタムフィールドを定義している場合、HubSpot はリクエスト可能なフィールド数を制限するので、エラーが発生してSELECT * クエリが失敗するかもしれません。このエラーを避けるために、ContactPropertiesFile およびDealPropertiesFile で指定されたテキストファイル内に、返したいカスタムフィールドを指定することができます。または、WHERE 句に主キーを指定してください。

検知されたカスタムフィールドのカラムサイズが十分でない場合、ColumnSizes でサイズを指定できます。

データアクセスのファインチューニング

次のプロパティを使って、カラム名をより詳細に制御できます。

UseDisplayNames
UseSimpleNames

廃止予定機能の通知

HubSpot Contact Lists API の廃止について

HubSpot の変更ログ記事：Upcoming Sunset: V1 Lists API に基づき、HubSpot Driver のHubSpot スキーマに対して、特定のテーブルの削除を含む複数のBreaking Change（互換性のない変更）を計画しています。

以下の表は、Contact Lists API の廃止によって影響を受けるテーブルと、それに対応してドライバーのHubspot およびHubSpotV3 スキーマで行われた変更をまとめたものです。

これらの変更は確定ではなく、今後のHubSpot API チームからの発表や更新に応じて調整される可能性があります。最新情報については、HubSpot の変更ログ記事をご確認ください。


テーブル	V1 ステータス	V3 ステータス
Contacts	一部影響あり。リストとメンバーシップに関連するカラム（例：ListMembershipsAggregate）は削除されます。	テーブルには同様の機能が残りますが、リストメンバーシップの集約は含まれません。このデータを取得するには、新しいListMemberships テーブルをご利用ください。
ContactListMemberships	API エンドポイントはリストメンバーシップデータを返さなくなります。このテーブルは削除されました。	新しいListMemberships テーブルが導入され、（Contacts に限らず）複数のオブジェクトタイプに対応しています。ただし、API の変更により、Email カラムは利用できなくなります。
ContactLists	HubSpot はこのエンドポイントを廃止予定です。このテーブルは削除されました。	新しいLists テーブルが導入され、複数のオブジェクトタイプに対応しています。ObjectTypeId カラムが追加され、その他のカラムは軽微な調整のみです。
ContactsInList	HubSpot はこのエンドポイントを廃止予定です。このテーブルは削除されました。	直接の代替はありませんが、Contacts およびListMemberships テーブルを使用したサブクエリで同様の機能を実現可能です。例： `SELECT [*] FROM [Contacts] WHERE [Id] IN (SELECT [ObjectId] FROM [ListMemberships] WHERE [ObjectTypeId] = '0-1')`
Enrollments	Enrollments は、1回のクエリですべてのレコードを取得できなくなります。Enrollments をクエリするには、フィルタでId を指定する必要があります。例：`SELECT * FROM Enrollment WHERE Id = [id]`	V3 スキーマには相当するエンドポイントは存在しません。

その他の影響を受ける可能性のあるテーブル

以下のテーブルも部分的または完全に影響を受ける可能性があります。ただし、現在のHubSpot のドキュメントによると、Contact Lists API が廃止された後も、関連するエンドポイントは機能し続ける見込みです。

ContactFormSubmissions
ContactIdentityProfiles
ContactPropertiesHistory
ContactStatistics
EmailSubscriptions

HubSpot によると、これらのエンドポイントは引き続き機能しますが、リストメンバーシップ情報を返さなくなります。したがって、これらのテーブルはドライバー内でも引き続き機能する可能性が高いと考えられます。

推奨事項

すべての新規開発において、HubSpotV3 スキーマの使用を強く推奨します。また、既存の実装についても可能な限りV3 スキーマへの移行を検討してください。V3スキーマはより安定しており、HubSpot によって精力的に保守され、定期的な更新と機能強化によって機能が大幅に向上しています。レガシーのHubSpot スキーマは、時間の経過とともに徐々に時代遅れとなり、更新頻度が減少し、V3 API で実装される新機能や最適化の対象外となる可能性があります。

HubSpot Marketing Email V1 API の廃止について

HubSpot の変更ログ記事：Upcoming Sunset: V1 Marketing Email API に基づき、HubSpot はHubSpot Driver のHubSpot スキーマに対して、E メール関連エンドポイントのV3 への移行を含むBreaking Change（互換性のない変更）を発表しました。

以下の表は、Marketing Email V1 API の廃止によって影響を受けるテーブルと、それに対応してドライバーのHubspot およびHubspotV3 スキーマで行われた変更をまとめたものです。

これらの変更は確定ではなく、今後のHubSpot API チームからの発表や更新に応じて調整される可能性があります。最新情報については、HubSpot の変更ログ記事をご確認ください。


テーブル	V1 ステータス	V3 ステータス
MarketingEmails	HubSpot はこのエンドポイントを廃止予定であり、このテーブルは削除されます。	新しいMarketingEmails テーブルが導入され、機能が強化されました。

OAuth スコープとエンドポイント

HubSpot に必要なスコープおよびエンドポイントドメイン

HubSpot と連携する場合、アプリケーションはAPI とやりとりするために特定の権限が必要です。

これらの権限はアクセススコープによって定義され、アプリケーションがアクセス可能なデータと実行可能なアクションを決定します。

このトピックでは、HubSpot プロバイダーに必要なアクセススコープとエンドポイントドメインについての情報を提供します。

スコープについて

スコープは、ユーザーのデータへのアプリケーションによるアクセスを制限するための手段です。これは、アプリケーションがユーザーに代わって実行できる特定のアクションを定義します。

例えば、読み取り専用スコープではアプリケーションにデータの閲覧を許可し、フルアクセススコープではデータの変更を許可することができます。

HubSpot に必要なスコープ


スコープ	説明
automation	自動化ワークフローにアクセスします。読み書きのアクセスに必要です。
business-intelligence	ソースとE メールの上位に位置するエンドポイントにアクセスします。読み書きのアクセスに必要です。
cms.source_code.read_write	開発者がWeb サイトやE メールのコードを記述するために必要なテンプレート、モジュール、その他のファイルをアップロードおよびダウンロードする機能を提供します。書き込みアクセスに必要です。
collector_graphql_query_execute	GraphQL API エンドポイントを使用してHubSpot アカウントからデータをクエリします。読み書きのアクセスに必要です。
collector_graphql_query_read	GraphQL などのGraphQL アプリケーションクライアントを介してイントロスペクションクエリを実行します。読み書きのアクセスに必要です。
content	サイト、ランディングページ、CTA、メール、ブログ、キャンペーンにアクセスします。読み書きのアクセスに必要です。
conversations.read	コミュニケーション受信トレイのスレッドの詳細を表示します。読み書きのアクセスに必要です。
conversations.visitor_identification.tokens.create	HubSpot チャットウィジェットと対話する認証済みWeb サイト訪問者の識別トークンを取得します。読み書きのアクセスに必要です。
crm.import	CRM にレコードをインポートできます。これには、新しいレコードの作成や、すべてのCRM データタイプ（コンタクト、会社、取引、チケットなど）の既存のレコードの変更が含まれます。データのアーカイブや削除は含まれません。読み書きのアクセスに必要です。
crm.lists.read	コンタクトのリストの詳細を表示します。読み書きのアクセスに必要です。
crm.lists.write	コンタクトのリストを作成、削除、または変更します。書き込みアクセスに必要です。
crm.objects.companies.read	会社に関するプロパティやその他の詳細を表示します。読み書きのアクセスに必要です。
crm.objects.companies.write	プロパティを表示し、会社を作成、削除、または変更します。書き込みアクセスに必要です。
crm.objects.contracts.read	コンタクトに関するプロパティやその他の詳細を表示します。読み書きのアクセスに必要です。
crm.objects.contracts.write	プロパティを表示し、コンタクトを作成、削除、変更します。書き込みアクセスに必要です。
crm.objects.deals.read	取引に関するプロパティやその他の詳細を表示します。読み書きのアクセスに必要です。
crm.objects.deals.write	プロパティを表示し、取引を作成、削除、または変更します。書き込みアクセスに必要です。
crm.objects.owners.read	CRM レコードに割り当てられたユーザーの詳細を表示します。読み書きのアクセスに必要です。
crm.schemas.companies.read	会社のプロパティ設定の詳細を表示します。読み書きのアクセスに必要です。
crm.schemas.companies.write	会社のプロパティ設定を作成、削除、または変更します。書き込みアクセスに必要です。
crm.schemas.contacts.read	コンタクトのプロパティ設定の詳細を表示します。読み書きのアクセスに必要です。
crm.schemas.contacts.write	コンタクトのプロパティ設定を作成、削除、または変更します。書き込みアクセスに必要です。
crm.schemas.deals.read	取引のプロパティ設定の詳細を表示します。読み書きのアクセスに必要です。
crm.schemas.deals.write	取引のプロパティ設定を作成、削除、または変更します。書き込みアクセスに必要です。
e-commerce	e コマース機能にアクセスします。読み書きのアクセスに必要です。
files	ファイルマネージャーにアクセスします。読み書きのアクセスに必要です。
forms	Forms エンドポイントにアクセスします。読み書きのアクセスに必要です。
forms-uploaded-files	フォームから送信されたファイルをダウンロードします。読み書きのアクセスに必要です。
hubdb	HubDB にアクセスします。読み書きのアクセスに必要です。
integration-sync	ほとんどのCRM オブジェクトの同期を可能にする同期API を公開します。読み書きのアクセスに必要です。
oauth	OAuth に必要な基本スコープ。読み書きのアクセスに必要です。
sales-email-read	コンタクトに送信された1対1のE メールの詳細をすべて読み取るためのアクセス権を付与します。読み書きのアクセスに必要です。
settings.user.read	HubSpot アカウントからユーザーとユーザーロールを取得します。読み書きのアクセスに必要です。
settings.user.teams.read	HubSpot アカウントからチームを取得します。読み書きのアクセスに必要です。
social	ソーシャル受信トレイにアクセスします。読み書きのアクセスに必要です。
tickets	チケットにアクセスします。読み書きのアクセスに必要です。
timeline	HubSpot CRM レコードのカスタムイベントを管理するためのアクセス権を付与します。これには、レコードの作成または更新が含まれます。読み書きのアクセスに必要です。
transactional-email	トランザクションE メールおよびトランザクションE メールエンドポイントにアクセスします。読み書きのアクセスに必要です。

エンドポイントドメインについて

エンドポイントドメインとは、アプリケーションが認証、レコードの取得、その他の重要な操作を実行するために通信する必要がある特定のURL を指します。

これらのドメインを許可することで、アプリケーションとAPI 間のネットワークトラフィックがファイアウォールやセキュリティ設定によってブロックされることがなくなります。

Note： ほとんどのユーザーは特別な設定をする必要はありません。許可リストは通常、送信ネットワークトラフィックの制限など、厳格なセキュリティ対策が施された環境でのみ必要となります。

HubSpot に必要なエンドポイントドメイン


ドメイン	常に必須	説明
api.hubspot.com	TRUE	HubSpot API のベースURL。
app.hubspot.com	FALSE	HubSpot のOAuth 認可を行う際に使用するドメイン。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Cloud はサーバーとのTLS のネゴシエーションを試みます。サーバー証明書は、デフォルトのシステム信頼済み証明書ストアで検証されます。SSLServerCert 接続プロパティを使用して、証明書の検証方法をオーバーライドできます。

別の証明書を指定するには、SSLServerCert 接続プロパティを参照してください。

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

HTTP プロキシへの認証には、以下のように設定します。

ProxyServer：HTTP トラフィックをルートするプロキシサーバーのホストネームもしくはIP アドレス。
ProxyPort：プロキシサーバーが起動しているTCP ポート。
ProxyAuthScheme：プロキシサーバーに対して認証する際にCloud が使用する認証方法。
ProxyUser：プロキシサーバーに登録されているユーザーアカウントのユーザー名。
ProxyPassword：ProxyUser に紐付けられたパスワード。

その他のプロキシ

次のプロパティを設定します。

プロキシベースのファイヤーウォールを使用するには、FirewallType、FirewallServer、およびFirewallPort を設定します。
接続をトンネルするには、FirewallType をTUNNEL に設定します。
認証するには、FirewallUser とFirewallPassword を設定します。
SOCKS プロキシへの認証には、さらにFirewallType をSOCKS5 に設定します。

データモデル

CData Cloud はHubSpot データをテーブル、ビュー、ストアドプロシージャを備えた使いやすいSQL データベースとしてモデル化します。

Cloud は3つのスキーマを公開します。

HubSpot API で利用可能なエンティティについては、HubSpot データモデルを参照してください。
HubSpot V3 API で利用可能なエンティティについては、HubSpot V3 データモデルを参照してください。
HubSpot V4 API で利用可能なエンティティについては、HubSpot V4 データモデルを参照してください。

バッチ操作

HubSpot のAPI がサポートする最大バッチサイズは10です。そのため、CData はBatchSize 接続プロパティをこの値に設定することを推奨します。CData では、Cloud のパフォーマンスが向上しないことから、これより大きな値を使用することは推奨していません。

HubSpot データモデル

CData Cloud はHubSpot データを使いやすいSQL データベースとしてモデル化します。データモデルには3つのパートがあります。テーブル、ビュー、およびストアドプロシージャです。

テーブル

テーブルセクションには標準SQL テーブルの詳細が、ビューセクションには読み取り専用SQL テーブルの一覧が記載されています。これらには、HubSpot アカウントでのアクセスを想定したサンプルが含まれています。

一般的なテーブルには以下のものが含まれます。


テーブル	説明
Contacts	Handles HubSpot contact records, enabling full create, read, update, delete (CRUD) operations on contact data.
Companies	Manages company records in HubSpot, allowing creation, updating, and deletion of company data similar to contact management.
Deals	Manages HubSpot deals used for recording sales opportunities, with capabilities for retrieval and modification.
Tickets	Retrieves all ticket records from a HubSpot portal, used for customer support and issue tracking.
Engagements	Represents various types of interactions in HubSpot, including calls, emails, and tasks, useful for tracking customer engagement activities.
ContactProperties	Accesses both standard and custom properties assigned to contacts, critical for personalized marketing and sales strategies.
CompanyProperties	Provides access to standard and custom fields associated with companies in HubSpot, aiding in data enrichment.
DealProperties	Provides access to deal property fields, both standard and custom, supporting deal tracking and analysis.
TicketProperties	Lists all properties related to tickets, both default and custom, used for managing customer support cases.
LineItems	Retrieves all line items in HubSpot, commonly used in association with deals and transactions.
Products	Retrieves product records configured in HubSpot, useful for inventory, pricing, and catalog management.
Workflows	Manages and retrieves workflows configured in HubSpot to automate marketing, sales, and service processes.
CrmAssociations	Queries customer relationship management (CRM) object associations within HubSpot, essential for understanding relationships between CRM entities.
ContactFormSubmissions	Lists form submissions made by contacts, useful for analyzing contact engagement through forms.
Forms	Enables creation, management, and retrieval of HubSpot forms used for lead capture and contact data collection.
MarketingEmails	Enables creation, management, and retrieval of marketing emails in HubSpot for email campaign management.
EmailSubscriptions	Lists subscription types linked to a specific email address, allowing management of subscription preferences.
AnalyticsSessions	Breaks down analytics data by user sessions, providing visibility into visitor behavior across sessions.
AnalyticsViews	Lists configured analytics views within the HubSpot portal, providing information on available analytics perspectives.

Cloud は、HubSpot API を使用してサポートされているフィルタを処理します。その他のフィルタは、Cloud 内でクライアント側で処理されます。

ストアドプロシージャ

ストアドプロシージャは、SQL クエリを介して呼び出されるアクションです。標準的なCRUD 操作だけでなく、スキーマの作成やOAuth トークンの管理など、より高度なタスクも実行します。

テーブル

Cloud はHubSpot のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - HubSpot テーブル


Name	Description
Companies	Manages company records in HubSpot, allowing creation, updating, and deletion of company data similar to contact management.
CompanyProperties	Provides access to standard and custom fields associated with companies in HubSpot, aiding in data enrichment.
CompanyPropertyGroups	Organizes company properties into logical groups to streamline property management and categorization in HubSpot.
ContactProperties	Accesses both standard and custom properties assigned to contacts, critical for personalized marketing and sales strategies.
ContactPropertyGroups	Categorizes contact properties into groups to simplify property organization and data management.
Contacts	Handles HubSpot contact records, enabling full create, read, update, delete (CRUD) operations on contact data.
CrmAssociations	Queries CRM object associations within HubSpot, essential for understanding relationships between CRM entities.
DealAssociations	Manages relationships between deals and associated CRM objects, supporting insertion and deletion of associations.
DealProperties	Provides access to deal property fields, both standard and custom, supporting deal tracking and analysis.
DealPropertyGroups	Organizes deal properties into property groups to facilitate easier navigation and logical structuring.
Deals	Manages HubSpot deals used for recording sales opportunities, with capabilities for retrieval and modification.
EmailSubscriptions	Lists subscription types linked to a specific email address, allowing management of subscription preferences.
Engagements	Represents various types of interactions in HubSpot, including calls, emails, and tasks, useful for tracking customer engagement activities.
Forms	Enables creation, management, and retrieval of HubSpot forms used for lead capture and contact data collection.
LineItemProperties	Lists all properties and property definitions for line items, providing structure for product/service line entries.
LineItems	Retrieves all line items in HubSpot, commonly used in association with deals and transactions.
MarketingEmails	Enables creation, management, and retrieval of marketing emails in HubSpot for email campaign management.
ProductProperties	Provides all properties for product records, supporting product data management and enrichment.
Products	Retrieves product records configured in HubSpot, useful for inventory, pricing, and catalog management.
SocialMediaMessages	Enables creation and management of social media messages directly from HubSpot's platform.
TicketProperties	Lists all properties related to tickets, both default and custom, used for managing customer support cases.
TicketPropertyGroups	Returns property groups associated with ticket records, helping organize ticket properties logically.
Tickets	Retrieves all ticket records from a HubSpot portal, used for customer support and issue tracking.
Workflows	Manages and retrieves workflows configured in HubSpot to automate marketing, sales, and service processes.

Companies

Manages company records in HubSpot, allowing creation, updating, and deletion of company data similar to contact management.

Table Specific Information

Companies in HubSpot represent different organizations you are interested in keeping track of for potential marketing opportunities. They are treated similarly like contacts and have a number of custom properties that will be dynamically determined and added to the Companies table from your HubSpot Hub.

SELECT

When selecting companies, they can only be filtered by the CompanyId and only one Company at a time. Otherwise they can be selected without a filter, which will cause all companies in your HubSpot account to be listed. For example:

SELECT * FROM Companies WHERE CompanyId = '123456789'

Columns


Name	Type	ReadOnly	References	Description
CompanyId [KEY]	Long	True		Unique identifier assigned to the company record in HubSpot.
IsDeleted	Boolean	True		Boolean flag indicating whether the company record has been deleted.
OtherProperties	String	True		Additional company-specific properties dynamically retrieved at runtime based on the company's custom and standard fields configured in your HubSpot account.

CompanyProperties

Provides access to standard and custom fields associated with companies in HubSpot, aiding in data enrichment.

Table Specific Information

Company properties are a number of custom properties that are available to store data about the companies in your HubSpot Hub. Some of these properties are added by HubSpot and cannot be deleted. They will be automatically added to the Companies on a new connection.

SELECT

Company properties can only be filtered by the unique company property name. For example:

SELECT * FROM CompanyProperties WHERE Name = 'property_name'

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		Unique name identifier for the company property. Must contain only lowercase letters and numbers, starting with a letter.
Label	String	False		Human-readable label displayed for the company property in the HubSpot UI.
FieldType	String	False		The type of input field shown for the company property, such as text, dropdown, or checkbox. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, booleancheckbox, checkbox
Type	String	False		Machine-readable data type used to store the company property value. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False	ContactPropertyGroups.Name	Name of the group or category to which the company property belongs.
Description	String	False		Brief description explaining the purpose of the company property.
DisplayMode	String	False		Specifies how the property will appear in the user interface, such as as a standard field or hidden value.
DisplayOrder	Integer	False		Numerical order determining the property's position among others in its group.
ExternalOptions	Boolean	False		Indicates whether the property options are sourced externally.
IsFormField	Boolean	False		Boolean flag indicating whether the property is available as a form field.
IsCalculated	Boolean	False		Indicates whether the property is calculated based on other property values.
IsHidden	Boolean	False		Boolean flag indicating whether the property is hidden from the standard user interface.
IsHubspotDefined	Boolean	False		Indicates whether the property is a default property defined by HubSpot.
MutableDefinitionNotDeletable	Boolean	False		Specifies whether the property's definition can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Indicates whether the property's structure is read-only and cannot be changed.
ReadOnlyValue	Boolean	False		Boolean flag indicating whether the property's value is locked and cannot be edited.
OptionsAggregate	String	False		Aggregate string of selectable options for the property. Populated for field types like radio buttons, checkboxes, or boolean checkboxes.
ExtraUrlParameters	String	True		Optional input-only property to specify additional query parameters when retrieving company property data. Format: 'param1=value1, param2=value2, param3=value3'.

CompanyPropertyGroups

Organizes company properties into logical groups to streamline property management and categorization in HubSpot.

Table Specific Information

Company property groups offer a means of organizing the various custom properties that are available for defining properties about a given company. Company property groups may be selected, inserted, updated, or deleted from this table.

SELECT

Company property groups may only be filtered by the unique company property group name. For example:

SELECT * FROM CompanyPropertyGroups WHERE Name = 'property_group_name'

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		Unique name identifier for the company property group.
DisplayName	String	False		Display name of the company property group, shown in the HubSpot UI.
DisplayOrder	Integer	False		Numeric value indicating the display order of the company property group relative to others.
ExtraUrlParameters	String	True		Optional input-only property to specify additional query parameters when retrieving company property group data. Format: 'param1=value1, param2=value2, param3=value3'.

ContactProperties

Accesses both standard and custom properties assigned to contacts, critical for personalized marketing and sales strategies.

Table Specific Information

Contact properties are a number of custom properties that are available to store data about the contacts in your HubSpot Hub. Some of these properties are added by HubSpot and cannot be deleted. They will be automatically added to the Contacts on a new connection.

SELECT

Contact properties can only be filtered by the unique contact property name or group name. For example:

SELECT * FROM ContactProperties WHERE Name = 'property_name'
SELECT * FROM ContactProperties WHERE GroupName = 'group_name'

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		Unique name identifier for the contact property. Must consist of lowercase letters and numbers, starting with a letter.
Label	String	False		Human-readable label displayed for the contact property in the HubSpot UI.
FieldType	String	False		The type of input field shown for the contact property, such as text, dropdown, or checkbox. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox
Type	String	False		Machine-readable data type used to store the contact property value. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False	ContactPropertyGroups.Name	Name of the group or category to which the contact property belongs.
Description	String	False		Brief description explaining the purpose of the contact property.
DisplayMode	String	False		Specifies how the property will appear in the user interface, such as a standard field or hidden value.
DisplayOrder	Integer	False		Numerical order determining the property's position among others in its group.
ExternalOptions	Boolean	False		Indicates whether the property's options are sourced externally.
IsFormField	Boolean	False		Boolean flag indicating whether the property is available as a form field.
IsCalculated	Boolean	False		Indicates whether the property is calculated based on other property values.
IsHidden	Boolean	False		Boolean flag indicating whether the property is hidden from the standard user interface.
IsFavorited	Boolean	False		Boolean flag indicating whether the property is marked as favorited in the UI.
FavoritedOrder	Integer	False		Numerical value determining the order of favorited properties for display purposes.
MutableDefinitionNotDeletable	Boolean	False		Specifies whether the property's definition can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Indicates whether the property's structure is read-only and cannot be changed.
ReadOnlyValue	Boolean	False		Boolean flag indicating whether the property's value is locked and cannot be edited.
OptionsAggregate	String	False		Aggregate string of selectable options for the property. Populated for field types like radio buttons, checkboxes, or boolean checkboxes.
ExtraUrlParameters	String	True		Optional input-only property to specify additional query parameters when retrieving contact property data. Format: 'param1=value1, param2=value2, param3=value3'.

ContactPropertyGroups

Categorizes contact properties into groups to simplify property organization and data management.

Table Specific Information

Contact property groups offer a means of organizing the various custom properties that are available for defining properties about a given contact. Contact property groups can be selected, inserted, updated, or deleted from this table.

SELECT

Contact property groups can only be filtered by the unique contact property group name. For example:

SELECT * FROM ContactPropertyGroups WHERE Name = 'property_group_name'

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		Unique name identifier for the contact property group.
DisplayName	String	False		Display name of the contact property group, shown in the HubSpot UI.
DisplayOrder	Integer	False		Numeric value indicating the display order of the contact property group relative to others.
ExtraUrlParameters	String	True		Optional input-only property to specify additional query parameters when retrieving contact property group data. Format: 'param1=value1, param2=value2, param3=value3'.

Contacts

Handles HubSpot contact records, enabling full create, read, update, delete (CRUD) operations on contact data.

Table Specific Information

Contacts in HubSpot represent different contacts you are interested in keeping track of for potential marketing opportunities. Contacts are similar to companies: They both have a number of custom properties that will be dynamically determined and added to the table from your HubSpot Hub.

SELECT

When selecting contacts, they can only be filtered by the VID, Email, UserToken, ListId, or AssociatedCompanyId. However, most of these filters cannot be used at the same time. The accepted filters are illustrated below:

SELECT * FROM Contacts WHERE VID = 123456789
SELECT * FROM Contacts WHERE VID IN (123, 456)
SELECT * FROM Contacts WHERE VID > 123456789
SELECT * FROM Contacts WHERE Email = '[email protected]'
SELECT * FROM Contacts WHERE Email IN ('[email protected]', '[email protected]')
SELECT * FROM Contacts WHERE UserToken = 'ABC123456'
SELECT * FROM Contacts WHERE SearchTerms = 'Contact Name'
SELECT * FROM Contacts WHERE ListId = '123456789'
SELECT * FROM Contacts WHERE AssociatedCompanyId = '123456789'

UPDATE

You can update contacts, for example, Additional email addresses:

UPDATE [Contacts] SET [Additional email addresses] = '[email protected];[email protected]', [last name] = 'last name 5' WHERE VID = 123456789

Columns


Name	Type	ReadOnly	References	Description
VID [KEY]	Long	True		Unique identifier (VID) assigned to the contact in HubSpot.
ListId	Long	True		Identifier of the contact list the contact belongs to.
SearchTerms	String	True		Input-only field to specify search terms when querying contact records.
CanonicalVid	Long	True		Canonical VID representing the primary identifier for merged or deduplicated contacts.
ProfileToken	String	True		Token associated with the contact's profile, used for secure profile access.
ProfileUrl	String	True		URL directing to the contact's profile page in HubSpot.
IdentityProfilesAggregate	String	True		Aggregate string representing all identities linked to the contact, such as email addresses or social profiles.
FormSubmissionsAggregate	String	True		Aggregate string listing all forms submitted by the contact, if applicable.
MergeAuditsAggregate	String	True		Aggregate of records detailing audits related to merged contact records.
MergedVidsAggregate	String	True		Aggregate list of VIDs merged into the current contact record.
OtherProperties	String	True		Additional dynamic properties about the contact retrieved at runtime, based on the HubSpot account's configuration.

CrmAssociations

Queries CRM object associations within HubSpot, essential for understanding relationships between CRM entities.

Table Specific Information

The CrmAssociations table is used to manage associations between tickets, products, line items, and their related contacts, companies, and deals.

SELECT

Get the IDs of objects associated with the given object (FromObjectId), based on the specified association type (DefinitionId).See the HubSpot API documentation for a list of DefinitionIds. FromObjectId and DefinitionId are required. For example, to get the ticket IDs for all tickets associated with a contact record with vid 25, the FromobjectId would be 25, and the definitionId would be 15:

SELECT * FROM CrmAssociations WHERE FromObjectId = '25' AND DefinitionId = '15'

INSERT

You would use insertion to associate a ticket with a contact, or to associate a line item object to a deal. When creating a new CRM Association FromObjectId, ToObjectId, Category (currently this must be 'HUBSPOT_DEFINED') and DefinitionId are required. For example:

INSERT INTO CrmAssociations (FromObjectId, ToObjectId, Category, DefinitionId) VALUES (496346, 176602, 'HUBSPOT_DEFINED', 15)

UPDATE

UPDATEs are not supported for this table.

DELETE

When deleting a CRM Association FromObjectId, ToObjectId, Category (currently this must be 'HUBSPOT_DEFINED') and DefinitionId are required. For example:

DELETE FROM CrmAssociations WHERE FromObjectId = 496346 AND ToObjectId = 176602 AND Category = 'HUBSPOT_DEFINED' AND DefinitionId = 15

Columns


Name	Type	ReadOnly	References	Description
Results	String	True		Comma-separated list of object IDs associated with the specified object, filtered by the given association type.
FromObjectId [KEY]	Long	False		Unique identifier of the source object being associated.
ToObjectId [KEY]	Long	False		Unique identifier of the target object being associated to the source object.
Category [KEY]	String	False		Specifies the association category. Currently, only 'HUBSPOT_DEFINED' is supported.
DefinitionId [KEY]	Long	False		Unique identifier of the association definition used to describe the relationship between objects.

DealAssociations

Manages relationships between deals and associated CRM objects, supporting insertion and deletion of associations.

Table Specific Information

Deal associations represent Company and Contact associations made with existing deals that may be modified.

SELECT

When selecting deal associations, they can only be filtered by the Id. For example:

SELECT * FROM DealAssociations WHERE DealId = 12345

INSERT

New associations may be inserted by specifying the DealId, AssociationId, and the AssociationType during an INSERT statement. For example:

INSERT INTO DealAssociations (DealId, AssociationId, AssociationType) VALUES (12345, 6789, 'COMPANY')

DELETE

Associations may be removed by specifying the DealId, AssociationId, and the AssociationType during a DELETE statement. For example:

DELETE FROM DealAssociations WHERE DealId = 12345 AND AssociationId = 6789 AND AssociationType = 'COMPANY'

Columns


Name	Type	ReadOnly	References	Description
DealId [KEY]	Long	False	Deals.DealId	Unique identifier of the deal in HubSpot.
AssociatedId [KEY]	Long	False		Unique identifier of the entity associated with the deal, such as a contact or company.
AssociationType [KEY]	String	False		Specifies the type of association, for example, 'Company' or 'Contact'.

DealProperties

Provides access to deal property fields, both standard and custom, supporting deal tracking and analysis.

Table Specific Information

Deal properties are a number of custom properties that are available to store data about the deals in your HubSpot Hub. Some of these properties are added by HubSpot and cannot be deleted. They will be automatically added to the Deals on a new connection.

SELECT

Deal properties can only be filtered by the unique deal property name. For example:

SELECT * FROM DealProperties WHERE Name = 'property_name'

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		Unique name identifier for the deal property. Must consist of lowercase letters and numbers, starting with a letter.
Label	String	False		Human-readable label displayed for the deal property in the HubSpot UI.
FieldType	String	False		The type of input field shown for the deal property, such as text, dropdown, or checkbox. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox, booleancheckbox
Type	String	False		Machine-readable data type used to store the deal property value. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False	DealPropertyGroups.Name	Name of the group or category to which the deal property belongs.
Description	String	False		Brief description explaining the purpose of the deal property.
DisplayMode	String	False		Specifies how the property will appear in the user interface, such as standard, hidden, or read-only.
DisplayOrder	Integer	False		Numerical order determining the property's position among others in its group.
ExternalOptions	Boolean	False		Indicates whether the property's options are sourced externally.
IsFormField	Boolean	False		Boolean flag indicating whether the property is available as a field in forms.
IsCalculated	Boolean	False		Indicates whether the property is calculated based on other property values.
IsHidden	Boolean	False		Boolean flag indicating whether the property is hidden from the standard user interface.
IsDeleted	Boolean	True		Boolean flag indicating whether the property has been deleted.
IsHubspotDefined	Boolean	True		Indicates whether the property is a default property defined by HubSpot.
ShowCurrencySymbol	Boolean	False		Boolean indicating whether a currency symbol is displayed with the property value. Only relevant for numeric fields.
MutableDefinitionNotDeletable	Boolean	False		Specifies whether the property's definition can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Indicates whether the property's structure is read-only and cannot be changed.
ReadOnlyValue	Boolean	False		Boolean flag indicating whether the property's value is locked and cannot be edited.
OptionsUpdatable	Boolean	False		Indicates whether the property's options can be updated.
OptionsAggregate	String	False		Aggregate string of selectable options for the property. Populated for field types like radio buttons, checkboxes, or boolean checkboxes.
ExtraUrlParameters	String	True		Optional input-only property to specify additional query parameters when retrieving deal property data. Format: 'param1=value1, param2=value2, param3=value3'.

DealPropertyGroups

Organizes deal properties into property groups to facilitate easier navigation and logical structuring.

Table Specific Information

Deal property groups offer a means of organizing the various custom properties that are available for defining properties about a given deal. Deal property groups may be selected, inserted, updated, or deleted from this table.

SELECT

Deal property groups may only be filtered by the unique deal property group name. For example:

SELECT * FROM DealPropertyGroups WHERE Name = 'property_group_name'

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		Unique name identifier for the deal property group.
DisplayName	String	False		Display name of the deal property group, shown in the HubSpot UI.
DisplayOrder	Integer	False		Numeric value indicating the display order of the deal property group relative to others.
ExtraUrlParameters	String	True		Optional input-only property to specify additional query parameters when retrieving deal property group data. Format: 'param1=value1, param2=value2, param3=value3'.

Deals

Manages HubSpot deals used for recording sales opportunities, with capabilities for retrieval and modification.

Table Specific Information

Deals in HubSpot represent different organizations you are interested in keeping track of for potential marketing opportunities. They are treated similarly like contacts and have a number of custom properties that will be dynamically determined and added to the Deals table from your HubSpot Hub.

SELECT

When selecting deals, they can only be filtered by the DealId and only one Deal at a time. Otherwise they can be selected without a filter, which will cause all deals in your HubSpot account to be listed. For example:

SELECT * FROM Deals WHERE DealId = '123456789'

Columns


Name	Type	ReadOnly	References	Description
DealId [KEY]	Long	True		Unique identifier assigned to the deal in HubSpot.
DealName	String	True		The name assigned to the deal.
IsDeleted	Boolean	True		Boolean flag indicating whether the deal has been deleted.
AssociatedCompanyIds	String	True		Comma-separated list of company IDs associated with the deal.
AssociatedDealIds	String	True		Comma-separated list of other deal IDs linked to this deal.
AssociatedVids	String	True		Comma-separated list of contact IDs (VIDs) associated with this deal.

EmailSubscriptions

Lists subscription types linked to a specific email address, allowing management of subscription preferences.

Table Specific Information

Email subscriptions in HubSpot represent different types of subscriptions a given contact email may be subscribed to. When deleting an email subscription the contact will be opted out and will not receive emails from the specified subscription type(mailing group). EmailSubscriptions lists the subscriptions a given email address is subscribed to.

SELECT

When selecting email subscriptions, an email must be provided. For example:

SELECT * FROM EmailSubscriptions WHERE Email = '[email protected]'

Columns


Name	Type	ReadOnly	References	Description
Email [KEY]	String	True		The email address associated with the subscription.
SubscriptionId [KEY]	Long	True		Unique identifier of the email subscription type.
IsSubscribed	Boolean	False		Boolean flag indicating whether the customer is currently subscribed to the subscription type.
ExtraUrlParameters	String	False		Optional input-only property to specify additional query parameters when retrieving email subscription data. Format: 'param1=value1, param2=value2, param3=value3'.
LegalBasis	String	False		The lawful basis for communicating with the contact, typically for General Data Protection Regulation (GDPR) compliance. 使用できる値は次のとおりです。LEGITIMATE_INTEREST_PQL, LEGITIMATE_INTEREST_CLIENT, PERFORMANCE_OF_CONTRACT, CONSENT_WITH_NOTICE, NON_GDPR, PROCESS_AND_STORE, LEGITIMATE_INTEREST_OTHER
LegalBasisExplanation	String	False		Explanation or supporting information about the lawful basis provided.
OptState	String	False		Specifies whether a contact is opted in or out of a given email subscription type. Possible values are OPT_IN, OPT_OUT, NOT_OPTED. Opting out is permanent and cannot be undone. 使用できる値は次のとおりです。OPT_IN, OPT_OUT, NOT_OPTED

Engagements

Represents various types of interactions in HubSpot, including calls, emails, and tasks, useful for tracking customer engagement activities.

Table Specific Information

Engagements represent any of a number of different types of engagements you have in HubSpot. These can very from simple Tasks, to Emails, Calls, Meetings, or others. Due to the different types of engagements available, any individual Engagement will have several columns that come back null due to its type.

SELECT

When selecting engagements, they can only be filtered by the Id. For instance:

SELECT * FROM Engagements WHERE Id = 12345

Insert and Update

When inserting Engagements, a Type must be specified. In addition, different fields are available on insert depending on the type used. The available fields for each type are as follows: CALL, EMAIL, MEETING, NOTE, PUBLISHING_TASK, TASK

CALL: ToNumber, FromNumber, Body, DurationMilliseconds, Status, ExternalId, ExternalAccountId, RecordingUrl, Disposition
EMAIL: FromEmail, FromFirstName, FromLastName, ToEmail, Cc, Bcc, Subject, EmailHtml, EmailText
MEETING: Body, StartTime, EndTime, Title
PUBLISHING_TASK: Body, CampaignGuid, Category, CategoryId, State, Name
TASK: Body, Status, ForObjectType

In addition, there are some common fields available when inserting or updating any type of Engagement. These include DateTime, AssociatedContacts, AssociatedCompanies, AssociatedDeals, AssociatedOwners, and AssociatedWorkflows. For instance:

INSERT INTO Engagements (DateTime, Type, Body, CampaignGuid, Category, CategoryId, ContentId, State, Name, AssociatedContacts) VALUES ('1/1/2011', 'PUBLISHING_TASK', 'Cool Post with Topics', 'f43fe9fd-4082-4a45-93d8-cb8a88f01654', 'BLOG_POST', 3, '2682673052', 'TODO', 'Test Blog Task With topics 3', '234, 567')

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique identifier assigned to the engagement.
PortalId	Long	True		HubSpot portal ID associated with the engagement.
IsActive	Boolean	True		Boolean flag indicating whether the engagement is active.
CreatedAt	Datetime	True		Timestamp indicating when the engagement was created.
UpdatedAt	Datetime	True		Timestamp indicating when the engagement was last updated.
CreatedBy	Long	True		User ID of the user who originally created the engagement.
ModifiedBy	Long	True		User ID of the user who last modified the engagement.
OwnerId	Long	False		Owner ID assigned to the engagement.
Type	String	False		Type of engagement, such as NOTE, TASK, CALL, MEETING, or EMAIL. Required for inserts.
ActivityType	String	False		Activity type associated with the engagement, providing additional classification.
DateTime	Datetime	False		Custom datetime field for specifying when the engagement-related action occurred, such as the time of a call.
AssociatedContacts	String	False		Comma-separated list of contact IDs associated with the engagement.
AssociatedCompanies	String	False		Comma-separated list of company IDs associated with the engagement.
AssociatedDeals	String	False		Comma-separated list of deal IDs associated with the engagement.
AssociatedOwners	String	True		Comma-separated list of owner IDs associated with the engagement.
AssociatedWorkflows	String	False		Comma-separated list of workflow IDs associated with the engagement.
AssociatedTickets	String	False		Comma-separated list of ticket IDs associated with the engagement.
Attachments	String	False		Comma-separated list of attachments associated with this engagement.
MessageId	String	False		Message ID related to the engagement, if applicable.
ThreadId	String	False		Thread ID related to the engagement, if applicable.
Body	String	False		Body content of the engagement. Used when Type is NOTE, TASK, PUBLISHING_TASK, CALL, or MEETING.
Status	String	False		Status of the engagement task. Applicable for TASK, CALL, or MEETING types.
ForObjectType	String	False		The object type the task is related to, such as CONTACT. Applicable for TASK type.
StartTime	String	False		Start datetime of the meeting. Applicable when Type is MEETING.
EndTime	String	False		End datetime of the meeting. Applicable when Type is MEETING.
Title	String	False		Title of the meeting. Applicable when Type is MEETING.
FromEmail	String	False		Sender email address in the engagement. Applicable when Type is EMAIL.
FromFirstName	String	False		First name of the sender. Applicable when Type is EMAIL.
FromLastName	String	False		Last name of the sender. Applicable when Type is EMAIL.
ToEmail	String	False		Comma-separated list of recipient email addresses. Applicable when Type is EMAIL.
Cc	String	False		Comma-separated list of CC email addresses. Applicable when Type is EMAIL.
Bcc	String	False		Comma-separated list of BCC email addresses. Applicable when Type is EMAIL.
Subject	String	False		Subject line of the email engagement. Applicable when Type is EMAIL.
EmailHtml	String	False		HTML content of the email body. Applicable when Type is EMAIL.
EmailText	String	False		Plain text content of the email body. Applicable when Type is EMAIL.
CampaignGuid	String	False		Campaign GUID associated with the engagement. Applicable when Type is PUBLISHING_TASK.
Category	String	False		Category classification of the engagement. Applicable when Type is PUBLISHING_TASK.
CategoryId	Integer	False		Category ID of the engagement. Applicable when Type is PUBLISHING_TASK.
ContentId	String	False		Content ID associated with the engagement. Applicable when Type is PUBLISHING_TASK.
State	String	False		State or status of the engagement. Applicable when Type is PUBLISHING_TASK.
Name	String	False		Name of the engagement. Applicable when Type is PUBLISHING_TASK.
ToNumber	String	False		Phone number dialed in the engagement. Applicable when Type is CALL.
FromNumber	String	False		Phone number used as the sender's number in the engagement. Applicable when Type is CALL.
ExternalId	String	False		Internal ID of the call in HubSpot. Applicable when Type is CALL.
DurationMilliseconds	Long	False		Duration of the call in milliseconds. Applicable when Type is CALL.
ExternalAccountId	String	False		Internal ID of the account used to make the call. Applicable when Type is CALL.
RecordingUrl	String	False		URL to the recording file of the call. Applicable when Type is CALL.
Disposition	String	False		Internal GUID corresponding to the call outcome. Applicable when Type is CALL.
MeetingOutcome	String	False		Meeting outcome classification. Applicable when Type is MEETING. Allowed values include SCHEDULED, COMPLETED, RESCHEDULED, NO SHOW, CANCELED.
TaskType	String	False		Task type classification. Applicable when Type is TASK. Allowed values: TODO, EMAIL, CALL.
ExtraUrlParameters	String	True		Optional input-only property for specifying additional query parameters when retrieving engagement data. Format: 'param1=value1, param2=value2, param3=value3'.

Forms

Enables creation, management, and retrieval of HubSpot forms used for lead capture and contact data collection.

Table Specific Information

Forms represent the forms on your website that a user or contact can fill out, such as a survey.

SELECT

When selecting forms, they can only be filtered by GUID. For example:

SELECT * FROM Forms WHERE GUID = '123456789'

Columns


Name	Type	ReadOnly	References	Description
GUID [KEY]	String	True		Unique identifier key assigned to the form.
Name	String	False		Internal name of the form.
Action	String	False		Action or behavior executed when the form is submitted, such as sending data or triggering a workflow.
CSSClass	String	False		Cascading style sheet (CSS) class assigned to the form for styling purposes.
IsDeletable	Boolean	False		Boolean flag indicating whether the form can be deleted.
EmbeddedCode	String	False		Embedded JavaScript code included with the form.
FollowUpId	String	False		Identifier for a follow-up action or form, if applicable.
IgnoreCurrentValues	Boolean	False		Boolean flag indicating whether to ignore default or current values when the form is submitted.
Method	String	False		HTTP method (such as POST or GET) used when submitting the form.
MigratedFrom	String	True		Information about the original source of the form if it was migrated from another platform.
NotifyRecipients	String	False		Comma-separated list of email addresses to notify when the form is submitted.
PerformableHTML	String	False		HTML content that should be rendered or performed within the form.
Redirect	String	False		URL to redirect users to after successful form submission.
SubmitText	String	False		Text displayed on the submit button of the form.
CreatedAt	Datetime	True		Timestamp showing when the form was created.
UpdatedAt	Datetime	True		Timestamp showing when the form was last updated.
FormFieldGroupsAggregate	String	False		Collection of groups containing the fields available in the form.
SelectedExternalOptionsAggregate	String	False		Selected external options for the form, such as default lifecycle stages used to categorize companies and contacts.
MetaDataAggregate	String	True		Metadata details related to the form, including configurations and additional properties.
ExtraUrlParameters	String	True		Optional input-only property for specifying additional query parameters when retrieving form data. Format: 'param1=value1, param2=value2, param3=value3'.

LineItemProperties

Lists all properties and property definitions for line items, providing structure for product/service line entries.

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		Unique name identifier for the line item property. Must consist of lowercase letters and numbers, and begin with a lowercase letter.
Label	String	False		Label for the line item property, displayed in the HubSpot UI.
FieldType	String	False		Type of input field used to display the property on screen, such as text, dropdown, or checkbox. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox
Type	String	False		Stored machine-readable data type for the line item property. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False		Name of the group to which the line item property belongs.
Description	String	False		Detailed description explaining the purpose of the line item property.
DisplayMode	String	False		Mode or format in which the line item property is displayed in the HubSpot UI.
DisplayOrder	Integer	False		Numeric order indicating the display sequence of the property relative to others in the same group.
ExternalOptions	Boolean	False		Boolean flag indicating whether external options are associated with the line item property.
IsFormField	Boolean	False		Boolean flag indicating whether the property appears as a field in HubSpot forms.
IsCalculated	Boolean	False		Boolean flag indicating whether the value of the property is calculated dynamically.
IsHidden	Boolean	False		Boolean flag indicating whether the property is hidden from view.
IsFavorited	Boolean	False		Boolean flag indicating whether the property is favorited by users.
FavoritedOrder	Integer	False		Numeric value determining the order in which the favorited property appears.
MutableDefinitionNotDeletable	Boolean	False		Boolean flag indicating whether the property definition can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Boolean flag indicating whether the definition of the property is read-only.
ReadOnlyValue	Boolean	False		Boolean flag indicating whether the value of the property is read-only.
OptionsAggregate	String	False		Aggregate list of additional options for the property. Populated when the FieldType is radio, checkbox, or boolean checkbox.
ExtraUrlParameters	String	True		Optional input-only property for specifying additional query parameters when retrieving line item properties. Format: 'param1=value1, param2=value2, param3=value3'.

LineItems

Retrieves all line items in HubSpot, commonly used in association with deals and transactions.

Table Specific Information

A line item represents a line in an order, containing details such as the product, quantity, and price for each line of an order.

SELECT

When selecting line items, they can be filtered by ID or by ID and IncludeDeleted. For example:

SELECT * FROM LineItems WHERE Id = '123456789'
SELECT * FROM LineItems WHERE Id = '123456789' AND IncludeDeleted = 'true'

INSERT

When creating a new line item ProductId is required. You can also specify Name, Description, Price and Quantity. For example:

INSERT INTO LineItems (ProductId, Name, Description, Quantity, Price) VALUES ('123', 'NameExample', 'DescriptionExample', '50', '1324')

UPDATE

When updating line items, you can change non readOnly field by specifying the line item Id. For example:

UPDATE LineItems SET Name = 'UpdatedName', Description = 'Updated description', Price = 123 WHERE id = '123'

DELETE

You can delete line items singularly by Id, or in batches. For example:

DELETE FROM LineItems WHERE Id = 123
DELETE FROM LineItems WHERE Id IN ( '123', '234')

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique internal identifier assigned to the line item.
Name	String	False		Name of the product associated with this line item.
Price	String	False		Price of the line item. This is typically the price per unit before discounts.
Quantity	String	False		Quantity of the product specified in the line item.
Description	String	False		Detailed description of the product or service in the line item.
ProductId	String	False		Object ID of the associated product. Required when creating a new line item to specify the product being sold.
Version	Integer	True		Current version number of the line item, incremented with each update.
IsDeleted	Boolean	True		Boolean flag indicating whether the line item has been deleted. Deleted records are excluded by default.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
IncludeDeleted	String	Optional parameter to include deleted line items in the query results. Set this to true to return deleted records when selecting by ID.

MarketingEmails

Enables creation, management, and retrieval of marketing emails in HubSpot for email campaign management.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique identifier for the marketing email.
RssToEmailTimingRepeats	String	False		Defines how frequently an RSS-to-email campaign sends. Accepts these values: 'instant', 'daily', 'weekly', 'monthly'.
RssToEmailTimingRepeatsOnMonthly	Integer	False		Specifies the day of the month (1-31) when a monthly Really Simple Syndication (RSS) email should be sent.
RssToEmailTimingRepeatsOnWeekly	Integer	False		Specifies the day of the week (1=Monday to 7=Sunday) when a weekly RSS email should be sent.
RssToEmailTimingSummary	String	False		Summary description for the RSS-to-email timing. Reserved for future use.
RssToEmailTimingTime	String	False		Time of day the RSS email should be sent.
Ab	Boolean	True		Indicates whether the email is part of an A/B test campaign.
AbHoursToWait	Integer	False		Number of hours to wait before finalizing an A/B test. If results are inconclusive, variation A is used.
AbSampleSizeDefault	String	True		List showing which variations are used when there are fewer than 1000 recipients. Typically includes 'MASTER' and 'VARIANT'.
AbSamplingDefault	String	False		Default variation selected if A/B test results are inconclusive. Specifies whether 'MASTER' or 'VARIANT' is sent.
AbStatus	String	False		Specifies whether the email variation is the primary (MASTER) or secondary (VARIANT) version in an A/B test.
AbSuccessMetric	String	False		Metric used to determine the winning variation in an A/B test. Options include clicks by opens, clicks by delivered, or opens by delivered.
AbTestId	String	False		Unique test ID shared between variation A and B emails.
AbTestPercentage	Integer	False		Percentage size of the audience segment included in the A/B test group.
AbVariation	Boolean	False		Indicates whether the current email is a variation in an A/B test.
AbsoluteUrl	String	False		Full URL of the web version of the email.
AllEmailCampaignIds	String	False		List of all related email campaign IDs associated with this email.
AnalyticsPageId	String	False		ID used to reference the email's analytics page.
AnalyticsPageType	String	True		Type of analytics page. Always 'email' for email analytics.
Archived	Boolean	False		Boolean flag indicating whether the email is archived.
Author	String	True		Email address of the user who last updated the email.
AuthorAt	Datetime	True		Timestamp showing when the email was last updated.
AuthorEmail	String	True		Email address of the user who last updated the email.
AuthorName	String	True		Full name of the user who last updated the email.
AuthorUserId	Long	True		ID of the user who last updated the email.
BlogEmailType	String	False		Specifies how frequently blog-related emails are sent. Possible values: 'instant', 'daily', 'weekly', 'monthly'.
Campaign	String	False		ID of the marketing campaign associated with the email.
CampaignName	String	False		Name of the marketing campaign associated with the email.
CanSpamSettingsId	Long	False		CAN-SPAM settings ID used to retrieve the organization's address shown in the email footer.
CategoryId	Integer	True		Static category ID, always 2, indicating this is an email (read-only).
ClonedFrom	Long	True		ID of the source email if this email was cloned from an existing one.
ContentTypeCategory	Integer	True		Category type ID for content, always 2 for emails (read-only).
CreatePage	Boolean	False		Enables a web-hosted version of the email when set to true.
Created	Datetime	True		Datetime when the email was initially created.
CurrentlyPublished	Boolean	False		Boolean flag indicating whether the email is currently published and visible to recipients.
Domain	String	True		Domain name used in the web version of the email. Defaults to the primary domain.
EmailBody	String	False		Main content body of the email, typically containing text, images, and links.
EmailNote	String	False		Optional internal notes about the email, visible on the email details page.
EmailType	String	False		Specifies the type or category of the email (for example, regular, automated, RSS-based).
FeedbackEmailCategory	String	False		For feedback emails, specifies the type of feedback collected: Net Promoter Score (NPS), Customer Effort Score (CES), or Custom.
FeedbackSurveyId	Long	False		ID referencing the feedback survey associated with the email, if applicable.
FolderId	Long	False		ID of the folder in which the email is stored.
FreezeDate	Datetime	False		The timestamp representing either the email's publish date or last update date if unpublished.
FromName	String	False		Sender name displayed to recipients, typically linked to the reply-to address.
HtmlTitle	String	False		HTML title for the web version of the email, displayed in browser tabs and search results.
IsGraymailSuppressionEnabled	Boolean	False		If true, the email avoids sending to contacts marked as unengaged.
IsLocalTimezoneSend	Boolean	False		If true, email send times are adjusted to match each recipient's local timezone.
IsPublished	Boolean	False		Boolean indicating whether the email is currently published and live.
LiveDomain	String	True		The live domain name used in the web version of the email (read-only field).
MailingListsExcluded	String	True		Comma-separated list of contact lists to exclude from receiving the email.
MailingListsIncluded	String	True		Comma-separated list of contact lists to include in the email send.
MaxRssEntries	Long	False		Maximum number of RSS feed entries or blog posts included in the email content.
MetaDescription	String	False		Meta description of the web version of the email, aiding search engine visibility.
Name	String	False		The display name of the email as shown in the email dashboard.
PageExpiryDate	Datetime	False		Expiration timestamp for the web-hosted version of the email.
PageExpiryRedirectId	Long	False		ID of the redirect URL for the web version after expiration.
PageRedirected	Boolean	False		Boolean indicating whether the web version of the email has been set to redirect.
PortalId	Long	False		ID of the HubSpot portal that owns this email.
PreviewKey	String	False		Preview key used to generate a shareable preview URL for the email before publishing.
ProcessingStatus	String	False		Current processing status of the email, such as draft, scheduled, or sent.
PublishDate	Datetime	False		Timestamp when the email was published or scheduled to be sent.
PublishImmediately	Boolean	False		If true, the email will be sent immediately after being published.
PublishedAt	Datetime	True		Timestamp indicating when the publish button was pressed for the email.
PublishedById	Long	True		ID of the user who published the email.
PublishedByName	String	True		Name of the user who published the email.
PublishedUrl	String	True		Absolute URL for the published email's web version.
ReplyTo	String	False		Reply-to email address displayed to recipients.
ResolvedDomain	String	True		Domain used in the web version, either the default primary domain or a custom domain.
RssEmailAuthorLineTemplate	String	False		Prefix text displayed before the author's name in blog and RSS email entries.
RssEmailBlogImageMaxWidth	Integer	False		Maximum pixel width for images included in blog and RSS emails.
RssEmailByText	String	False		Fallback prefix displayed before the author name if no specific author line template is set.
RssEmailClickThroughText	String	False		Link text prompting recipients to view the full blog post in RSS emails.
RssEmailCommentText	String	False		Link text prompting recipients to comment on the blog post in RSS emails.
RssEmailEntryTemplate	String	False		Optional custom HTML template used for each RSS feed entry in the email.
RssEmailEntryTemplateEnabled	Boolean	False		Boolean indicating whether the custom entry template is enabled for the RSS email.
RssEmailUrl	String	False		URL used for sharing the RSS email content on social media platforms.
Slug	String	False		URL path component used in the web version of the email.
Subcategory	String	False		Subcategory classification of the email, typically used for organizational purposes.
Subject	String	False		The subject line of the email displayed to recipients.
Subscription	Long	False		ID referencing the email subscription type assigned to the email.
SubscriptionBlogId	Long	False		For blog subscription emails, the ID of the blog linked to the email.
SubscriptionName	String	False		Name of the subscription type assigned to the email.
TemplatePath	String	False		File path to the email's body template within the HubSpot design manager.
Transactional	Boolean	True		Boolean indicating whether the email is marked as transactional (non-marketing).
UnpublishedAt	Datetime	False		Timestamp indicating when the email was unpublished.
Updated	Datetime	True		Timestamp showing when the email was last updated.
UpdatedById	Long	True		ID of the user who last updated the email content.
Url	String	True		The full URL to access the web-hosted version of the email.
UseRssHeadlineAsSubject	Boolean	False		If true, the email's subject line is dynamically set using the latest RSS feed headline.
Widgets	String	True		List of layout widgets and content sections used in the email design.
VidsExcluded	String	True		Comma-separated list of contact IDs excluded from receiving the email.
VidsIncluded	String	True		Comma-separated list of contact IDs specifically included to receive the email.
WorkflowNames	String	True		List of workflow names linked to the email, for automation purposes.

ProductProperties

Provides all properties for product records, supporting product data management and enrichment.

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		The unique identifier of the product property. Must use only lowercase letters and numbers, beginning with a lowercase letter.
Label	String	False		The user-friendly label displayed in HubSpot's interface for the product property.
FieldType	String	False		Specifies the input field type (such as text, dropdown, checkbox) used to display the product property in forms or UI. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox
Type	String	False		The backend data type used to store the product property (such as string, number, boolean). 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False		The property group to which this product property belongs, used for organizational purposes.
Description	String	False		A brief explanation describing the purpose and usage of the product property.
DisplayMode	String	False		Defines how the product property appears visually in the interface, such as editable, read-only, or hidden.
DisplayOrder	Integer	False		Determines the display order of the product property relative to others in the same group.
ExternalOptions	Boolean	False		Boolean indicating whether the product property uses externally managed options (such as linked dropdown values).
IsFormField	Boolean	False		Specifies whether the product property is used as an input field in forms.
IsCalculated	Boolean	False		Indicates whether the product property is a calculated field, automatically derived from other property values.
IsHidden	Boolean	False		Boolean indicating whether the product property is hidden from the user interface.
IsFavorited	Boolean	False		Marks whether the product property is favorited and given priority in the display.
FavoritedOrder	Integer	False		Specifies the order of favorited product properties when multiple properties are marked as favorited.
MutableDefinitionNotDeletable	Boolean	False		Indicates whether the product property definition can be edited but cannot be deleted.
ReadOnlyDefinition	Boolean	False		Boolean specifying whether the definition (structure) of the product property is read-only and cannot be changed.
ReadOnlyValue	Boolean	False		Boolean specifying whether the value of the product property is read-only and cannot be modified.
OptionsAggregate	String	False		A comma-separated list of selectable options available for properties of field types like radio buttons, checkboxes, or dropdowns.
ExtraUrlParameters	String	True		An input-only parameter for specifying additional query parameters when retrieving data. Use a comma-separated list of name=value pairs, for example: 'param1=value1, param2=value2, param3=value3'.

Products

Retrieves product records configured in HubSpot, useful for inventory, pricing, and catalog management.

Table Specific Information

Products are a foundational object in HubSpot CRM. Products represent goods or services sold by your company.

SELECT

When selecting products, they can be filtered by ID or by ID and IncludeDeleted. For example:

SELECT * FROM Products WHERE Id = '123456789'
SELECT * FROM Products WHERE Id = '123456789' AND IncludeDeleted = 'true'

INSERT

When creating products, you can specify Name, Description and Price. For example:

INSERT INTO Products (Name, Description, Price) VALUES ('NameExample', 'This is a description', 1324)

UPDATE

When updating products, you can change Name, Description and Price by specifying the product Id. For example:

UPDATE Products SET Name = 'UpdatedName', Description = 'Updated desciption', Price = 123 WHERE id = '123'

DELETE

You can delete products singularly by Id, or in batches. For example:

DELETE FROM Products WHERE Id = 123
DELETE FROM Products WHERE Id IN ( '123', '234')

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The unique internal ID assigned to the product in HubSpot.
Name	String	False		The name of the product as it appears in HubSpot.
Sku	String	False		The Stock Keeping Unit (SKU) code used to identify and track the product.
Price	String	False		The price of the product, typically represented as a string to allow currency symbols or formatting.
Description	String	False		A descriptive summary of the product, detailing its key features or specifications.
Version	Integer	True		The version number of the product record. This value increments each time the product is updated to track changes.
IsDeleted	Boolean	False		Boolean indicating whether the product has been marked as deleted. Deleted products are excluded from results unless explicitly requested.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
IncludeDeleted	String	Optional input parameter that, when set, includes deleted product records in query results. Useful for auditing or historical data retrieval.

SocialMediaMessages

Enables creation and management of social media messages directly from HubSpot's platform.

Table Specific Information

Social media messages can be submitted to your social media channels to make announcements about your products or company.

SELECT

When selecting social media messages, data can be filtered by the MessageGUID or by a combination of Status, ChannelGUID, and TriggerAt. For example:

SELECT * FROM SocialMediaMessages WHERE MessageGUID = '123456789'
SELECT * FROM SocialMediaMessages WHERE Status = 'WAITING' AND ChannelGUID = '123456789' AND TriggerAt > '1/30/2015'

Note that TriggerAt can only be used with the > or >= comparison.

Columns


Name	Type	ReadOnly	References	Description
MessageGUID [KEY]	String	True		Unique identifier (GUID) for the social media message.
ContentBody	String	False		The main text content of the social media message.
ContentOriginalBody	String	False		Original unaltered text content of the message, before any modifications.
ContentPhotoUrl	String	False		URL pointing to the photo or image associated with the social media message.
ContentUncompressedLinks	String	False		List of any unshortened (uncompressed) links included in the message content.
TriggerAt	Datetime	False		The scheduled date and time when the social media message is set to be published.
Channel	String	True		The name of the social media channel (such as Facebook or LinkedIn) where the message will be posted.
ChannelGUID	String	False		GUID for the social media channel associated with the message.
CampaignGUID	String	True		GUID referencing the marketing campaign linked to the social media message.
CampaignName	String	True		Name of the marketing campaign associated with the social media message.
Clicks	Long	True		The total number of clicks recorded by HubSpot for links included in the social media message.
ClientTag	String	True		Tags or labels assigned by the client for categorizing or identifying the message.
CreatedAt	Datetime	True		Timestamp showing when the social media message was created.
CreatedBy	Long	True		ID of the user who created the social media message.
FinishedAt	Datetime	True		Timestamp indicating when the social media message finished posting.
ForeignId	String	True		Optional foreign identifier used to reference the message externally.
GroupGUID	String	True		GUID referencing the group associated with the social media message.
IsFailed	Boolean	True		Boolean indicating whether the social media message failed to post.
IsPending	Boolean	True		Boolean indicating whether the message is still pending and awaiting publication.
IsPublished	Boolean	True		Boolean indicating whether the message has been successfully published.
IsRetry	Boolean	True		Boolean indicating whether the message is currently being retried after a failure.
Message	String	True		Message returned by the social media platform, which can contain confirmation or error details.
MessageUrl	String	True		URL returned by the social media platform, typically pointing to the published post or error message.
RemoteContentId	String	True		ID referencing the remote content linked to the social media message, if applicable.
RemoteContentType	String	True		Type of remote content (such as image or video) associated with the message, if any.
Status	String	True		Current status of the social media message (such as SUCCESS, ERROR, or PENDING). 使用できる値は次のとおりです。SUCCESS, WAITING, CANCELED, ERROR_FATAL
UpdatedBy	Long	True		ID of the user who last modified or updated the social media message.
ExtraUrlParameters	String	True		Optional input-only property for specifying additional query parameters. Format parameters as name=value pairs separated by commas (for example: 'param1=value1, param2=value2, param3=value3').

TicketProperties

Lists all properties related to tickets, both default and custom, used for managing customer support cases.

Table Specific Information

Ticket properties are a number of custom properties that are available to store data about the tickets in your HubSpot Hub. Some of these properties are added by HubSpot and cannot be deleted. They will be automatically added to the Tickets on a new connection.

SELECT

Ticket properties can only be filtered by the unique ticket property name. For example:

SELECT * FROM TicketProperties WHERE Name = 'property_name'

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		Unique identifier for the ticket property. Must consist of lowercase letters and numbers, beginning with a letter.
Label	String	False		The display name of the ticket property as shown in the HubSpot interface.
FieldType	String	False		Specifies the input field type (such as text, dropdown, or checkbox) used for this ticket property in forms or UI. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox
Type	String	False		Defines the backend data type used to store the ticket property (such as string, number, or boolean). 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False		The property group this ticket property belongs to, used for categorization.
Description	String	False		A detailed explanation of the purpose and usage of the ticket property.
DisplayMode	String	False		Defines how the ticket property appears in the user interface, such as editable or read-only.
DisplayOrder	Integer	False		Specifies the order in which this property is displayed relative to other properties within the same group.
ExternalOptions	Boolean	False		Boolean indicating whether the property uses externally managed selectable options (such as dropdown values linked externally).
IsFormField	Boolean	False		Boolean indicating whether the ticket property is available as an input field in forms.
IsCalculated	Boolean	False		Indicates whether the property is calculated based on other data points.
IsHidden	Boolean	False		Boolean specifying whether the ticket property is hidden from view in the HubSpot UI.
IsFavorited	Boolean	False		Marks whether the property is marked as a favorite, giving it priority display in the UI.
FavoritedOrder	Integer	False		Order in which favorited properties appear when multiple properties are favorited.
MutableDefinitionNotDeletable	Boolean	False		Boolean specifying whether the property can be modified but cannot be deleted.
ReadOnlyDefinition	Boolean	False		Boolean indicating whether the property's definition (its structure) is locked and cannot be edited.
ReadOnlyValue	Boolean	False		Boolean specifying whether the value of the property is read-only and cannot be updated.
OptionsAggregate	String	False		Comma-separated list of selectable options available for properties like radio buttons or checkboxes.
ExtraUrlParameters	String	True		Optional input-only parameter for adding extra query parameters when retrieving data. Format parameters as name=value pairs separated by commas (for example: 'param1=value1, param2=value2, param3=value3'.)

TicketPropertyGroups

Returns property groups associated with ticket records, helping organize ticket properties logically.

Table Specific Information

Ticket property groups offer a means of organizing the various custom properties that are available for defining properties about a given ticket. Ticket property groups can be selected, inserted, updated, or deleted from this table.

SELECT

Ticket property groups can only be filtered by the unique ticket property group name. For example:

SELECT * FROM TicketPropertyGroups WHERE Name = 'property_group_name'

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		The unique name used to identify the ticket property group. Typically used for grouping related ticket properties in HubSpot.
DisplayName	String	False		The user-friendly label displayed for the ticket property group in HubSpot's interface.
DisplayOrder	Integer	False		The order in which this ticket property group is displayed relative to other groups within HubSpot.
IsHubspotDefined	Boolean	True		Boolean indicating whether the ticket property group is predefined by HubSpot or custom-defined by the user.
ExtraUrlParameters	String	True		Optional input-only parameter used to pass additional query parameters when retrieving data. Specify parameters as name=value pairs separated by commas (for example: 'param1=value1, param2=value2, param3=value3'.)

Tickets

Retrieves all ticket records from a HubSpot portal, used for customer support and issue tracking.

Table Specific Information

Tickets, along with contacts, companies and deals, are a foundational object in HubSpot CRM. A ticket represents a customer request for help, support, service, or a response, and the responses generated in reply to this request. Tickets are similar to companies: They both have a number of custom properties that will be dynamically determined and added to the table from your HubSpot Hub.

SELECT

When selecting Tickets, they can only be filtered by the Id. The accepted filters are illustrated below:

SELECT * FROM Contacts WHERE Id = 123456789
SELECT * FROM Contacts WHERE Id IN (123, 456)

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	False		The unique internal ID assigned to the ticket in HubSpot.
PortalId	Long	False		The HubSpot Portal ID (Hub ID) associated with the ticket, indicating which account the ticket belongs to.
Version	Long	False		The version number of the ticket record. This increments each time the ticket is updated, allowing for version tracking.
IsDeleted	Boolean	False		Boolean indicating whether the ticket has been marked as deleted. Deleted tickets are excluded from query results unless explicitly requested.

Workflows

Manages and retrieves workflows configured in HubSpot to automate marketing, sales, and service processes.

Table Specific Information

Workflows are automated tasks in HubSpot. You can perform automated tasks with contacts by enrolling contacts in workflows.

SELECT

When selecting workflows, data may be filtered by the WorkflowId. For example:

SELECT * FROM Workflows WHERE WorkflowId = '123456789'

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		Unique identifier assigned to the workflow.
Name	String	False		The user-friendly name assigned to the workflow, displayed in HubSpot.
Description	String	False		Detailed explanation of the workflow's purpose or objective.
IsEnabled	Boolean	False		Boolean indicating whether the workflow is currently active and can execute.
CreatedAt	Datetime	True		Timestamp indicating when the workflow was initially created.
UpdatedAt	Datetime	True		Timestamp indicating the most recent update made to the workflow.
AllowContactToTriggerMultipleTimes	Boolean	False		Boolean specifying whether the same contact can trigger and be enrolled in this workflow multiple times.
CanEnrollFromSalesforce	Boolean	False		Boolean indicating whether contacts can be enrolled into this workflow via Salesforce integration.
IsInternal	Boolean	False		Boolean flag showing whether the workflow is internal and not user-facing.
LegacyCampaignId	Long	False		Identifier for any legacy campaign associated with the workflow, if applicable.
LegacyMigration	Boolean	False		Boolean indicating whether this workflow was migrated from HubSpot's legacy lead nurturing tool.
IsListening	Boolean	False		Boolean specifying whether the workflow is actively monitoring for trigger conditions.
ContactListIdsCompleted	Long	True		ID referencing the list of contacts who have completed the workflow.
ContactListIdsEnrolled	Long	True		ID referencing the list of contacts currently enrolled in the workflow.
ContactListIdsSucceeded	Long	True		ID referencing the list of contacts who successfully completed all steps in the workflow.
ContactListIdsActive	Long	True		ID referencing the list of contacts currently active within the workflow.
StepsAggregate	String	False		Aggregate containing the ordered steps and actions defined within the workflow.
SupresssionSettingsAggregate	String	False		Aggregate defining suppression settings used to prevent specific contacts from entering the workflow.
TriggersAggregate	String	False		Aggregate listing the trigger conditions that enroll contacts into the workflow.
UnenrollmentSettingType	String	False		Defines how unenrollment is handled when a contact meets specific conditions.
UnenrollmentSettingExcludedWorkflowsAggregate	String	False		Aggregate listing workflows from which a contact should be removed upon enrolling in this workflow.
GoalListAggregate	String	False		Aggregate listing the goal IDs associated with this workflow, used to measure its success.
ExtraUrlParameters	String	True		Optional input-only property for adding additional query parameters when querying workflow data. Format parameters as name=value pairs separated by commas (for example: 'param1=value1, param2=value2, param3=value3').

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - HubSpot ビュー


Name	Description
AnalyticsBreakdowns	Provides detailed analytics segmented by specific categories, useful for performance comparisons across different dimensions.
AnalyticsContents	Returns analytics data for all HubSpot-hosted content, including websites, landing pages, and blogs, offering insights into content engagement.
AnalyticsEventCompletions	Tracks and retrieves analytics related to the completion of events, helping measure conversion actions within HubSpot.
AnalyticsForms	Accesses analytics data for HubSpot form submissions to evaluate form engagement and performance.
AnalyticsSessions	Breaks down analytics data by user sessions, providing visibility into visitor behavior across sessions.
AnalyticsSocialAssists	Aggregates analytics data for social media interactions, specifically focusing on social assists contributing to conversions.
AnalyticsViews	Lists configured analytics views within the HubSpot portal, providing information on available analytics perspectives.
BlogAuthors	Fetches a list of blog authors registered in HubSpot, helpful for managing and attributing blog content.
BlogPosts	Retrieves all blog posts created in HubSpot, allowing management and analysis of blog performance.
Blogs	Returns all blogs configured in HubSpot, offering visibility into blog structures and content.
BlogTopics	Lists all blog topics available in HubSpot, used to categorize and organize blog posts effectively.
Comments	Retrieves comments submitted on HubSpot blog posts, useful for engagement monitoring and moderation.
CompanyPropertiesHistory	Displays historical changes of company properties, useful for auditing and tracking property value trends.
ContactFormSubmissions	Lists form submissions made by contacts, useful for analyzing contact engagement through forms.
ContactIdentityProfiles	Displays identity profiles associated with contacts, helping track multiple identities linked to a single contact.
ContactPropertiesHistory	Shows historical values of contact properties, useful for tracking data changes and trends over time.
ContactStatistics	Summarizes key contact statistics such as total counts and latest additions, providing quick contact insights.
DealPipelines	Organizes deals into pipelines representing various sales stages to track deal progress and forecast revenue.
DealPipelineStages	Defines stages within a deal pipeline, offering structure to sales processes and enabling stage-based reporting.
DealPropertiesHistory	Displays the history of changes made to deal properties, useful for auditing and understanding deal evolution.
DealStages	Lists stages available for a deal, representing the progression steps in the sales funnel.
Domains	Returns domain records configured within HubSpot, useful for managing connected websites and email domains.
EmailCampaignEvents	Fetches event-level data related to email campaigns, allowing detailed tracking of recipient interactions.
EmailCampaigns	Provides details about email marketing campaigns managed within HubSpot, supporting campaign tracking and analysis.
EmailSubscriptionTypes	Returns all email subscription types configured in HubSpot, used for categorizing communication preferences.
EngagementScheduledTasks	Lists tasks that are scheduled as part of an engagement, useful for task management and follow-ups.
EngagementsScheduledTasks	List of tasks scheduled for an engagement.
Enrollments	Retrieves workflows in which a contact is actively enrolled, aiding in workflow monitoring and automation analysis.
Events	Returns definitions for all configured events in a portal, essential for event tracking and reporting.
Files	Provides metadata about files stored in HubSpot's file manager, enabling file management and auditing.
Folders	Retrieves folder structures in HubSpot's file manager, useful for organizing and accessing stored files.
FormFields	Returns details about form fields within HubSpot forms, supporting form customization and data collection.
FormSubmissions	Fetches submission data for specified forms, useful for analyzing form performance and lead generation.
Pages	Retrieves all pages created within HubSpot, including website, landing, and blog pages.
SocialMediaChannels	Lists social media channels connected to HubSpot, supporting social media engagement tracking.
Templates	Retrieves available email templates in HubSpot, facilitating standardized communication design.
UrlMappings	Lists all URL mappings configured within HubSpot, useful for managing redirects and vanity URLs.

AnalyticsBreakdowns

Provides detailed analytics segmented by specific categories, useful for performance comparisons across different dimensions.

Table Specific Information

Get analytics data broken down by the specified category.

SELECT

When selecting analytics by breakdown category, they can only be filtered by the StartDate, EndDate, Granularity, BreakdownBy, Filter, FirstDrilldown, SecondDrilldown, Exclude, FilterId, Sort or SortDirection. Defaults to the Totals dimension. The filters must use an exact comparison. For example:

SELECT Totals FROM AnalyticsBreakdowns WHERE Granularity = 'total' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'
SELECT Sources FROM AnalyticsBreakdowns WHERE Granularity = 'total' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'
SELECT Geolocation FROM AnalyticsBreakdowns WHERE Granularity = 'monthly' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018' AND Filter = 'hubspot'

Columns


Name	Type	References	Description
Totals	String		Displays the total aggregated metrics for all breakdown categories.
Sources	String		Shows data segmented by the source of website traffic, such as direct, referral, organic search, or paid ads.
Geolocation	String		Presents data categorized by the geographic location of visitors, useful for regional performance analysis.
UtmCampaigns	String		Breaks down data based on the Urchin Tracking Module (UTM) campaign tracking parameter used in your marketing URLs.
UtmContents	String		Segments data by the UTM content tracking parameter, which differentiates variations of ads or links.
UtmMediums	String		Categorizes data according to the UTM medium parameter, specifying the marketing channel like email or cost per click (CPC).
UtmSources	String		Organizes data by the UTM source parameter, identifying the source platform like Google or Facebook.
UtmTerms	String		Groups data by the UTM term parameter, typically used to capture specific keywords for paid search campaigns.
FirstDrilldown	String		Provides the primary drilldown level, reflecting detailed source categories as seen in HubSpot's source reports.
SecondDrilldown	String		Offers a secondary drilldown level, enabling deeper segmentation within source categories in reports.
BounceRate	Double		Percentage of sessions that result in a bounce, indicating visitors who leave without interacting further.
ContactToCustomerRate	Double		Percentage of contacts that convert into customers, highlighting contact-to-customer conversion performance.
Contacts	Long		Total number of contacts generated within the reporting period.
Customers	Long		Total number of customers acquired during the reporting period.
Leads	Long		Total number of leads identified in the system.
MarketingQualifiedLeads	Long		Number of leads categorized as more likely to convert into customers, marked as marketing qualified leads.
NewVisitorSessionRate	Double		Percentage of new visitor sessions, indicating the proportion of first-time visitor engagement.
Opportunities	Long		Total number of sales opportunities created in the reporting period.
PageviewsPerSession	Double		Average number of pageviews per session, measuring user engagement depth.
RawViews	Long		Total number of raw pageviews recorded, unfiltered by session or visitor criteria.
SalesQualifiedLeads	Long		Number of sales-qualified leads, representing prospects ready for direct sales engagement.
SessionToContactRate	Double		Percentage showing how many sessions resulted in a contact being generated.
Subscribers	Long		Total number of subscribers added during the reporting period.
TimePerSession	Double		Average time visitors spend per session, indicating engagement duration.
Visitors	Long		Total number of unique visitors within the reporting timeframe.
Visits	Long		Total number of visits, which may include repeat visits by the same visitor.
BreakdownDate	Date		Start date of the breakdown data aggregation period. Applicable for these granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
StartDate	Date		Specifies the starting date of the query range to filter results.
EndDate	Date		Specifies the ending date of the query range to limit results.
Granularity	String		Defines the time interval for data grouping. Acceptable values include total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filters results to include only records matching the specified breakdowns. Multiple filters can be applied.
Exclude	String		Excludes records matching the specified breakdowns from the results. Multiple exclusions are supported.
FilterId	String		Specifies the ID of a HubSpot Analytics view. Filters the returned data to match the selected view.

AnalyticsContents

Returns analytics data for all HubSpot-hosted content, including websites, landing pages, and blogs, offering insights into content engagement.

Table Specific Information

Get analytics data for your HubSpot hosted content. This would include your website and landing pages, as well as any blog pages hosted on HubSpot.

SELECT

When selecting analytics by content type, they can only be filtered by the StartDate, EndDate, Granularity, ContentType, Filter, Exclude, FilterId, Sort or SortDirection. Defaults to the StandardPages dimension. The filters must use an exact comparison. For example:

SELECT LandingPages FROM AnalyticsContents WHERE Granularity = 'total' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'
SELECT ListingPages FROM AnalyticsContents WHERE Granularity = 'total' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'
SELECT BlogPosts FROM AnalyticsContents WHERE Granularity = 'total' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018' AND Filter = 'hubspot'

Columns


Name	Type	References	Description
LandingPages	String		Retrieves analytics data specifically for landing pages, useful for lead generation performance tracking.
StandardPages	String		Retrieves data for standard website pages, helping measure general website engagement.
BlogPosts	String		Provides analytics for individual blog posts, useful for tracking blog post popularity and engagement.
ListingPages	String		Retrieves data for blog listing pages, offering insights into overall blog category performance.
KnowledgeArticles	String		Provides analytics data for knowledge base articles, supporting content effectiveness analysis.
AllPages	String		Returns data for all tracked URLs where HubSpot's tracking code is installed, broken down by each URL.
Contacts	Long		Displays the total number of new contacts generated from page views during the reporting period.
ContactsPerPageview	Double		Shows the ratio of contacts generated per raw page view, indicating lead conversion efficiency.
CtaViews	Long		Total number of views on Calls-to-Action (CTAs) placed on pages, useful for CTA engagement analysis.
Entrances	Long		Counts how many times visitors entered the website through a specific page, representing entry points.
Exits	Long		Counts how many times visitors exited the website from a specific page.
ExitsPerPageview	Double		Ratio of page exits compared to total page views, helpful for understanding drop-off points.
Leads	Long		Total number of leads captured through forms or other conversion points on the page.
PageBounceRate	Double		Bounce rate specific to the page, representing the percentage of single-page sessions.
PageBounces	Long		Total number of times visitors bounced (left without interaction) from the page.
PageTime	Long		Total time visitors spent on the page, measured in seconds.
RawViews	Long		Total number of raw page views recorded, regardless of visitor uniqueness.
Submissions	Long		Total number of form submissions or conversions completed on the page.
SubmissionsPerPageview	Double		Ratio of submissions completed per page view, used to measure conversion effectiveness.
TimePerPageview	Double		Average time spent per page view, indicating visitor engagement duration.
BreakdownDate	Date		Start date of the breakdown data aggregation period. Applicable for these granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
StartDate	Date		Specifies the starting date of the query range to filter results.
EndDate	Date		Specifies the ending date of the query range to limit results.
Granularity	String		Defines the time interval for data grouping. Acceptable values include total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filters results to include only records matching the specified breakdowns. Multiple filters can be applied.
Exclude	String		Excludes records matching the specified breakdowns from the results. Multiple exclusions are supported.
FilterId	String		Specifies the ID of a HubSpot Analytics view. Filters the returned data to match the selected view.

AnalyticsEventCompletions

Tracks and retrieves analytics related to the completion of events, helping measure conversion actions within HubSpot.

Table Specific Information

Get analytics data for event completion objects.

SELECT

When selecting analytics for event completions, they can only be filtered by the StartDate, EndDate, Granularity, Filter, Exclude, FilterId, Sort or SortDirection. The filters must use an exact comparison. For example:

SELECT * FROM AnalyticsEventCompletions WHERE Granularity = 'total' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'
SELECT * FROM AnalyticsEventCompletions WHERE Granularity = 'summarize/weekly' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'

Columns


Name	Type	References	Description
EventCompletions	String		Provides the name or category of the completed event being tracked in the analytics data.
Completions	Long		Displays the total number of times the event was completed within the specified timeframe.
BreakdownDate	Date		Start date of the breakdown data aggregation period. Applicable for these granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
StartDate	Date		Specifies the starting date of the query range to filter the event completion data.
EndDate	Date		Specifies the ending date of the query range to limit the event completion data.
Granularity	String		Defines the time interval for data grouping. Acceptable values include total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filters results to include only records matching the specified breakdowns. Multiple filters can be applied.
Exclude	String		Excludes records matching the specified breakdowns from the results. Multiple exclusions are supported.
FilterId	String		Specifies the ID of a HubSpot Analytics view. Filters the returned data to match the selected view.

AnalyticsForms

Accesses analytics data for HubSpot form submissions to evaluate form engagement and performance.

Table Specific Information

Get analytics data for form objects.

SELECT

When selecting analytics for forms, they can only be filtered by the StartDate, EndDate, Granularity, Filter, Exclude, FilterId, Sort or SortDirection. The filters must use an exact comparison. For example:

SELECT * FROM AnalyticsForms WHERE Granularity = 'summarize/monthly' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'
SELECT * FROM AnalyticsForms WHERE Granularity = 'total' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018 AND Sort = 'FormViews''

Columns


Name	Type	References	Description
Forms	String		Provides the name or identifier of each form being analyzed for performance metrics.
Completions	Long		Displays the total number of times the form has been successfully completed by users.
FormViews	Long		Counts the number of times the form has been viewed by visitors.
Installs	Long		Shows the total number of times the form has been installed or embedded on a page.
Interactions	Long		Counts the total number of interactions users had with the form, including clicks or field entries.
Submissions	Long		Total number of form submissions completed by users.
Visibles	Long		Counts how many times the form was visible to visitors on the page, regardless of interaction.
BreakdownDate	Date		Start date of the breakdown data aggregation period. Applicable for these granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
StartDate	Date		Specifies the starting date of the query range to filter form analytics data.
EndDate	Date		Specifies the ending date of the query range to limit the form analytics data.
Granularity	String		Defines the time interval for data grouping. Acceptable values include total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filters results to include only records matching the specified breakdowns. Multiple filters can be applied.
Exclude	String		Excludes records matching the specified breakdowns from the results. Multiple exclusions are supported.
FilterId	String		Specifies the ID of a HubSpot Analytics view. Filters the returned data to match the selected view.

AnalyticsSessions

Breaks down analytics data by user sessions, providing visibility into visitor behavior across sessions.

Table Specific Information

Get analytics data broken down by sessions.

SELECT

When selecting analytics for event completions, they can only be filtered by the StartDate, EndDate, Granularity, Filter, FirstDrilldown, SecondDrilldown, Exclude, FilterId, Sort or SortDirection. The filters must use an exact comparison. For example:

SELECT * FROM AnalyticsSessions WHERE Granularity = 'total' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'
SELECT * FROM AnalyticsSessions WHERE Granularity = 'monthly' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018' AND Filter = 'hubspot'

Columns


Name	Type	References	Description
Sessions	String		Provides the source category or type for each session tracked in the analytics data.
Desktop	Long		Total number of sessions initiated from desktop devices.
DirectTraffic	Long		Total number of sessions generated from direct traffic sources, where no referral information is available.
EmailMarketing	Long		Total number of sessions originating from email marketing campaigns.
Mobile	Long		Total number of sessions initiated from mobile devices.
OrganicSearch	Long		Total number of sessions from organic search results on search engines.
OtherCampaigns	Long		Total number of sessions from campaigns categorized under 'Other Campaigns'.
Others	Long		Total number of sessions categorized under 'Other' sources not classified elsewhere.
PaidSearch	Long		Total number of sessions originating from paid search campaigns, such as Google Ads.
PaidSocial	Long		Total number of sessions originating from paid social media advertising.
Referrals	Long		Total number of sessions referred from external websites.
SocialMedia	Long		Total number of sessions originating from social media platforms such as Facebook, Twitter, or LinkedIn.
FirstDrilldown	String		Primary drilldown parameter for segmenting session data, reflecting source report functionality.
SecondDrilldown	String		Secondary drilldown parameter for further segmenting session data, similar to FirstDrilldown.
BreakdownDate	Date		Start date of the breakdown data aggregation period. Applicable for these granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
StartDate	Date		Specifies the starting date of the query range to filter session data.
EndDate	Date		Specifies the ending date of the query range to limit session data.
Granularity	String		Defines the time interval for data grouping. Acceptable values include total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filters results to include only records matching the specified breakdowns. Multiple filters can be applied.
Exclude	String		Excludes records matching the specified breakdowns from the results. Multiple exclusions are supported.
FilterId	String		Specifies the ID of a HubSpot Analytics view. Filters the returned data to match the selected view.

AnalyticsSocialAssists

Aggregates analytics data for social media interactions, specifically focusing on social assists contributing to conversions.

Table Specific Information

Get analytics data for social assist objects.

SELECT

When selecting analytics for event completions, they can only be filtered by the StartDate, EndDate, Granularity, Filter, Exclude, FilterId, Sort or SortDirection. The filters must use an exact comparison. For example:

SELECT * FROM AnalyticsSocialAssists WHERE Granularity = 'total' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'
SELECT * FROM AnalyticsSocialAssists WHERE Granularity = 'summarize/weekly' AND StartDate = '12/1/2017' AND EndDate = '12/30/2018'

Columns


Name	Type	References	Description
SocialAssists	String		Provides the name or category of social assists, representing interactions on social platforms contributing to conversions.
RawViews	Long		Total number of raw views recorded from social media interactions, unfiltered by session or visitor uniqueness.
BreakdownDate	Date		Start date of the breakdown data aggregation period. Applicable for these granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
StartDate	Date		Specifies the starting date of the query range to filter social assists data.
EndDate	Date		Specifies the ending date of the query range to limit social assists data.
Granularity	String		Defines the time interval for data grouping. Acceptable values include total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filters results to include only records matching the specified breakdowns. Multiple filters can be applied.
Exclude	String		Excludes records matching the specified breakdowns from the results. Multiple exclusions are supported.
FilterId	String		Specifies the ID of a HubSpot Analytics view. Filters the returned data to match the selected view.

AnalyticsViews

Lists configured analytics views within the HubSpot portal, providing information on available analytics perspectives.

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier for the analytics view record.
Title	String		Descriptive title assigned to the analytics view for easy identification.
CreatorId	Long		Unique identifier of the user who created the analytics view.
CreatedAt	Date		Timestamp indicating when the analytics view was originally created.
UpdaterId	Long		Unique identifier of the user who last updated the analytics view.
UpdatedDate	Date		Timestamp indicating the last update made to the analytics view.
DeletedAt	Date		Timestamp marking when the analytics view was deleted, if applicable.
ContainsLegacyReportProperties	Boolean		Indicates whether the analytics view includes legacy report properties.
ReportPropertyFiltersAggregate	String		Aggregate string representing the filters applied to report properties in the analytics view.

BlogAuthors

Fetches a list of blog authors registered in HubSpot, helpful for managing and attributing blog content.

Table Specific Information

Blog authors represent the users in your HubSpot Hub that can make posts on your HubSpot blog.

SELECT

When selecting blog authors, they can only be filtered by the Id, FullName, CreatedAt, or Slug. CreatedAt can be used to specify a range while the others must be used with an exact comparison. For example:

SELECT * FROM BlogAuthors WHERE CreatedAt >= '1/1/2014' AND CreatedAt <= '10/31/2014'
SELECT * FROM BlogAuthors WHERE Slug = 'abc123'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the blog author.
FullName	String		The full name of the blog author, including both first and last names.
CreatedAt	Datetime		Timestamp indicating when the blog author record was first created in HubSpot.
Slug	String		URL-friendly path appended to the blog URL where the author's profile page is accessible.
DeletedAt	Datetime		Timestamp indicating when the blog author was marked as deleted, if applicable.
Email	String		Email address associated with the blog author for identification or contact.
FacebookProfile	String		URL of the blog author's Facebook profile page.
GooglePlusProfile	String		URL of the blog author's Google Plus profile page.
LinkedInProfile	String		URL of the blog author's LinkedIn profile page.
TwitterProfile	String		Twitter handle of the blog author, typically used for social media linking.
AvatarUrl	String		URL of the author's avatar image, typically a small profile photo.
UserId	Long		HubSpot user ID linked to the blog author account.
Username	String		HubSpot username linked to the blog author's account.
Website	String		URL of the blog author's personal or professional website.
UpdatedAt	Datetime		Timestamp indicating the last time the blog author's record was updated.
ExtraUrlParameters	String		Optional input-only parameter to specify additional query parameters when retrieving blog author data. Format: 'param1=value1, param2=value2, param3=value3'.

BlogPosts

Retrieves all blog posts created in HubSpot, allowing management and analysis of blog performance.

Table Specific Information

Blog posts represent the individual posts in your HubSpot blog.

SELECT

When selecting blog posts, they can only be filtered by the Id, BlogAuthorId, ArchivedInDashboard, CampaignId, ContentGroupId, CreatedAt, ArchivedAt, Name, Slug, and UpdatedAt columns. CreatedAt, ArchivedAt, and UpdatedAt can be used with > and < where a range can be formed with CreatedAt and UpdatedAt. In addition, Name can be used with the LIKE comparison. All others must be used with an exact comparison. For example:

SELECT * FROM BlogPosts WHERE CreatedAt >= '1/1/2014' AND CreatedAt <= '10/31/2014'
SELECT * FROM BlogPosts WHERE UpdatedAt >= '1/1/2014' AND UpdatedAt <= '10/31/2014'
SELECT * FROM BlogPosts WHERE ArchivedAt >= '1/1/2014'
SELECT * FROM BlogPosts WHERE Name LIKE 'My Post'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the blog post.
AuthorUserId	Long		HubSpot user ID of the author who created the blog post.
AuthorName	String		Username of the blog author in HubSpot.
BlogAuthorId	Long	BlogAuthors.Id	Unique identifier of the blog author record. Cross-reference with the blog authors table.
CampaignId	String	EmailCampaigns.Id	GUID of the marketing campaign associated with the blog post, if applicable.
ContentGroupId	Long		Unique identifier of the blog to which this post belongs. Retrieved via the blog API.
TopicIds	String		Comma-separated list of topic IDs associated with the blog post.
CreatedAt	Datetime		Timestamp indicating when the blog post was originally created.
ArchivedAt	Datetime		Timestamp marking when the blog post was archived or deleted, if applicable.
ArchivedInDashboard	Boolean		Indicates whether the post is hidden from the dashboard while still being live on the site.
Name	String		Internal name assigned to the blog post for organizational purposes.
Slug	String		URL path where the blog post will be accessible.
UpdatedAt	Datetime		Timestamp indicating the last update made to the blog post.
PublishedAt	Datetime		Timestamp indicating when the blog post was published and made live.
PostSummary	String		Short summary of the blog post, displayed on the main blog listing page.
PostBody	String		HTML content of the main body of the blog post.
Url	String		Full URL including domain and protocol for accessing the blog post. Returns a 404 error code if unpublished.
ExtraUrlParameters	String		Optional input-only parameter to specify additional query parameters when retrieving blog post data. The format is: 'param1=value1, param2=value2, param3=value3'.

Blogs

Returns all blogs configured in HubSpot, offering visibility into blog structures and content.

Table Specific Information

SELECT

When selecting blogs, they can only be filtered by the Id, Name, and CreatedAt. CreatedAt can be used to specify a range. For example:

SELECT * FROM Blogs WHERE CreatedAt >= '1/1/2014' AND CreatedAt <= '10/31/2014'
SELECT * FROM Blogs WHERE Name = 'myblog'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the blog record.
Name	String		Internal name of the blog used for organizational and reference purposes.
AllowComments	Boolean		Indicates whether comments are enabled for posts on the blog.
CommentShouldCreateContact	Boolean		Determines whether commenters' email addresses not already in HubSpot should be automatically added as contacts.
CreatedAt	Datetime		Timestamp indicating when the blog record was originally created.
HTMLTitle	String		HTML title tag of the blog, displayed in the browser's title bar and search engine results.
Language	String		Language setting of the blog, specifying the primary language used for content.
PostsPerListingPage	Long		Number of blog posts displayed per page in the standard HTML blog view.
PostsPerRSSFeed	Long		Number of blog posts included per page in the blog's RSS feed.
PublicTitle	String		Public-facing header or title of the blog, visible to readers.
RootURL	String		Full URL including domain and protocol where the blog is hosted.
ShowSocialLinkFacebook	Boolean		Indicates whether a Facebook social sharing link should be displayed on the blog.
ShowSocialLinkGoogle	Boolean		Indicates whether a Google Plus social sharing link should be displayed on the blog.
ShowSocialLinkLinkedIn	Boolean		Indicates whether a LinkedIn social sharing link should be displayed on the blog.
ShowSocialLinkTwitter	Boolean		Indicates whether a Twitter social sharing link should be displayed on the blog.
Slug	String		URL path where the blog is accessible.
UpdatedAt	Datetime		Timestamp indicating when the blog record was last updated.
ExtraUrlParameters	String		Optional input-only property to specify additional query parameters when retrieving blog data. Format: 'param1=value1, param2=value2, param3=value3'.

BlogTopics

Lists all blog topics available in HubSpot, used to categorize and organize blog posts effectively.

Table Specific Information

Blog topics represent any number of topics a blog post can be posted under.

SELECT

When selecting blogs, they can only be filtered by the Id, Name, Slug, and CreatedAt. CreatedAt can be used to specify a range. For example:

SELECT * FROM BlogTopics WHERE CreatedAt >= '1/1/2014' AND CreatedAt <= '10/31/2014'
SELECT * FROM BlogTopics WHERE Name = 'mytopic'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the blog topic.
CreatedAt	Datetime		Timestamp indicating when the blog topic was originally created.
DeletedAt	Datetime		Timestamp marking when the blog topic was deleted, if applicable.
Description	String		Descriptive text explaining the purpose or focus of the blog topic.
Name	String		Name of the blog topic, used to categorize blog posts.
Slug	String		URL-friendly slug that determines how the topic appears in the URL path.
UpdatedAt	Datetime		Timestamp indicating the last time the blog topic record was updated.
ExtraUrlParameters	String		Optional input-only property to specify additional query parameters when retrieving blog topic data. Format: 'param1=value1, param2=value2, param3=value3'.

Comments

Retrieves comments submitted on HubSpot blog posts, useful for engagement monitoring and moderation.

Table Specific Information

Comments represent any comments that can be made on a given blog post.

SELECT

When selecting comments, they can only be filtered by the Id, State, PostId, and Comment. Comment can be used with the LIKE comparison. For example:

SELECT * FROM Comments WHERE Comment LIKE 'comment text'
SELECT * FROM Comments WHERE Id = '123456789'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the comment record.
State	String		Current moderation state of the comment, such as approved or pending. 使用できる値は次のとおりです。APPROVED, SPAM, REJECTED, PENDING_MODERATION
PostId	Long	BlogPosts.Id	Identifier of the parent blog post to which the comment belongs.
Comment	String		Full text content submitted as the comment.
CommentAuthorEmail	String		Email address provided by the user who submitted the comment.
CommentAuthorName	String		Name provided by the user who submitted the comment.
ContentPermalink	String		Permanent URL link to the parent blog post associated with the comment.
ContentTitle	String		Title of the blog post where the comment was made.
CreatedAt	Datetime		Timestamp indicating when the comment was created.
DeletedAt	Datetime		Timestamp indicating when the comment was deleted, if applicable.
FirstName	String		First name of the user who submitted the comment, if provided.
LastName	String		Last name of the user who submitted the comment, if provided.
UserEmail	String		Email address of the user who submitted the comment (duplicate of CommentAuthorEmail).
UserUrl	String		URL of the user's personal or professional website, if provided.
ExtraUrlParameters	String		Optional input-only property to specify additional query parameters when retrieving comment data. Format: 'param1=value1, param2=value2, param3=value3'.

CompanyPropertiesHistory

Displays historical changes of company properties, useful for auditing and tracking property value trends.

Columns


Name	Type	References	Description
PropertyName	String		Name of the company property whose historical value is being tracked.
Value	String		The recorded historical value of the company property at a specific point in time.
Timestamp	Datetime		Timestamp indicating when the property value was updated.
Source	String		The method or source type responsible for updating the property value, such as API, form submission, or manual update.
SourceId	String		Additional details related to the source-type. May not always be populated depending on the source-type.
SourceVid	String		Identifier linking to the source event or user responsible for the property update, if applicable.
CompanyId	String		Unique identifier of the company associated with the property history record.

ContactFormSubmissions

Lists form submissions made by contacts, useful for analyzing contact engagement through forms.

Table Specific Information

A list of form submissions for the contact. This list will be empty for records with no form submissions.

SELECT

Contact form submissions can only be filtered by the unique contact id. For example:

SELECT * FROM ContactFormSubmissions  
SELECT * FROM ContactFormSubmissions WHERE ContactVID = '123456'

Columns


Name	Type	References	Description
ContactVID	Long	Contacts.VID	Unique identifier of the visitor ID (VID) associated with the form submission.
FormId	String	Forms.GUID	GUID of the form that the submission is linked to.
ConversionId	String		Unique identifier for the specific instance of the form conversion event.
PortalId	Long		Portal ID (Hub ID) of the HubSpot account where the submission was made.
Timestamp	Datetime		Timestamp indicating when the form submission occurred.
Title	String		Title of the page where the form submission took place.
PageId	Long	Pages.Id	Unique identifier of the page where the form was submitted.
PageTitle	String		Title of the page where the form was submitted.
PageURL	String		Full URL of the page where the form was submitted.

ContactIdentityProfiles

Displays identity profiles associated with contacts, helping track multiple identities linked to a single contact.

Table Specific Information

A list of objects representing the identities of the contact. Each identity represents an identifier for the object, many records will only have a single identity, but merged records may have multiple.

SELECT

Contact identity profiles can only be filtered by the unique contact id. For example:

SELECT * FROM ContactIdentityProfiles  
SELECT * FROM ContactIdentityProfiles WHERE ContactVID = '123456'

Columns


Name	Type	References	Description
ContactVID	Long	Contacts.VID	Unique identifier (visitor ID) of the contact associated with the identity profile.
Type	String		Specifies the type of identity, such as EMAIL or LEAD_GUID.
Value	String		Actual value of the identity, like the email address or lead GUID.
Timestamp	Datetime		Timestamp indicating when the identity profile was first created.
SavedAt	Datetime		Timestamp indicating when the identity profile was last updated.

ContactPropertiesHistory

Shows historical values of contact properties, useful for tracking data changes and trends over time.

Columns


Name	Type	References	Description
VID	Long	Contacts.VID	Unique identifier (visitor ID) of the contact associated with the property history record.
PropertyName	String		Name of the contact property whose historical value is being tracked.
Value	String		The recorded historical value of the contact property at a specific point in time.
Timestamp	Datetime		Timestamp indicating when the contact property value was updated.
SourceType	String		The method or source type responsible for updating the property value, such as API, form submission, or manual update.
SourceId	String		Additional details related to the source-type. May not always be populated depending on the source-type.
SourceLabel	String		Additional label or description related to the source-type. May not be populated for all source-types.

ContactStatistics

Summarizes key contact statistics such as total counts and latest additions, providing quick contact insights.

Columns


Name	Type	References	Description
LastNewContactAt	String		Timestamp indicating when the most recent new contact was added to HubSpot.
Contacts	String		Total count of all contacts currently stored in HubSpot.

DealPipelines

Organizes deals into pipelines representing various sales stages to track deal progress and forecast revenue.

Table Specific Information

Deal pipelines represent different types of pipelines deals and be placed into to track their progress.

SELECT

When selecting deal pipelines, they can only be filtered by the PipelineId. For example:

SELECT * FROM DealPipelines WHERE PipelineId = 12345

Columns


Name	Type	References	Description
PipelineId [KEY]	String		Unique identifier assigned to the deal pipeline.
PipelineName	String		Name of the deal pipeline as displayed in HubSpot.
IsActive	Boolean		Boolean flag indicating whether the pipeline is currently active.
StagesAggregate	String		Comma-separated list of stages included within the pipeline.

DealPipelineStages

Defines stages within a deal pipeline, offering structure to sales processes and enabling stage-based reporting.

Table Specific Information

Deal pipeline stages represent the individual stages of a given pipeline that a Deal may currently be on.

SELECT

When selecting deal pipeline stages, they can only be filtered by the PipelineId. For example:

SELECT * FROM DealPipelineStages WHERE PipelineId = 12345

Columns


Name	Type	References	Description
PipelineId [KEY]	String	DealPipelines.PipelineId	Unique identifier assigned to the deal pipeline.
StageId [KEY]	String		Unique identifier assigned to the specific stage in the pipeline.
PipelineName	String		Name of the deal pipeline as displayed in HubSpot.
PipelineIsActive	Boolean		Boolean flag indicating whether the pipeline is currently active.
StageName	String		Name of the individual stage within the deal pipeline.
StageIsActive	Boolean		Boolean flag indicating whether the stage is currently active.
StageClosedWon	Boolean		Boolean flag indicating whether the stage represents a closed and won deal.
StageDisplayOrder	Integer		Numeric value specifying the display order of the stage within the pipeline.
StageProbability	Double		Estimated probability percentage of successfully closing the deal at this stage.

DealPropertiesHistory

Displays the history of changes made to deal properties, useful for auditing and understanding deal evolution.

Columns


Name	Type	References	Description
SourceId	String		Additional details related to the source-type responsible for updating the deal property. May not be populated for all source-types.
SourceVid	String		List of VIDs for related contacts. Populated only when related contacts triggered the property value change.
PropertyName	String		Name of the deal property whose historical value is being tracked.
Value	String		The recorded historical value of the deal property at a specific point in time.
Timestamp	Datetime		Timestamp indicating when the property value was updated.
Source	String		The method or source type responsible for updating the property value, such as API, workflow, or manual update.
DealId	Long		Unique identifier of the deal associated with the property history record.

DealStages

Lists stages available for a deal, representing the progression steps in the sales funnel.

Columns


Name	Type	References	Description
DealId [KEY]	Long	Deals.DealId	Unique identifier assigned to the deal in HubSpot.
StageCreated [KEY]	Datetime		Timestamp indicating when the deal stage was created.
StageName	String		Name of the deal stage, such as 'Prospecting' or 'Closed Won'.
StageValue	String		The internal value assigned to the deal stage, used in automation or reporting.
StageSource	String		The source that triggered the creation or update of the deal stage, such as workflow, API, or manual entry.
StageSourceId	String		Identifier of the source entity responsible for the deal stage, if applicable.

Domains

Returns domain records configured within HubSpot, useful for managing connected websites and email domains.

Table Specific Information

Domains represent any domains you have registered with HubSpot to host your HubSpot blogs and content optimization system on.

SELECT

When selecting domains, they can only be filtered by the Id, CreatedAt, Domain, IsResolving, and PrimarySitePage columns. CreatedAt can be used with the > and < comparisons to form a range. For example:

SELECT * FROM Domains WHERE CreatedAt >= '1/1/2014' AND CreatedAt <= '10/31/2014'
SELECT * FROM Domains WHERE Id = '123456789'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the domain in HubSpot.
CreatedAt	Datetime		Timestamp indicating when the domain was first created.
Domain	String		The domain or subdomain name configured in HubSpot.
IsAnyPrimary	Boolean		Boolean flag indicating whether this domain is the primary domain for any category.
IsDNSCorrect	Boolean		Boolean flag indicating whether the domain name system (DNS) configuration is optimal for use with HubSpot.
IsLegacyDomain	Boolean		Boolean flag indicating whether the domain is configured for use with the legacy classic content management system (CMS).
IsResolving	Boolean		Boolean flag indicating whether the domain correctly points to HubSpot servers.
ManuallyMarkedAsResolving	Boolean		Boolean flag indicating whether a user manually marked the domain as resolving, typically used for custom setups involving proxies.
PrimaryBlogPost	Boolean		Boolean flag indicating whether this domain is the primary domain for content optimization system (COS) blog posts.
PrimaryEmail	Boolean		Boolean flag indicating whether this domain is the primary domain for viewing emails as web pages.
PrimaryLandingPage	Boolean		Boolean flag indicating whether this domain is the primary domain for COS landing pages.
PrimaryLegacyPage	Boolean		Boolean flag indicating whether this domain is the primary domain for the classic CMS.
PrimarySitePage	Boolean		Boolean flag indicating whether this domain is the primary domain for COS site pages.
SecondaryToDomain	String		The name of the primary domain that this non-primary domain redirects to, if applicable.
UpdatedAt	Datetime		Timestamp indicating when the domain was last updated.
ExtraUrlParameters	String		Optional input-only property to specify additional query parameters when retrieving domain data. Format: 'param1=value1, param2=value2, param3=value3'.

EmailCampaignEvents

Fetches event-level data related to email campaigns, allowing detailed tracking of recipient interactions.

Table Specific Information

Email campaign events represent individual events that occurred during an email campaign. These are generally events such as a contact clicking on a link that was included in the email.

SELECT

Email campaign events may be filtered by RecipientEmail, AppId, CampaignId, Type, and CreatedAt. Email campaign events can also be retrieved one at a time by specifying both the Id and CreatedAt, but the CreatedAt datetime will need to be correct to the millisecond. For example:

SELECT * FROM EmailCampaignEvents WHERE CreatedAt = '9/23/2014 5:28:00.280 PM' AND Id = '123456789'
SELECT * FROM EmailCampaignEvents WHERE CampaignId = '14229773' AND AppId = '113' AND Type = 'CLICK' AND CreatedAt > '9/23/2014 1:28:00 PM' AND CreatedAt < '9/23/2014 7:29:00 PM'

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier assigned to the email campaign event.
CampaignId	String	EmailCampaigns.Id	Identifier of the email campaign associated with this event.
Type	String		Specifies the type of event, such as open, click, bounce, or unsubscribe. 使用できる値は次のとおりです。SENT, DROPPED, PROCESSED, DELIVERED, DEFERRED, BOUNCE, OPEN, CLICK, PRINT, FORWARD, STATUSCHANGE, SPAMREPORT
RecipientEmail	String		Email address of the recipient involved in the event.
PortalId	Long		Unique identifier of the HubSpot account (portal) that sent the email.
AppId	Long		Identifier of the HubSpot application used to send the email message.
AppName	String		Name of the HubSpot application responsible for sending the email message. Can change over time.
CreatedAt	Datetime		Timestamp indicating when this event was created.
SentById	String		Unique identifier of the SENT event that corresponds to the email message.
SentByCreatedAt	Datetime		Timestamp when the email message's SENT event occurred.
ObsoletedById	String		Unique identifier of the follow-up event that made this current event obsolete.
ObsoletedByCreatedAt	Datetime		Timestamp when the event that obsoleted the current event occurred.
CausedById	String		Unique identifier of the event that directly caused this event.
CausedByCreatedAt	Datetime		Timestamp when the event that caused this event occurred.
Subject	String		Subject line of the email message.
From	String		Email address in the 'from' field of the email message.
ReplyTo	String		Email address in the 'reply-to' field of the email message.
Cc	String		List of email addresses in the 'cc' field of the email message.
Bcc	String		List of email addresses in the 'bcc' field of the email message.
DropReason	String		Reason explaining why the email message was dropped. 使用できる値は次のとおりです。PREVIOUSLY_BOUNCED, PREVIOUS_SPAM, PREVIOUSLY_UNSUBSCRIBED_MESSAGE, PREVIOUSLY_UNSUBSCRIBED_PORTAL, INVALID_TO_ADDRESS, INVALID_FROM_ADDRESS, BLOCKED_DOMAIN, BLOCKED_ADDRESS, EMAIL_UNCONFIRMED, CAMPAIGN_CANCELLED, MTA_IGNORE, PORTAL_OVER_LIMIT, PORTAL_SUSPENDED
DropMessage	String		Detailed message providing additional information on why the email message was dropped.
Category	String		Category describing the type of bounce encountered. Might be empty if undetermined. 使用できる値は次のとおりです。UNKNOWN_USER, MAILBOX_FULL, CONTENT, SPAM, POLICY, GREYLISTING, MAILBOX_MISCONFIGURATION, ISP_MISCONFIGURATION, DOMAIN_REPUTATION, DMARC, SENDING_DOMAIN_MISCONFIGURATION, TIMEOUT, THROTTLED, UNCATEGORIZED, IP_REPUTATION, DNS_FAILURE, TEMPORARY_PROBLEM
Response	String		Full response message received from the recipient's email server.
SmtpId	String		SMTP identifier attached to the message by HubSpot.
Attempt	Integer		The attempt number indicating how many times delivery was attempted.
Status	String		Status code returned by the recipient's email server.
DeviceType	String		Type of device used that triggered the event, if available.
HMID	String		Randomly generated identifier matching the 'X-HubSpot-MID' header in the email.
Referer	String		URL of the webpage that linked to the clicked URL. Value depends on recipient's email client.
Url	String		The URL clicked by the recipient within the email message.
UserAgent	String		User agent string responsible for the event.
BrowserFamily	String		Browser family used when the event occurred.
BrowserName	String		Name of the browser used during the event.
BrowserProducer	String		Producer of the browser used during the event.
BrowserProducerUrl	String		URL of the browser producer, if available.
BrowserType	String		Type of browser used during the event.
BrowserUrl	String		URL to a description of the browser, if available.
BrowserVersion	String		Version of the browser used during the event.
LocationCity	String		City where the event occurred.
LocationCountry	String		Country where the event occurred.
LocationState	String		State where the event occurred.
FilteredEvent	Boolean		Boolean flag indicating whether the event was filtered out of reporting based on customer settings.
Source	String		Source of the subscription change event. 使用できる値は次のとおりです。SOURCE_LIST_UNSUBSCRIBE, SOURCE_RECIPIENT, SOURCE_IMPORT, SOURCE_HUBSPOT_CUSTOMER, SOURCE_SPAM_REPORT, SOURCE_NON_DELIVERY_REPORT, SOURCE_DIRECT_COMPLAINT, SOURCE_MTA_RECORD, SOURCE_HUBSPOT, SOURCE_MIGRATION, SOURCE_HUBSPOT_CLEANUP, SOURCE_KNOWN_SPAM_TRAP
RequestedBy	String		Email address of the person requesting the subscription change on behalf of the recipient.
Subscriptions	String		Status of subscriptions associated with the recipient.
PortalSubscriptionStatus	String		Recipient's subscription status within the HubSpot portal. 使用できる値は次のとおりです。SUBSCRIBED, UNSUBSCRIBED
ExtraUrlParameters	String		Optional input-only property for specifying additional query parameters. Format: 'param1=value1, param2=value2, param3=value3'.

EmailCampaigns

Provides details about email marketing campaigns managed within HubSpot, supporting campaign tracking and analysis.

Table Specific Information

Email campaigns in HubSpot represent email marketing campaigns you may send to many different contacts.

SELECT

Email campaign data can only be retrieved from HubSpot via a direct request for a specific HubSpot id. To retrieve all campaigns, first all campaign ids must be retrieved. Then one request for individual campaign data at a time must be submitted. These requests are done automatically, but because of the number of individual requests made for data, this can cause for slow response times.

When selecting email campaigns, may be filtered by the Id. For example:

SELECT * FROM EmailCampaigns WHERE Id = '123456789'

The LastUpdatedTime will not normally be return with a value. It will only come back when specifying WHERE LastUpdatedTime > 'value'. This will trigger a request to HubSpot for recently modified EmailCampaigns. However, be aware that HubSpot only provides a way to retrieve recently modified EmailCampaigns. Not all campaigns that match the criteria may be returned.

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier assigned to the email campaign.
AppName	String		Name of the application associated with the email campaign.
AppId	Long		Unique identifier of the application linked to the email campaign.
LastUpdatedTime	Datetime		Timestamp indicating when the email campaign was last updated.
Name	String		Name assigned to the email campaign.
ContentId	Long		Unique content identifier for the email campaign.
NumberBounced	Long		Total number of bounced emails in the campaign.
NumberClick	Long		Total number of clicks recorded in the campaign.
NumberDeferred	Long		Total number of deferred emails in the campaign.
NumberDelivered	Long		Total number of emails successfully delivered in the campaign.
NumberDropped	Long		Total number of dropped emails in the campaign.
NumberIncluded	Long		Total number of emails included in the campaign.
NumberMTADropped	Long		Total number of emails dropped by the message transfer agent (MTA) in the campaign.
NumberOpen	Long		Total number of opened emails in the campaign.
NumberProcessed	Long		Total number of emails processed in the campaign.
NumberQueued	Long		Total number of queued emails in the campaign.
NumberSent	Long		Total number of emails sent in the campaign.
NumberStatusChanged	Long		Total number of emails where the status changed during the campaign.
NumberUnsubscribed	Long		Total number of recipients who unsubscribed during the campaign.
ProcessingState	String		Current processing state of the email campaign.
Type	String		Type of the email campaign, such as regular or automated.
SubType	String		Subtype providing additional classification of the email campaign.
Subject	String		Subject line used in the email campaign.
LastProcessingStartedAt	Datetime		Timestamp when the campaign last began processing.
LastProcessingFinishedAt	Datetime		Timestamp when the campaign last finished processing.
LastProcessingStateChangeAt	Datetime		Timestamp of the last change in the processing state of the email campaign.
ExtraUrlParameters	String		Optional input-only property for specifying additional query parameters. Format: 'param1=value1, param2=value2, param3=value3'.

EmailSubscriptionTypes

Returns all email subscription types configured in HubSpot, used for categorizing communication preferences.

Table Specific Information

Email subscription types in HubSpot represent different types of subscriptions a contact could be subscribed to.

SELECT

When selecting email subscriptions types, there are no filters that may be used. It is simply a list of all of the available subscription types. For example:

SELECT * FROM EmailSubscriptionTypes

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the email subscription type.
Name	String		Name of the email subscription type, used to categorize subscription preferences.
IsActive	Boolean		Boolean flag indicating whether the subscription type is currently active.
Description	String		Brief description of the purpose or content of the subscription type.
ExtraUrlParameters	String		Optional input-only property to specify additional query parameters when retrieving email subscription type data. Format: 'param1=value1, param2=value2, param3=value3'.

EngagementScheduledTasks

Lists tasks that are scheduled as part of an engagement, useful for task management and follow-ups.

Table Specific Information

EngagementScheduledTasks represent a list of scheduled tasks for the engagements you have in HubSpot.

SELECT

When selecting engagement scheduled tasks, they can only be filtered by the EngagementId. For instance:

SELECT * FROM EngagementScheduledTasks WHERE EngagementId = 12345

Columns


Name	Type	References	Description
EngagementId	Long		Unique identifier assigned to the engagement associated with the scheduled task.
UUID	String		Unique identifier of the scheduled task.
PortalId	Long		HubSpot portal ID associated with the engagement and task.
EngagementType	String		Type of engagement, such as NOTE, TASK, CALL, MEETING, or EMAIL.
TaskType	String		Classification of the scheduled task, specifying the type of activity to be performed.
Timestamp	Datetime		Timestamp indicating when the task was scheduled to occur.

EngagementsScheduledTasks

List of tasks scheduled for an engagement.

Table Specific Information

EngagementsScheduledTasks represent a list of scheduled tasks for the engagements you have in HubSpot.

SELECT

When selecting engagements' scheduled tasks, they can only be filtered by the EngagementId. For instance:

SELECT * FROM EngagementsScheduledTasks WHERE EngagementId = 12345

Columns


Name	Type	References	Description
EngagementId	Long		The id of the engagement.
UUID	String		The scheduled task's uniqe Id.
PortalId	Integer		The portal id the engagement is associated with.
EngagementType	String		The type of engagement.
TaskType	String		The type of the scheduled task.
Timestamp	Datetime		Time when the task was scheduled.

Enrollments

Retrieves workflows in which a contact is actively enrolled, aiding in workflow monitoring and automation analysis.

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier of the contact enrolled in the workflow.
WorkflowId [KEY]	Long		Unique identifier of the workflow associated with the enrollment.
PortalId	String		HubSpot portal ID where the enrollment is registered.
Name	String		Name or title of the workflow the contact is enrolled in.
Description	String		Detailed description of the workflow.
AllowContactToTriggerMultipleTimes	Bool		Indicates whether a contact is permitted to trigger the workflow multiple times.
AllowEnrollmentFromMerge	Bool		Indicates whether merging contacts can trigger enrollment in the workflow.
EnrollOnCriteriaUpdate	Bool		Specifies whether updates to enrollment criteria will trigger a re-enrollment.
CanEnrollFromSalesforce	Bool		Indicates whether the workflow is accessible from the HubSpot embed within Salesforce.
Listening	Bool		Determines if contacts are automatically unenrolled when they no longer meet the starting list criteria.
Enabled	Bool		Boolean flag indicating whether the workflow enrollment is currently active.
Author	String		Name of the user or account responsible for designing the workflow.
AuthorUserId	Long		Unique user ID of the creator of the workflow.
Type	String		Type or classification of the workflow.
IsSegmentBased	Bool		Indicates whether the workflow is based on a specific segment of contacts.
InsertedAt	Datetime		Timestamp showing when the contact was initially enrolled in the workflow.
UpdatedAt	Datetime		Timestamp showing the last update or enrollment of the contact in the workflow.

Events

Returns definitions for all configured events in a portal, essential for event tracking and reporting.

Columns


Name	Type	References	Description
Id [KEY]	String		Unique identifier assigned to the event.
Name	String		Name of the event as defined in HubSpot.
Label	String		Display label of the event used in HubSpot reports and interfaces.
Status	String		Current status of the event, indicating whether it is active, inactive, or archived.

Files

Provides metadata about files stored in HubSpot's file manager, enabling file management and auditing.

Table Specific Information

Files represent any files you have uploaded with HubSpot to your content optimization system.

SELECT

When selecting files, they can only be filtered by the Id, Name, AltKey, IsArchived, CreatedAt, DeletedAt, Extension, FolderId, and Type. Name can be used with the LIKE comparison. Type can be used with both = and <>. CreatedAt and DeletedAt can be used with the > and < comparisons but cannot form a range. For example:

SELECT * FROM Files WHERE CreatedAt >= '1/1/2014'
SELECT * FROM Files WHERE DeletedAt <= '1/1/2014'
SELECT * FROM Files WHERE Type <> 'IMG'
SELECT * FROM Files WHERE Name LIKE 'filename'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the file.
Name	String		Internal name used to reference the file within HubSpot.
FriendlyUrl	String		Public URL for accessing the file directly via a web browser for viewing or download.
AltKey	String		Alternative key used to generate a URL without including the file ID, useful for preserving relative paths when uploading collections of files.
AltUrl	String		Alternative URL of the file, generated without the auto-generated file ID using the alternative key.
IsArchived	Boolean		Boolean indicating whether the file is archived and hidden from the dashboard but still publicly accessible.
CreatedAt	Datetime		Timestamp showing when the file was initially created.
DeletedAt	Datetime		Timestamp showing when the file was deleted, if applicable.
Extension	String		File extension indicating the file type, such as .jpg or .pdf.
FolderId	Long	Folders.Id	Identifier of the folder containing the file.
RSUploadedAt	Datetime		Timestamp showing when the file was uploaded via Remote Server (RS).
S3UploadedAt	Datetime		Timestamp showing when the file was uploaded via Amazon S3.
Size	Long		File size in bytes.
IsSynced	Boolean		Boolean indicating whether the file is a call-to-action (CTA) image synced with HubSpot.
Title	String		Title or display name of the file.
Type	String		String enumeration representing the type of file, such as document or image. 使用できる値は次のとおりです。IMG, TEXT, DOCUMENT, OTHER
UpdatedAt	Datetime		Timestamp showing when the file was last updated.
Version	Double		Version number of the file.
Height	Integer		Height in pixels of the image file. Applicable to image files only.
Width	Integer		Width in pixels of the image file. Applicable to image files only.
ExtraUrlParameters	String		Optional input-only property for specifying additional query parameters when retrieving file data. Format: 'param1=value1, param2=value2, param3=value3'.

Folders

Retrieves folder structures in HubSpot's file manager, useful for organizing and accessing stored files.

Table Specific Information

Folders represent any folders you can upload files to in your content optimization system within HubSpot.

SELECT

When selecting folders, they can only be filtered by the Id, DeletedAt, Name, and ParentFolderId. Name can be used with the LIKE comparison. DeletedAt can be used with the > and < comparisons but cannot form a range. For example:

SELECT * FROM Folders WHERE DeletedAt >= '1/1/2014' AND DeletedAt <= '10/1/2014'
SELECT * FROM Folders WHERE Name LIKE 'foldername'
SELECT * FROM Folders WHERE Id = '123456798'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the folder.
Category	Integer		Integer value representing the category classification of the folder.
CreatedAt	Datetime		Timestamp showing when the folder was initially created.
DeletedAt	Datetime		Timestamp showing when the folder was deleted, if applicable.
FullPath	String		Full directory path to the folder within the HubSpot file system.
Name	String		Name assigned to the folder.
ParentFolderId	Long	Folders.Id	Unique identifier of the parent folder, if the folder is nested within another folder.
UpdatedAt	Datetime		Timestamp showing when the folder was last updated.
ExtraUrlParameters	String		Optional input-only property for specifying additional query parameters when retrieving folder data. Format: 'param1=value1, param2=value2, param3=value3'.

FormFields

Returns details about form fields within HubSpot forms, supporting form customization and data collection.

Table Specific Information

FormFields represent the fields contained in a form on your website.

SELECT

When selecting form fields, they can only be filtered by FormGUID. For example:

SELECT * FROM FormFields WHERE FormGUID = '123456789'
SELECT * FROM FormFields WHERE FormGUID IN ('123456789', '121314515')

Columns


Name	Type	References	Description
FormGUID	String		Unique identifier key assigned to the form.
Name	String		Internal name of the form field.
DefaultValue	String		Default value assigned to the field, if any.
Required	Boolean		Boolean flag indicating whether the field is required for form submission.
Enabled	Boolean		Boolean flag indicating whether the field is currently enabled in the form.
IsSmartField	Boolean		Boolean flag indicating whether the field is a smart field, which adapts based on prior contact interactions.
Label	String		Label displayed on the form for this field.
GroupName	String		Name of the group or section to which the field belongs within the form.
SelectedOptions	String		Comma-separated list of selected options for fields like dropdowns or checkboxes.
FieldType	String		Type of the form field, such as text, dropdown, or checkbox.
Hidden	Boolean		Boolean flag indicating whether the field is hidden from view.
Validation	String		Validation rules or requirements applied to the field, if any.
Type	String		Data type of the value stored in the field.
Options	String		Available selectable options for the field, if applicable.
DisplayOrder	Int		Numeric value determining the display order of the field on the form.

FormSubmissions

Fetches submission data for specified forms, useful for analyzing form performance and lead generation.

Table Specific Information

SELECT

When selecting form submissions, they can only be filtered by FormGUID. For example:

SELECT * FROM FormSubmissions WHERE FormGUID = '123456789'
SELECT * FROM FormSubmissions WHERE FormGUID IN ('123456789', '121314515')

Columns


Name	Type	References	Description
FormGUID	String		Unique identifier key assigned to the form from which the submission was made.
PageUrl	String		URL of the page where the form was submitted.
SubmittedAt	Datetime		Timestamp indicating when the form submission occurred.
Name	String		Name of the form field submitted.
Value	String		Value entered or selected for the form field submission.

Pages

Retrieves all pages created within HubSpot, including website, landing, and blog pages.

Table Specific Information

Pages represent any pages you have published with the HubSpot content optimization system.

SELECT

When selecting pages, they can only be filtered by the Id, ArchivedAt, ArchivedInDashboard, CampaignId, CreatedAt, IsDraft, Name, PublishDate, Slug, Subcategory, and UpdatedAt. CreatedAt, UpdatedAt and PublishDate may be used with > and < to form a range. ArchivedAt can be used with the > and < comparisons but cannot form a range. For example:

SELECT * FROM Pages WHERE CreatedAt >= '1/1/2014' AND CreatedAt <= '10/1/2014'
SELECT * FROM Pages WHERE UpdatedAt >= '1/1/2014' AND UpdatedAt <= '10/1/2014'
SELECT * FROM Pages WHERE PublishDate >= '1/1/2014' AND PublishDate <= '10/1/2014'
SELECT * FROM Pages WHERE ArchivedAt >= '1/1/2014'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier for the page.
ArchivedInDashboard	Boolean		Indicates whether the page is hidden from the dashboard view while still remaining live.
CampaignId	String	EmailCampaigns.Id	The unique GUID of the marketing campaign associated with this page.
CampaignName	String	EmailCampaigns.Name	The name of the marketing campaign linked to this page.
CreatedAt	Datetime		Timestamp marking when the page was originally created.
CurrentLiveDomain	String		The domain name where the page is currently hosted.
ArchivedAt	Datetime		Timestamp indicating when the page was archived or deleted.
FooterHTML	String		Custom HTML code (such as embed codes or scripts) to be included before the closing body tag of the page.
HeaderHTML	String		Custom HTML code (such as embed codes, scripts, or metadata) inserted in the head tag of the page.
IsDraft	Boolean		Boolean indicating whether the page is still in draft status and not publicly visible.
MetaDescription	String		Text for the meta description tag, used for search engine snippets and SEO.
MetaKeywords	String		Comma-separated keywords added to the page's meta tag for SEO purposes.
Name	String		The internal name of the page, used within HubSpot for reference.
Password	String		Password required to view the page, if set. Makes the page password protected.
PublishDate	Datetime		Scheduled publish date and time of the page, represented in milliseconds since the Unix epoch.
Slug	String		URL path component where the page will be accessible. Modifying this alters the page's URL.
StyleOverrideId	String		ID of the custom style or theme applied to override the default site style for this page.
Subcategory	String		Optional subcategory used for classifying the page. This field may be empty.
UpdatedAt	Datetime		Timestamp of the last update made to the page.
Url	String		Full URL including domain and scheme where the page is accessible. Returns a 404 error code if unpublished.
ExtraUrlParameters	String		Optional input-only property for specifying additional query parameters when selecting data. Format as name=value pairs separated by commas, for example: 'param1=value1, param2=value2, param3=value3'.

SocialMediaChannels

Lists social media channels connected to HubSpot, supporting social media engagement tracking.

Table Specific Information

Social media channels in HubSpot represent any social media accounts you have connected for the purposes of posting marketing messages to. Messages can be posted to your social media channels via SocialMediaMessages.

SELECT

When selecting social media channels, data can only be filtered by the ChannelGUID. For example:

SELECT * FROM SocialMediaChannels WHERE ChannelGUID = '123456789'

Columns


Name	Type	References	Description
ChannelGUID [KEY]	String		Globally unique identifier (GUID) for the social media channel.
AccountGUID	String		GUID for the account linked to the social media channel.
AccountSlug	String		Short, human-readable identifier (slug) for the account associated with the social media channel.
AccountType	String		Type of account, such as Facebook, Twitter, or LinkedIn.
IsActive	Boolean		Boolean indicating whether the social media channel is currently active.
AutoPublish	Boolean		Boolean specifying whether posts should be automatically published to this social media channel.
AvatarUrl	String		URL pointing to the profile image or avatar associated with the social media account.
ChannelId	String		The unique ID assigned to the channel by the social media platform.
ChannelKey	String		HubSpot-specific key linked to the social media channel for internal tracking.
ChannelSlug	String		Human-readable slug associated with the social media channel.
CreatedAt	Datetime		Timestamp indicating when the social media channel connection was established.
FollowMe	Boolean		Boolean determining whether HubSpot should enable a follow link for this social media channel.
IsHidden	Boolean		Boolean indicating whether the social media channel is hidden from view in the dashboard.
Monitoring	Boolean		Boolean specifying if activity on this channel should be monitored for engagement analytics.
Reach	Boolean		Boolean indicating whether follower growth tracking is enabled for this social media account.
ReachType	String		Specifies how follower reach is measured or categorized for this social media channel.
IsShared	Boolean		Boolean specifying whether the social media channel is shared across multiple users or teams.
Type	String		Specifies the type of social media platform (such as Facebook, Instagram, or LinkedIn).
UpdatedAt	Datetime		Timestamp showing the last time this social media channel's details were updated.
UserName	String		Username or handle associated with the social media account.
ExtraUrlParameters	String		Optional input-only property for specifying additional query parameters when retrieving data. Format as name=value pairs separated by commas, for example: 'param1=value1, param2=value2, param3=value3'.

Templates

Retrieves available email templates in HubSpot, facilitating standardized communication design.

Table Specific Information

Templates represent any templates you have saved in the HubSpot content optimization system. The templates allow you to easily create new pages with the same look of other pages on your site.

SELECT

When selecting templates, they can only be filtered by the Id, CategoryId, DeletedAt, Folder, IsAvailableForNewContent, Label, and Path. DeletedAt can be used with the > and < comparisons but cannot form a range. For example:

SELECT * FROM Templates WHERE DeletedAt >= '1/1/2014'
SELECT * FROM Templates WHERE Id = '123456789'

Columns


Name	Type	References	Description
Id [KEY]	Long		Unique identifier assigned to the template.
CategoryId	Long		Numeric code representing the type of content this template supports: 1 for landing pages, 2 for emails, and 3 for site pages.
CDNMinifiedUrl	String		URL of the minified and optimized version of JavaScript or CSS content uploaded to HubSpot's Content Delivery Network (CDN).
CDNUrl	String		URL of the rendered version of non-HTML templates uploaded to HubSpot's Content Delivery Network (CDN).
DeletedAt	Datetime		Timestamp indicating when the template was deleted, if applicable.
Folder	String		Folder location within HubSpot where the template is stored.
GeneratedFromLayoutId	String		ID of the layout file from which this template was generated.
IsAvailableForNewContent	Boolean		Boolean indicating whether this template is available in the content creation workflow.
IsFromLayout	Boolean		Boolean specifying if the template was auto-generated by publishing a layout.
IsReadOnly	Boolean		Boolean indicating whether the template is read-only and cannot be edited.
Label	String		The display label of the template as shown within the template builder interface.
Path	String		The file path to reference the template in HubL include statements.
Source	String		Raw markup source code of the template, including HTML and HubL tags.
ThumbnailPath	String		URL path to the thumbnail image representing the template visually.
UpdatedAt	Datetime		Timestamp showing the last modification date and time of the template.
ExtraUrlParameters	String		Optional input-only property for specifying additional query parameters. Format parameters as name=value pairs separated by commas (for example: 'param1=value1, param2=value2, param3=value3').

UrlMappings

Lists all URL mappings configured within HubSpot, useful for managing redirects and vanity URLs.

Table Specific Information

URL mappings represent any number of redirects you have specified in your HubSpot content optimization system.

SELECT

When selecting URL mappings, they can only be filtered by the Id, CreatedAt, DeletedAt, Destination, IsOnlyAfterNotFound, RoutePrefix, and UpdatedAt. DeletedAt, CreatedAt, and UpdatedAt can be used with the > and < comparisons to form a range. For example:

SELECT * FROM UrlMappings WHERE DeletedAt >= '1/1/2014' AND DeletedAt <= '10/1/2014'
SELECT * FROM UrlMappings WHERE Id = '123456789'

Columns


Name	Type	References	Description
Id [KEY]	Long		The unique identifier assigned to the URL mapping.
CreatedAt	Datetime		Timestamp indicating when the URL mapping was initially created.
DeletedAt	Datetime		Timestamp indicating when the URL mapping was deleted, if applicable.
Destination	String		The destination URL to which incoming requests matching the mapping will be redirected.
IsMatchFullUrl	Boolean		Boolean indicating whether the 'RoutePrefix' attribute must match the entire incoming URL, including the domain name.
IsMatchQueryString	Boolean		Boolean indicating whether the 'RoutePrefix' attribute must match the URL path and its query string parameters.
IsOnlyAfterNotFound	Boolean		Boolean specifying whether the URL mapping should apply only if no live page is found at the incoming URL.
Precedence	Integer		Numeric value determining the priority of the URL mapping. Lower numbers indicate higher priority when multiple mappings match.
RoutePrefix	String		The specific incoming URL pattern to match for triggering the redirection.
UpdatedAt	Datetime		Timestamp indicating the last time the URL mapping was modified.
ExtraUrlParameters	String		Optional input-only parameter for passing extra query parameters when retrieving URL mapping data. Format parameters as name=value pairs separated by commas (for example: 'param1=value1, param2=value2, param3=value3').

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、HubSpot の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにHubSpot から関連するレスポンスデータを返します。

CData Cloud - HubSpot ストアドプロシージャ


Name	Description
DeleteFile	Permanently deletes a file and its associated data and thumbnails from HubSpot's file manager.
InsertEngagement	Inserts a new engagement record in HubSpot, such as a call, email, or task. Retrieval of existing engagements is limited via API.
UpdateWorkflowContacts	Enrolls or unenrolls contacts from a specific workflow within HubSpot, enabling workflow automation management.

DeleteFile

Permanently deletes a file and its associated data and thumbnails from HubSpot's file manager.

Input


Name	Type	Description
FileId	String	Unique identifier of the file to be deleted from the HubSpot file manager.

Result Set Columns


Name	Type	Description
Success	Boolean	Indicates whether the file deletion was successful. Returns True if the file was deleted.
ErrorCode	Integer	If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting.
ErrorMessage	String	If the procedure fails, this field provides a detailed error message explaining the failure.

InsertEngagement

Inserts a new engagement record in HubSpot, such as a call, email, or task. Retrieval of existing engagements is limited via API.

Input


Name	Type	Description
EngagementType	String	Specifies the type of engagement to create, such as NOTE, EMAIL, TASK, or MEETING. 使用できる値は次のとおりです。NOTE, EMAIL, TASK, MEETING
EngagementTime	String	Datetime indicating when the engagement occurred.
EngagementIsActive	String	Boolean flag indicating whether the engagement is active.
AssociatedContacts	String	Comma-separated list of contact IDs to associate with the engagement.
AssociatedCompanies	String	Comma-separated list of company IDs to associate with the engagement.
AssociatedDeals	String	Comma-separated list of deal IDs to associate with the engagement.
AssociatedOwners	String	Comma-separated list of owner user IDs to associate with the engagement.
NoteBody	String	Text content of a note engagement. Only applicable if EngagementType is NOTE.
FromEmail	String	Sender's email address. Used only when EngagementType is EMAIL.
FromFirstName	String	Sender's first name. Used only when EngagementType is EMAIL.
FromLastName	String	Sender's last name. Used only when EngagementType is EMAIL.
ToEmail	String	Comma-separated list of recipient email addresses. Used only when EngagementType is EMAIL.
EmailCC	String	Comma-separated list of email addresses to be CC'd. Used only when EngagementType is EMAIL.
EmailBCC	String	Comma-separated list of email addresses to be BCC'd. Used only when EngagementType is EMAIL.
EmailSubject	String	Subject line of the email. Used only when EngagementType is EMAIL.
EmailHtml	String	HTML-formatted body content of the email. Used only when EngagementType is EMAIL.
EmailText	String	Plain text version of the email body. Used only when EngagementType is EMAIL.
TaskBody	String	Description or details of the task. Used only when EngagementType is TASK.
TaskStatus	String	Current status of the task, such as Not Started or Completed. Used only when EngagementType is TASK.
TaskForObjectType	String	Type of object the task is associated with, such as CONTACT. Used only when EngagementType is TASK.
MeetingBody	String	Description or agenda of the meeting. Used only when EngagementType is MEETING.
MeetingStartTime	String	Scheduled start datetime of the meeting. Used only when EngagementType is MEETING.
MeetingEndTime	String	Scheduled end datetime of the meeting. Used only when EngagementType is MEETING.
MeetingTitle	String	Title of the meeting. Used only when EngagementType is MEETING.

Result Set Columns


Name	Type	Description
Id	String	Unique ID returned for the newly created engagement.

UpdateWorkflowContacts

Enrolls or unenrolls contacts from a specific workflow within HubSpot, enabling workflow automation management.

Input


Name	Type	Description
WorkflowId	String	Unique identifier of the HubSpot workflow to enroll or unenroll the contact from.
Email	String	Email address of the contact to be enrolled in or unenrolled from the workflow.
Process	String	Action to perform on the contact. Acceptable values are 'enroll' to add the contact or 'unenroll' to remove the contact from the workflow. 使用できる値は次のとおりです。enroll, unenroll

Result Set Columns


Name	Type	Description
Success	Boolean	Indicates whether the requested process was successful. Returns True if completed without errors.
ErrorCode	Integer	If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting.
ErrorMessage	String	If the procedure fails, this field provides a detailed error message explaining the failure.

HubSpot V3 データモデル

The CData Cloud models HubSpot CRM API v3 data as an easy-to-use SQL database. There are three parts to the data model: tables, views, and stored procedures.

Tables

The テーブル section, which details standard SQL tables, and the ビュー section, which lists read-only SQL tables, contain samples of what you might have access to in your HubSpot account. Note that Custom objects are exposed as tables with "__c" appended to the end of the name.

Common tables include:


Table	Description
Contacts	Retrieves contact records from HubSpot, supporting both OAuth and private-app token authentication methods.
Companies	Retrieves company records available in HubSpot, supporting both OAuth and private-app token authentication methods.
Deals	Retrieves all deals from HubSpot, supporting both OAuth and private-app token authentication methods.
Tickets	Lists all tickets in HubSpot, supporting both OAuth and private-app token authentication methods.
EngagementsCalls	Retrieves all call engagement records in HubSpot, useful for tracking customer communication.
EngagementsEmails	Retrieves all email engagement records in HubSpot, supporting email interaction analysis.
EngagementsMeetings	Retrieves all meeting engagement records, used to track meetings scheduled within HubSpot.
EngagementsNotes	Retrieves all note engagement records, helpful for logging internal or customer-related notes.
EngagementsTasks	Retrieves all task engagement records, allowing management of action items related to CRM records.
LeadProperties	Retrieves all available lead property fields, supporting lead data management and enrichment.
Lineitems	Lists all line items in HubSpot, with support for both OAuth and private-app token authentications.
Products	Lists all product records configured in HubSpot, supporting both OAuth and private-app token authentications.
Quotes	Lists all quotes in HubSpot, useful for managing proposals and sales offers.
Workflows	Retrieves and manages workflows in HubSpot used to automate processes across marketing, sales, and service.
DealPipelines	Provides pipelines associated with deals, used to visualize and manage sales stages.
DealPipelineStages	Lists stages within deal pipelines to track deal progress through different phases.
ContactProperties	Retrieves all available contact property fields in HubSpot, including both standard and custom properties.
CompanyProperties	Retrieves all available company property fields in HubSpot, supporting company data enrichment.
Owners	Returns a list of owners in HubSpot used to assign CRM records to specific users within the organization.

The Cloud uses the HubSpot API to process supported filters. The Cloud processes other filters client-side within the Cloud.

Stored Procedures

ストアドプロシージャ are actions that are invoked via SQL queries. They perform tasks beyond standard create, read, update, delete (CRUD) operations, including managing custom objects and OAuth tokens.

メタデータの検出

Tables

テーブル describes a sample of the available standard tables. The standard table definitions and custom tables are dynamically retrieved during runtime; here, we show the sample table definitions for the standard HubSpot Objects. Note that Custom Objects are exposed as tables with a "__c" appended to the end of the name.

You can find more detailed information for the available HubSpot Custom Objects by querying the views: CustomObjects, CustomObjectProperties and CustomObjectAssociations.

You can Create new HubSpot Custom Objects (tables) or Update and Delete existing ones via the stored procedures: CreateCustomObject, UpdateCustomObject and DeleteCustomObject. Additionally, you can add, update or remove Custom Properties (columns) to both Standard and Custom HubSpot Objects (tables) through the stored procedures: CreateCustomProperty, UpdateCustomProperty and DeleteCustomProperty.

The HubSpot Data Provider exposes the HubSpot Object Associations as tables, through which the user can retrieve and manage the associated records between different object types. By default, and if the ExpandAssociations connection property is false, one associations table is exposed for each HubSpot object with available associations (ex. DealAssociations, CompanyAssociations, ContactAssociations, etc.). In case the ExpandAssociations connection property is true, the driver exposes one associations table for each association between two HubSpot object types (for example, CompaniesToContactsAssociations, ContactsToDealsAssociations, DealsToLineitemsAssociations, etc.). Refer to ContactAssociations and ContactsToDealsAssociations for a simple guide with examples on how to get the associated records and add new ones.

To retrieve and add between a custom object type and other objects types (standard or custom objects) the user can utilize the table CustomObjectAssociations.

DELETE statements are not supported on association tables for the HubSpotV3 schema, but they are supported on the HubSpotV4 schema. On the other hand, UPDATE statements on association tables are not supported in either schema.

改善と制限

CRM API V3 improvements (compared to V1 and V2)

Filtering capabilities for most important tables. Supported operators include =, !=, >, <, <=, >=, IN.
Filtering using AND and OR combinations. A maximum of three OR operators are supported server-side, with each of these operators supporting up to three AND operators inside of them.
Sorting capability for most important tables. Only one column is supported to be sorted by the API.
Support for 'Batch' operations (Batch INSERT, Batch Update, Batch Delete).
Support for Creating, Updating and Deleting Custom HubSpot Objects (tables) and Properties (columns).

CRM API V3 limitations

Filtering is available only when the number of rows to be returned is less than 10,000. If there are more rows to be returned for the query then all rows will be retrived first and filtering is then applied on them by the Cloud
When issuing either filtering requests or sorting requests, no more than one request/second is allowed.
A few columns (such as "CreatedAt" and "UpdatedAt") do not support filters.
The stored procedures to Create/Update custom objects may not work for the OAuth Authentication Scheme, since the OAuth apps are limited to the read-only access scope for custom objects. To work around this limitation, you can connect via a Private App Token.
You cannot request custom object types by their base name. All custom object types must be referenced by their fully qualified object type name or their short-hand custom object type name (p_<object_name>).

テーブル

Cloud はHubSpot のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - HubSpot テーブル


Name	Description
AppointmentAssociations	Retrieve the IDs of all the objects associated to specific Appointments objects in HubSpot.
AppointmentPipelines	Pipelines of Appointments in HubSpot.
AppointmentPipelineStages	PipelineStages of Appointments in HubSpot.
Appointments	Retrieve the available Appointments in HubSpot.
CallAssociations	Returns object IDs associated with specific call records, allowing tracking of call-related associations.
CallProperties	Retrieves available property fields associated with call records, supporting call data management.
Campaigns	Retrieve the available marketing Campaigns in HubSpot
CommunicationProperties	Provides property fields for communication records, enabling management of calls, emails, and messages.
Communications	Lists communication records such as calls and emails in HubSpot, supporting engagement tracking.
Companies	Retrieves company records available in HubSpot, supporting both OAuth and private-app token authentication methods.
CompanyAssociations	Lists object IDs associated with specific companies, useful for managing company-related associations.
CompanyPipelines	Provides pipelines associated with companies, used to visualize and manage company lifecycle stages.
CompanyPipelineStages	Lists stages within company pipelines, helping manage progress through company-related workflows.
CompanyProperties	Retrieves all available company property fields in HubSpot, supporting company data enrichment.
CompanyPropertyGroups	Provides access to groups used to organize company properties for easier data management.
ContactAssociations	Lists object IDs associated with specific contacts, supporting management of contact associations.
ContactPipelines	Retrieves pipelines configured for managing contact progress through different lifecycle stages.
ContactPipelineStages	Lists stages within the contact pipeline to track the progress of contacts through various lifecycle stages.
ContactProperties	Retrieves all available contact property fields in HubSpot, including both standard and custom properties.
ContactPropertyGroups	Provides groups used to organize contact properties, simplifying property management.
Contacts	Retrieves contact records from HubSpot, supporting both OAuth and private-app token authentication methods.
ContactsToDealsAssociations	Lists deal IDs associated with specific contacts, useful for managing contact-deal relationships.
CourseAssociations	Retrieve the IDs of all the objects associated to specific Courses objects in HubSpot.
CoursePipelines	Pipelines of Courses in HubSpot.
CoursePipelineStages	PipelineStages of Courses in HubSpot.
Courses	Retrieve the available Courses in HubSpot.
CustomObjectAssociations	Manages associations between custom object types in HubSpot, facilitating complex object relationships.
DealAssociations	Returns object IDs associated with specific deals, supporting the management of deal associations.
DealPipelines	Provides pipelines associated with deals, used to visualize and manage sales stages.
DealPipelineStages	Lists stages within deal pipelines to track deal progress through different phases.
DealProperties	Retrieves all available deal property fields in HubSpot, both standard and custom properties.
DealPropertyGroups	Provides access to groups used to organize deal properties logically.
Deals	Retrieves all deals from HubSpot, supporting both OAuth and private-app token authentication methods.
EmailAssociations	Lists object IDs associated with specific email records, enabling email engagement tracking.
EmailProperties	Retrieves property fields associated with email records in HubSpot, used for email data management.
EngagementsCalls	Retrieves all call engagement records in HubSpot, useful for tracking customer communication.
EngagementsEmails	Retrieves all email engagement records in HubSpot, supporting email interaction analysis.
EngagementsMeetings	Retrieves all meeting engagement records, used to track meetings scheduled within HubSpot.
EngagementsNotes	Retrieves all note engagement records, helpful for logging internal or customer-related notes.
EngagementsTasks	Retrieves all task engagement records, allowing management of action items related to CRM records.
FeedbackSubmissionAssociations	Lists object IDs associated with specific feedback submissions, supporting feedback-related associations.
FeedbackSubmissionProperties	Retrieves property fields for feedback submission records in HubSpot, enabling feedback analysis.
Forms	Retrieves forms used in HubSpot for lead capture and contact data collection.
InvoiceAssociations	Retrieve the IDs of all the objects associated to specific Invoices objects in HubSpot.
Invoices	Retrieve the available Invoices in HubSpot.
LeadAssociations	Lists object IDs associated with specific lead records in HubSpot, supporting lead associations.
LeadPipelineStages	Lists stages within lead pipelines, helping visualize and manage the lead funnel.
LeadProperties	Retrieves all available lead property fields, supporting lead data management and enrichment.
LeadPropertyGroups	Provides groups used to organize lead properties for easier data management.
Leads	Retrieves all lead records from HubSpot for lead tracking and management.
LineitemAssociations	Lists object IDs associated with specific line items, supporting line item associations in deals.
LineItemProperties	Retrieves all properties for line items, including standard and custom fields, supporting detailed item tracking.
Lineitems	Lists all line items in HubSpot, with support for both OAuth and private-app token authentications.
ListingAssociations	Retrieve the IDs of all the objects associated to specific Listings objects in HubSpot.
ListingPipelines	Pipelines of Listings in HubSpot.
ListingPipelineStages	PipelineStages of Listings in HubSpot.
Listings	Retrieve the available Listings in HubSpot.
ListMemberships	Represents the relationships between HubSpot lists and CRM objects (contacts, companies, deals, etc.). Each record defines a single object's membership in a specific list, enabling segmentation and targeted marketing activities.
Lists	Retrieves and describes all lists in your HubSpot account.
MarketingEmails	Marketing emails in HubSpot.
MeetingAssociations	Returns object IDs associated with specific meeting records, enabling meeting-related CRM associations.
MeetingProperties	Retrieves available property fields associated with meeting records for meeting data management.
NoteAssociations	Lists object IDs associated with specific notes, supporting associations of notes to other CRM objects.
NoteProperties	Retrieves all available property fields for notes, useful for managing note metadata.
OrderAssociations	Returns object IDs associated with specific orders, supporting both OAuth and private-app token authentications.
OrderPipelines	Provides pipelines configured for managing orders, useful for order processing workflows.
OrderPipelineStages	Lists stages within order pipelines, representing steps in the order lifecycle.
OrderProperties	Retrieves all properties associated with orders, including standard and custom fields.
OrderPropertyGroups	Provides access to groups used to organize order properties logically.
Orders	Lists all orders in HubSpot, with support for OAuth and private-app token authentication.
PostalMailProperties	Retrieves all property fields associated with postal mails, enabling management of postal mail records.
PostalMails	Lists all postal mail records in HubSpot, used for tracking postal communication.
ProductAssociations	Returns object IDs associated with specific product records, supporting product associations.
ProductProperties	Retrieves all available product property fields, including standard and custom fields.
Products	Lists all product records configured in HubSpot, supporting both OAuth and private-app token authentications.
QuoteAssociations	Lists object IDs associated with specific quotes, enabling management of quote associations.
QuoteProperties	Retrieves available property fields for quotes, supporting quote record management.
Quotes	Lists all quotes in HubSpot, useful for managing proposals and sales offers.
ServiceAssociations	Retrieve the IDs of all the objects associated to specific Services objects in HubSpot.
ServicePipelines	Pipelines of Services in HubSpot.
ServicePipelineStages	PipelineStages of Services in HubSpot.
Services	Retrieve the available Services in HubSpot.
TaskAssociations	Returns object IDs associated with specific tasks, supporting task-related CRM associations.
TaskProperties	Retrieves available property fields associated with tasks, useful for managing task records.
Threads	Lists all available conversation threads in HubSpot, useful for managing customer interactions.
TicketAssociations	Returns object IDs associated with specific ticket records, supporting ticket associations in CRM.
TicketPipelines	Lists pipelines configured for managing tickets, representing customer support workflows.
TicketPipelineStages	Lists stages within ticket pipelines, used to track progress of customer support cases.
TicketProperties	Retrieves all property fields associated with tickets, supporting ticket data management.
TicketPropertyGroups	Provides access to groups used to organize ticket properties logically.
Tickets	Lists all tickets in HubSpot, supporting both OAuth and private-app token authentication methods.
Workflows	Retrieves and manages workflows in HubSpot used to automate processes across marketing, sales, and service.

AppointmentAssociations

Retrieve the IDs of all the objects associated to specific Appointments objects in HubSpot.

View Specific Information

AppointmentAssociations retrieves the IDs of all objects associated with specific appointment records in HubSpot. This table shows the relationships between appointments and other HubSpot objects such as contacts, companies, deals, and tickets.

SELECT

When selecting appointment associations, you must specify the appointment ID to retrieve its associated objects. For example:

SELECT * FROM AppointmentAssociations WHERE Id = '12345'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Appointments.Id	False	Appointments ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Appointments object is associated with.
Type [KEY]	String	False		False	Type of the associated object, which can be a contact, deal etc.

AppointmentPipelines

Pipelines of Appointments in HubSpot.

View Specific Information

AppointmentPipelines contains the pipeline configurations for appointment records in HubSpot. Each pipeline represents a series of stages that appointments can progress through.

SELECT

SELECT * FROM AppointmentPipelines
SELECT * FROM AppointmentPipelines WHERE Id = 'appointment-pipeline-id'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	False		False	The unique identified of the pipeline.
Label	String	False		False	The label (name) of the pipeline.
Archived	Bool	True		False	Whether the pipeline is archived or not.
CreatedAt	Datetime	True		False	When the pipeline was created.
UpdatedAt	Datetime	True		False	When the pipeline was last updated.
DisplayOrder	Int	False		False	The order of this specific pipeline in the collection of pipelines for this table.
StagesAggregate	String	False		False	An aggregate of the stages included in this pipeline. This information can be viewed in more detail in TicketPipelineStages table.

AppointmentPipelineStages

PipelineStages of Appointments in HubSpot.

View Specific Information

AppointmentPipelineStages contains the individual stages within appointment pipelines in HubSpot. Each stage represents a specific step in the appointment workflow process.

SELECT

SELECT * FROM AppointmentPipelineStages WHERE PipelineId = 'appointment-pipeline-id';

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier of the stage in this pipeline.
PipelineId [KEY]	String	False	TicketPipelines.Id	False	Unique identifier of the pipeline.
Label	String	False		False	Label (name) of the pipeline stage.
PipelineLabel	String	True	TicketPipelines.Label	False	The label (name) of the pipeline.
IsClosed	Bool	False		False	Whether this stage is open or closed.
State	String	False		False	Current state of the pipeline stage.
Archived	Bool	True		False	Whether the stage is archived or not.
CreatedAt	Datetime	True		False	Time the stage was created.
UpdatedAt	Datetime	True		False	Time the stage was last updated.
DisplayOrder	Int	False		False	The order of the stage in the collection of stages for this pipeline.

Appointments

Retrieve the available Appointments in HubSpot.

Table Specific Information

In HubSpot, appointments represent scheduled meetings, consultations, or other time-based engagements with contacts or companies. Appointment records help track scheduling activities and support customer relationship management workflows.

SELECT

When selecting appointments, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Appointments WHERE [Appointment Start] > '2024-01-01' AND [Appointment End] < '2024-12-31'
SELECT * FROM Appointments WHERE [Pipeline] = 'Appointment Pipeline' OR [Appointment Name] = 'Initial Consultation'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Appointments WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Appointments WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Appointments WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Appointments WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO Appointments ([Appointment Name], [Appointment Start], [Appointment End]) VALUES ('Client Meeting', '2024-08-20 10:00:00', '2024-08-20 11:00:00')

UPDATE

UPDATE Appointments SET [Appointment Name] = 'Updated Meeting Title' WHERE ID = '12345'

DELETE

DELETE FROM Appointments WHERE ID = '12345'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Appointment End	Datetime	False		True	Date and time when the appointment ends.
Appointment Name	String	False		True	Name or title of the appointment.
Appointment Start	Datetime	False		True	Date and time when the appointment begins.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Date entered 'In Progress (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'In Progress' stage, 'Appointment Pipeline' pipeline.
Date entered 'Canceled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Canceled' stage, 'Appointment Pipeline' pipeline.
Date entered 'Scheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Scheduled' stage, 'Appointment Pipeline' pipeline.
Date entered 'Rescheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Rescheduled' stage, 'Appointment Pipeline' pipeline.
Date entered 'Completed (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Completed' stage, 'Appointment Pipeline' pipeline.
Date exited 'In Progress (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'In Progress' stage, 'Appointment Pipeline' pipeline.
Date exited 'Canceled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Canceled' stage, 'Appointment Pipeline' pipeline.
Date exited 'Scheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Scheduled' stage, 'Appointment Pipeline' pipeline.
Date exited 'Rescheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Rescheduled' stage, 'Appointment Pipeline' pipeline.
Date exited 'Completed (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Completed' stage, 'Appointment Pipeline' pipeline.
Duration	Decimal	True		True	Total length of the appointment.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Owning Teams	String	False		False	The teams that are attributed to this record.
Pipeline	String	False		False	The pipeline that contains this appointment.
Pipeline Stage	String	False		False	The pipeline stage that contains this appointment.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	False		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	False		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Time in 'In Progress (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'In Progress' stage, 'Appointment Pipeline' pipeline.
Time in 'Canceled (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Canceled' stage, 'Appointment Pipeline' pipeline.
Time in 'Scheduled (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Scheduled' stage, 'Appointment Pipeline' pipeline.
Time in 'Rescheduled (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Rescheduled' stage, 'Appointment Pipeline' pipeline.
Time in 'Completed (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Completed' stage, 'Appointment Pipeline' pipeline.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	Object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.
Test Label	String	False		True	This column is a custom field.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

CallAssociations

Returns object IDs associated with specific call records, allowing tracking of call-related associations.

Table Specific Information

Select

Note: You cannot reference custom objects by base name. When querying CallAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		False	Unique identifier for the call record.
AssociationId [KEY]	Long	False		False	Unique ID of the associated HubSpot object (such as contact, deal, or company) linked to this call.
Type [KEY]	String	False		True	Specifies the type of the associated HubSpot object (such as contact, deal, or company) connected to the call.

CallProperties

Retrieves available property fields associated with call records, supporting call data management.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the property, consisting of lowercase letters and numbers, starting with a letter. Used as the unique key for the property.
Label	String	False		False	User-friendly label displayed in the HubSpot UI for this call property.
FieldType	String	False		False	Specifies the type of input field (such as text, dropdown, or checkbox) displayed for this property in the UI.
Type	String	False		False	The underlying data type used to store the property's value (such as string, number, or date).
GroupName	String	False		False	Name of the property group this call property belongs to, used for organizational purposes in the UI.
Description	String	False		False	Detailed explanation of the property's purpose and how it is used within call records.
DisplayOrder	Int	False		False	Numerical value that controls the display sequence of this property relative to others in the same group.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are sourced externally.
IsFormField	Bool	False		False	Indicates whether this property appears as an editable field in HubSpot forms.
IsCalculated	Bool	False		False	Indicates whether the property's value is automatically calculated based on other data.
IsHidden	Bool	False		False	Determines whether the property is hidden from the standard HubSpot UI views.
IsHubspotDefined	Bool	False		False	Indicates whether the property is predefined by HubSpot (true) or custom-defined by the user (false).
Archivable	Bool	False		False	Specifies whether the property can be archived and no longer actively used.
ReadOnlyDefinition	Bool	False		False	Indicates whether the property's definition (such as type or label) is read-only and cannot be modified.
ReadOnlyValue	Bool	False		False	Indicates whether the property's value is read-only and cannot be edited by users.
OptionsAggregate	String	False		False	A serialized collection of selectable options for the property, applicable when the FieldType supports options (such as radio buttons or checkboxes).
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

Campaigns

Retrieve the available marketing Campaigns in HubSpot

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		True	The unique identifier of the campaign.
Name	String	False		False	The campaign's name.
CreatedAt	Datetime	True		False	The campaign's creation time.
UpdatedAt	Datetime	True		False	The timestamp of the latest update to the campaign.
StartDate	Date	False		False	The campaign's start date (yyyy-MM-dd).
EndDate	Date	False		False	The campaign's end date (yyyy-MM-dd).
Notes	String	False		False	Any notes about the campaign.
Audience	String	False		False	The campaign's audience.
Goal	String	False		False	The campaign's goal.
CurrencyCode	String	False		False	The currency code used for the campaign.
CampaignStatus	String	False		False	The status of the campaign. Status can be one of the following: 'planned', 'in_progress', 'active', 'paused', or 'completed'. 使用できる値は次のとおりです。in_progress, active, paused, completed
Owner	String	True		False	The user id of the user that owns the campaign.
ColorHex	String	True		False	The color of the campaign in hexadecimal color code.
CreatedBy	String	True		False	The user Id of the user that originally created the campaign.
ObjectId	String	True		False	The internal CRM object Id.
BudgetItemsAmount	Double	True		False	The sum of all budget items.
SpendItemsAmount	Double	True		False	The sum of all spend items.

CommunicationProperties

Provides property fields for communication records, enabling management of calls, emails, and messages.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the communication property, using lowercase letters and numbers, starting with a letter. Serves as the unique identifier.
Label	String	False		False	Readable label displayed in HubSpot's UI to represent the communication property to users.
FieldType	String	False		False	Defines the input field type (such as text, dropdown,or checkbox) for this property as shown in the UI.
Type	String	False		False	Underlying machine data type (such as string, number, or date) used to store the property's value.
GroupName	String	False		False	Identifies the property group this communication property belongs to for organizational display.
Description	String	False		False	Detailed description of the property's purpose and its relevance to communication records.
DisplayOrder	Int	False		False	Numerical value determining the order this property appears relative to others in its group.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are sourced from an external system.
IsFormField	Bool	False		False	Specifies whether this property is displayed as an editable field within HubSpot forms.
IsCalculated	Bool	False		False	Indicates whether the property's value is automatically computed based on other data.
IsHidden	Bool	False		False	Determines if the property is hidden from standard views in the HubSpot interface.
IsHubspotDefined	Bool	False		False	True if the property is predefined by HubSpot, false if it was custom-created.
Archivable	Bool	False		False	Indicates whether this property can be archived and removed from active use.
ReadOnlyDefinition	Bool	False		False	Specifies whether the property's definition (such as type or label) is locked and cannot be modified.
ReadOnlyValue	Bool	False		False	Specifies whether the property's value is read-only and not editable by users.
OptionsAggregate	String	False		False	Serialized list of selectable options for the property, relevant when FieldType supports multiple-choice fields (such as radio, checkbox, or boolean checkbox).
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

Communications

Lists communication records such as calls and emails in HubSpot, supporting engagement tracking.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique numeric identifier of the communication record.
Archived	Bool	True		False	Indicates whether the communication record is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp of when the communication record was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the last update made to the communication record.
Properties	String	True		False	Serialized list of key-value property pairs associated with the communication object.
All teams	String	True		False	IDs of all teams, including hierarchy, associated with both default and custom owner properties of this communication.
Business units	String	False		False	IDs of business units to which the communication record is assigned.
All owner IDs	String	True		False	List of all owner IDs, covering default and custom owner properties related to the communication.
All team IDs	String	True		False	IDs of all teams linked via default and custom owner properties of this communication record.
AtMentioned Owner Ids	String	False		False	IDs of owners who have been @-mentioned within this communication engagement.
Attached file IDs	String	False		False	IDs of files attached to the communication engagement.
Body preview	String	True		True	A short, truncated text preview of the communication content body.
HTML Body Preview	String	True		True	HTML-rendered preview of the communication body content.
Body Preview Truncated	Bool	True		True	Boolean indicating whether the communication body was shortened in the preview.
Communication body	String	False		True	Full body content of the communication engagement.
Channel Type	String	False		False	The channel (such as email, chat, or call) used for this communication. May be empty if unspecified.
Conversation associations sync timestamp	Datetime	True		True	Timestamp of the latest synchronization of associations from the related conversation object.
Conversation object ID	Decimal	True		True	ID of the conversation object (such as chat thread) linked to this communication.
Conversations channel IDs	String	True		False	IDs of the communication channels (such as chat or email channels) used in the conversation.
Conversations channel account IDs	String	True		False	IDs of channel accounts (such as specific email or chat accounts) used in this communication.
Conversations first message timestamp	Datetime	True		True	Timestamp of the first message within the related conversation thread.
Conversations thread ID	Decimal	True		True	ID of the Conversations thread associated with the communication engagement.
Logged From	String	False		False	Specifies the source or platform from which the communication was logged (such as CRM or API).
Activity created by	Decimal	True		True	User ID of the individual who created the communication record.
Created by user ID	Decimal	True		True	User ID of the individual who created this record, automatically set by HubSpot.
Object create date/time	Datetime	True		True	Timestamp when the communication object was created. Set automatically by HubSpot and not editable.
Engagement Source	String	False		True	Source system, platform, or tool that initiated or logged the engagement.
Engagement Source ID	String	False		True	Unique identifier from the source system responsible for creating the engagement.
GDPR deleted	Bool	True		True	Indicates whether the communication body has been cleared in response to a GDPR delete request.
Object last modified date/time	Datetime	True		True	Timestamp of the most recent property update on this communication record, including hidden/internal properties.
Merged record IDs	String	True		False	List of IDs of communication records merged into this record, automatically managed by HubSpot.
Updated by	Decimal	True		True	User ID of the individual who last updated the communication.
Record ID	Decimal	True		True	Unique identifier of the communication record, automatically generated by HubSpot.
Record creation source	String	True		True	Internal source property indicating how this communication record was initially created.
Record source detail 1	String	True		True	Primary detail describing the method or source system used to create the communication record.
Record source detail 2	String	True		True	Secondary detail providing additional context on how the communication record was created.
Record source detail 3	String	True		True	Tertiary detail offering further specifics on the creation source of the communication record.
Record creation source ID	String	True		True	Internal source ID present in the request metadata at the time of the communication record's creation.
Record source	String	True		False	General description of how the communication record was generated (such as manually, via API, or integration).
Record creation source user ID	Decimal	True		True	User ID from the request metadata who initiated the creation of the communication record.
Read only object	Bool	True		True	Indicates whether the communication record is locked from editing by users.
Shared teams	String	True		False	List of team IDs whose members have access permissions to this communication record, set via manual assignment, APIs, or workflows.
Shared users	String	True		False	List of user IDs granted access to the communication record through manual assignment, APIs, or workflows.
Activity date	Datetime	False		True	Timestamp indicating when the communication activity took place. May differ from creation date.
Unique creation key	String	True		True	Unique key used for idempotent creation to prevent duplicate communication records.
Unique ID	String	False		True	System-generated unique identifier for the communication record.
Updated by user ID	Decimal	True		True	User ID of the individual who most recently updated this communication record, automatically recorded.
User IDs of all notification followers	String	True		False	IDs of users who have opted in to receive notifications for updates on this communication.
User IDs of all notification unfollowers	String	True		False	IDs of owners who have opted out of receiving notifications related to this communication.
User IDs of all owners	String	True		False	List of user IDs representing all owners associated with the communication record.
Performed in an import	Bool	True		True	Indicates whether the communication record was created as part of an import process.
Owner assigned date	Datetime	True		True	Timestamp of the latest assignment of an owner to this communication record. Set automatically.
Activity assigned to	String	False		True	User or integration user assigned to this communication activity, either manually or via workflow.
HubSpot Team	String	True		False	ID of the HubSpot team that owns the engagement linked to this communication.

Companies

Retrieves company records available in HubSpot, supporting both OAuth and private-app token authentication methods.

Table Specific Information

In HubSpot, company records store information about a business or organization.

SELECT

When selecting companies, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Companies WHERE [Associated Deals] > 1 AND [Recent Deal Close Date] < '2020-01-31'
SELECT * FROM Companies WHERE [Associated Contacts] < 50 OR [Last Contacted] > '2020-01-01 15:00:00'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Companies WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Companies WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Companies WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Companies WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO Companies ([About Us]) VALUES ('description')

UPDATE

UPDATE Companies SET [About Us] = 'new description' WHERE ID = '3917882265'

DELETE

DELETE FROM Companies WHERE ID = '3917882265'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique numeric identifier for the company record.
Archived	Bool	True		False	Indicates whether the company record is archived and no longer actively managed.
CreatedAt	Datetime	True		False	Timestamp marking when the company record was first created in HubSpot.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update made to the company record.
ItemURL	String	True		False	Direct URL linking to the company's record within HubSpot for quick access.
About Us	String	False		True	Short description or mission statement summarizing the company's purpose.
ClosedateTimestampEarliestValue	Datetime	True		True	Earliest closed deal date across all contacts associated with the company, calculated via rollup.
Facebook Fans	Decimal	False		True	Total number of Facebook followers or fans associated with the company's official page.
FirstContactCreatedateTimestampEarliestValue	Datetime	True		True	Timestamp of the earliest contact creation date linked to this company, calculated via rollup.
First Conversion Date	Datetime	True		True	Date of the first conversion event (such as a form submission) across any contact associated with the company.
FirstConversionDateTimestampEarliestValue	Datetime	True		True	Timestamp showing the earliest recorded conversion date across contacts associated with the company.
First Conversion	String	True		True	The first form or event that a contact associated with the company converted on.
FirstConversionEventNameTimestampEarliestValue	Datetime	True		True	Timestamp of the earliest recorded first conversion event name for contacts associated with this company.
First Deal Created Date	Datetime	True		True	Date when the first deal was created and linked to the company.
Year Founded	String	False		True	Year when the company was founded, sourced automatically by HubSpot Insights.
Additional Domains	String	False		True	List of additional domains owned by the company, if applicable.
Business units	String	False		True	Business units assigned to the company for segmentation and reporting.
Time First Seen	Datetime	True		True	Timestamp of the first recorded activity by any contact associated with the company.
HsAnalyticsFirstTimestampTimestampEarliestValue	Datetime	True		True	Earliest timestamp for a recorded activity across contacts associated with the company, based on rollup.
First Touch Converting Campaign	String	True		True	Marketing campaign responsible for the first touch conversion of the first associated contact.
HsAnalyticsFirstTouchConvertingCampaignTimestampEarliestValue	Datetime	True		True	Timestamp showing the earliest first-touch converting campaign across associated contacts.
Time of First Session	Datetime	True		True	Timestamp of the first session logged by any contact linked to the company.
HsAnalyticsFirstVisitTimestampTimestampEarliestValue	Datetime	True		True	Earliest recorded timestamp for the first session involving any associated contact.
Time Last Seen	Datetime	True		True	Timestamp of the most recent activity recorded by any contact associated with the company.
HsAnalyticsLastTimestampTimestampLatestValue	Datetime	True		True	Latest recorded activity timestamp across associated contacts, aggregated through rollup.
Last Touch Converting Campaign	String	True		True	Marketing campaign responsible for the last-touch conversion of the first associated contact.
HsAnalyticsLastTouchConvertingCampaignTimestampLatestValue	Datetime	True		True	Timestamp of the most recent last-touch converting campaign across associated contacts.
Time of Last Session	Datetime	True		True	Timestamp of the most recent session logged by any contact associated with the company.
HsAnalyticsLastVisitTimestampTimestampLatestValue	Datetime	True		True	Timestamp providing the latest session recorded across all associated contacts.
Latest Source	String	True		True	Source of the most recent session recorded by contacts linked to the company, such as Direct Traffic or Paid Social.
Latest Source Data 1	String	True		True	Additional details about the source of the most recent session for associated contacts.
Latest Source Data 2	String	True		True	Further descriptive details regarding the latest session source for contacts linked to the company.
Latest Source Timestamp	Datetime	True		True	Timestamp showing when the most recent source interaction occurred across associated contacts.
Number of Pageviews	Decimal	True		True	Total number of website pageviews recorded across contacts associated with the company.
HsAnalyticsNumPageViewsCardinalitySum	Decimal	True		True	Aggregated total pageviews for all associated contacts, calculated by summing rollups.
Number of Sessions	Decimal	True		True	Total number of website sessions recorded across contacts linked to the company.
HsAnalyticsNumVisitsCardinalitySum	Decimal	True		True	Aggregated number of sessions across all associated contacts, based on a rollup calculation.
Original Source Type	String	False		True	Original source category for the earliest recorded activity by a contact associated with the company, such as Organic Search or Direct Traffic.
Original Source Data 1	String	True		True	Additional descriptive information related to the original source for the earliest recorded activity.
HsAnalyticsSourceData1TimestampEarliestValue	Datetime	True		True	Timestamp for the earliest occurrence of original source data 1 across associated contacts.
Original Source Data 2	String	True		True	Supplementary descriptive information providing more context about the original source of the earliest contact activity.
HsAnalyticsSourceData2TimestampEarliestValue	Datetime	True		True	Timestamp for the earliest occurrence of original source data 2 across associated contacts.
HsAnalyticsSourceTimestampEarliestValue	Datetime	True		True	Earliest timestamp indicating when the original source type was recorded for any associated contact.
Avatar FileManager key	String	True		True	Path to the company's avatar image stored in HubSpot's FileManager CDN. Set automatically.
Created by user ID	Decimal	True		True	ID of the user who originally created the company record. Automatically assigned by HubSpot.
Object create date_time	Datetime	True		True	Timestamp of the company's creation. Automatically populated and not manually editable.
Date entered Customer (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company entered the 'Customer' stage of the Lifecycle Stage Pipeline.
Date entered Evangelist (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company entered the 'Evangelist' stage of the Lifecycle Stage Pipeline.
Date entered Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company entered the 'Lead' stage of the Lifecycle Stage Pipeline.
Date entered Marketing Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company entered the 'Marketing Qualified Lead' stage of the Lifecycle Stage Pipeline.
Date entered Opportunity (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company entered the 'Opportunity' stage of the Lifecycle Stage Pipeline.
Date entered Other (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company entered the 'Other' stage of the Lifecycle Stage Pipeline.
Date entered Sales Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company entered the 'Sales Qualified Lead' stage of the Lifecycle Stage Pipeline.
Date entered Subscriber (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company entered the 'Subscriber' stage of the Lifecycle Stage Pipeline.
Date exited Customer (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company exited the 'Customer' stage of the Lifecycle Stage Pipeline.
Date exited Evangelist (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company exited the 'Evangelist' stage of the Lifecycle Stage Pipeline.
Date exited Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company exited the 'Lead' stage of the Lifecycle Stage Pipeline.
Date exited Marketing Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company exited the 'Marketing Qualified Lead' stage of the Lifecycle Stage Pipeline.
Date exited Opportunity (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company exited the 'Opportunity' stage of the Lifecycle Stage Pipeline.
Date exited Other (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company exited the 'Other' stage of the Lifecycle Stage Pipeline.
Date exited Sales Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company exited the 'Sales Qualified Lead' stage of the Lifecycle Stage Pipeline.
Date exited Subscriber (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the company exited the 'Subscriber' stage of the Lifecycle Stage Pipeline.
Ideal Customer Profile Tier	String	False		True	Classification of how closely the company matches your Ideal Customer Profile, typically Tier 1, Tier 2, or Tier 3.
Target Account	Bool	False		True	Indicates whether the company is designated as a target account for account-based marketing efforts.
Last Booked Meeting Date	Datetime	True		True	Date when the most recent meeting was booked with any contact associated with the company.
Last Logged Call Date	Datetime	True		True	Date when the most recent call was logged for any contact linked to the company.
Last Open Task Date	Datetime	True		True	Due date of the most recently opened task assigned to the company or associated contacts.
last sales activity date old	Datetime	True		True	Timestamp in seconds of the most recent sales activity involving the company. Used in legacy tracking.
Last Engagement Date	Datetime	True		True	Timestamp of the most recent engagement action, such as a form submission or meeting, excluding marketing emails.
Last Engagement Type	String	True		True	Type of the most recent engagement performed by a contact at the company, excluding bulk marketing emails.
Last Modified Date	Datetime	True		True	Timestamp of the latest property update made to the company record, including hidden and visible properties.
Latest create date of active subscriptions	Datetime	True		True	Timestamp when the most recent active subscription linked to this company was created.
Merged object IDs	String	True		True	List of company record IDs that have been merged into this record. Set automatically by HubSpot.
Number of blockers	Decimal	True		True	Total number of associated contacts at this company who are classified as blockers in the sales process.
Number of contacts with a buying role	Decimal	True		True	Total number of contacts associated with this company who have a designated buying role.
Number of decision makers	Decimal	True		True	Total number of contacts linked to this company who are marked as decision makers.
Number of open deals	Decimal	True		True	Total number of open deals currently associated with this company.
Record ID	Decimal	True		True	Unique ID assigned automatically to the company record in HubSpot.
Pinned Engagement ID	Decimal	True		True	ID of the engagement pinned at the top of the company's timeline for easy reference. Set automatically.
Pipeline	String	False		True	Pipeline associated with the company, often used for account-based sales processes.
Likelihood to close	Decimal	True		True	Calculated probability that a contact linked to this company will convert to a customer within the next 90 days.
HsPredictivecontactscoreV2NextMaxMax	Decimal	True		True	Maximum predictive lead score aggregated from all contacts associated with this company.
Read Only Object	Bool	True		True	Indicates whether this company record is read-only and cannot be manually edited.
Target Account2	String	False		True	Secondary field indicating target account status based on different account-based marketing programs.
Target Account Probability	Decimal	True		True	Probability score indicating how likely the company is to qualify as a target account.
Target Account Recommendation Snooze Time	Datetime	False		True	Timestamp recording when a recommendation to target this company was snoozed.
Target Account Recommendation State	String	False		True	Current recommendation status for targeting the company, such as Active or Snoozed.
Time in Customer (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the company spent in the 'Customer' stage of the Lifecycle Stage Pipeline.
Time in Evangelist (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the company spent in the 'Evangelist' stage of the Lifecycle Stage Pipeline.
Time in Lead (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the company spent in the 'Lead' stage of the Lifecycle Stage Pipeline.
Time in Marketing Qualified Lead (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the company spent in the 'Marketing Qualified Lead' stage of the Lifecycle Stage Pipeline.
Time in Opportunity (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the company spent in the 'Opportunity' stage of the Lifecycle Stage Pipeline.
Time in Other (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the company spent in the 'Other' stage of the Lifecycle Stage Pipeline.
Time in Sales Qualified Lead (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the company spent in the 'Sales Qualified Lead' stage of the Lifecycle Stage Pipeline.
Time in Subscriber (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the company spent in the 'Subscriber' stage of the Lifecycle Stage Pipeline.
Total open deal value	Decimal	True		True	Sum of the values of all open deals linked to the company, calculated in the company's default currency.
Unique creation key	String	True		True	Property used to uniquely identify the company during import or integration processes to avoid duplicates.
Updated by user ID	Decimal	True		True	User ID of the last user who updated the company record. Set automatically by HubSpot.
User IDs of all notification followers	String	True		True	List of user IDs who opted to receive notifications about updates to this company.
User IDs of all notification unfollowers	String	True		True	List of user IDs who opted out of receiving notifications about updates to this company.
User IDs of all owners	String	True		True	List of all owner user IDs assigned to this company.
Owner Assigned Date	Datetime	True		True	Timestamp of the most recent assignment of an owner to this company record.
Is Public	Bool	False		True	Indicates whether the company is publicly traded, as determined by HubSpot Insights or user input.
Number of Associated Contacts	Decimal	True		True	Total number of contact records currently linked to this company.
Number of Associated Deals	Decimal	True		True	Total number of deal records currently associated with this company.
Number of Form Submissions	Decimal	True		True	Total number of form submissions completed by contacts associated with this company.
NumConversionEventsCardinalitySum	Decimal	True		True	Aggregated sum of all conversion events across contacts linked to this company, calculated via rollup.
Recent Conversion Date	Datetime	True		True	Most recent date a conversion event, such as a form submission, was completed by a contact associated with the company.
RecentConversionDateTimestampLatestValue	Datetime	True		True	Timestamp of the most recent conversion event aggregated across all associated contacts.
Recent Conversion	String	True		True	Name of the most recent form or event submitted by a contact associated with this company.
RecentConversionEventNameTimestampLatestValue	Datetime	True		True	Timestamp of the latest recorded event name for a recent conversion associated with this company.
Recent Deal Amount	Decimal	True		True	Monetary amount of the most recently closed deal associated with the company.
Recent Deal Close Date	Datetime	True		True	Date when the most recent deal associated with this company was marked as closed-won.
Time Zone	String	False		True	Time zone associated with the company's primary address, populated via HubSpot Insights if available.
Total Money Raised	String	False		True	Total amount of capital raised by the company, based on external data sources such as HubSpot Insights.
Total Revenue	Decimal	True		True	Sum of all revenue from closed-won deals associated with the company.
Company name	String	False		True	Official name of the company as stored in HubSpot.
HubSpot Owner Email	String	False		True	Email address of the HubSpot user assigned as the primary owner of the company.
Twitter Handle	String	False		True	Primary Twitter username or handle associated with the company.
HubSpot Owner Name	String	False		True	Full name of the HubSpot user assigned as the company's owner.
Phone Number	String	False		True	Primary phone number for the company, typically populated from HubSpot Insights or manually entered.
Twitter Bio	String	False		True	Biography text pulled from the company's Twitter profile.
Twitter Followers	Decimal	False		True	Total number of followers on the company's official Twitter account.
Street Address	String	False		True	Street address of the company, including building, suite, or unit number if applicable.
Street Address 2	String	False		True	Additional address information for the company such as a second line for building or floor information.
Facebook Company Page	String	False		True	URL link to the company's official Facebook page.
City	String	False		True	City where the company's headquarters or main office is located.
LinkedIn Company Page	String	False		True	URL link to the company's LinkedIn page.
LinkedIn Bio	String	False		True	Company description as displayed on its LinkedIn profile.
State_Region	String	False		True	State, province, or region where the company is located.
Google Plus Page	String	False		True	URL link to the company's Google Plus page (historical, for older records).
Date of last meeting booked in meetings tool	Datetime	True		True	Date of the last meeting scheduled by an associated contact via HubSpot's meetings tool.
Campaign of last booking in meetings tool	String	True		True	Urchin Tracking Module (UTM) campaign parameter representing the marketing campaign that led to the last meeting booked.
Medium of last booking in meetings tool	String	True		True	UTM medium parameter indicating the marketing channel, such as email or social media, responsible for the last meeting booking.
Source of last booking in meetings tool	String	True		True	UTM source parameter indicating the site or platform, such as LinkedIn or Twitter, that referred the contact for their most recent meeting.
Latest meeting activity	Datetime	True		True	Timestamp of the most recent meeting—past or upcoming—logged, booked, or scheduled with any contact at the company.
Recent Sales Email Replied Date	Datetime	True		True	Date when the most recent reply to a tracked sales email was received from the company.
Company owner	String	False		True	Name of the HubSpot user assigned as the owner of the company record.
Last Contacted	Datetime	True		True	Timestamp when the last call, one-to-one email, or meeting was logged for this company.
Last Activity Date	Datetime	True		True	Timestamp when the most recent note, call, email, meeting, or task was logged for the company.
Next Activity Date	Datetime	True		True	Scheduled date for the next sales activity associated with this company, such as a call or meeting.
Number of times contacted	Decimal	True		True	Total number of communication attempts, such as calls, emails, or meetings, logged for the company.
Number of Sales Activities	Decimal	True		True	Total number of sales-related activities recorded for the company, including calls and meetings.
Postal Code	String	False		True	Postal or ZIP code associated with the company's primary business address.
Country_Region	String	False		True	Country or region where the company's main office is located.
HubSpot Team	String	True		True	Name of the HubSpot team assigned to the company's primary owner.
All owner ids	String	True		True	List of owner property IDs, including default and custom, assigned to the company.
Website URL	String	False		True	Official website URL of the company, used for engagement and deduplication purposes.
Company Domain Name	String	False		True	Primary domain name associated with the company, used to link records and deduplicate companies.
All team ids	String	True		True	List of team IDs associated with ownership of the company, including default and custom teams.
All accessible team ids	String	True		True	List of team IDs, including inherited teams, that can access the company's ownership properties.
Number of Employees	Decimal	False		True	Total number of employees working at the company, based on HubSpot Insights or user entry.
Industry	String	False		True	Industry sector in which the company operates, based on predefined categories or custom entries.
Annual Revenue	Decimal	False		True	Annual revenue generated by the company, either provided manually or sourced from HubSpot Insights.
Lifecycle Stage	String	False		True	Stage representing the company's current sales or marketing qualification, such as Lead, Customer, or Evangelist.
Lead Status	String	False		True	Sales status assigned to the company, typically used during prospecting and qualification processes.
Parent Company	Decimal	True		True	Record ID of the parent company associated with this company if part of a corporate hierarchy.
Type	String	False		True	Optional classification indicating the type of company, such as Partner, Prospect, Customer, or Reseller.
Description	String	False		True	Brief narrative or summary describing the company's business or background.
Number of child companies	Decimal	True		True	Number of child company records linked to this parent company record.
HubSpot Score	Decimal	True		True	Score representing the company's sales-readiness, calculated based on engagement and profile attributes.
Create Date	Datetime	True		True	Timestamp marking when the company was created in HubSpot.
Close Date	Datetime	False		True	Date when the company was marked as a customer within HubSpot.
First Contact Create Date	Datetime	True		True	Date when the first contact associated with this company was created.
Days to Close	Decimal	True		True	Number of days elapsed between when the company record was created and when it was marked as a customer.
Web Technologies	String	False		True	List of web technologies detected on the company's website, such as CRM platforms, marketing tools, or analytics services.

CompanyAssociations

Lists object IDs associated with specific companies, useful for managing company-related associations.

Table Specific Information

Select

Note: You cannot reference custom objects by base name. When querying CompanyAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	Companies.Id	False	Unique identifier for the company record involved in the association.
AssociationId [KEY]	Long	False		False	Unique ID of the HubSpot object (such as a contact, deal, or ticket) associated with the company.
Type [KEY]	String	False		True	Type of the associated HubSpot object (such as contact, deal, or ticket) linked to the company record.

CompanyPipelines

Provides pipelines associated with companies, used to visualize and manage company lifecycle stages.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for the company pipeline.
Label	String	False		False	Display name or label assigned to the company pipeline.
Archived	Bool	True		False	Indicates whether the pipeline is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp marking when the pipeline was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the pipeline.
DisplayOrder	Int	False		False	Numeric value that determines the display order of this pipeline relative to others in the same table.
StagesAggregate	String	False		False	Serialized list of all stages included in this pipeline. Detailed stage information is available in the CompanyPipelineStages table.

CompanyPipelineStages

Lists stages within company pipelines, helping manage progress through company-related workflows.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for the individual stage within the company pipeline.
PipelineId [KEY]	String	False	CompanyPipelines.Id	False	Unique identifier of the pipeline to which this stage belongs.
Label	String	False		False	Display name or label assigned to the pipeline stage.
PipelineLabel	String	True	CompanyPipelines.Label	False	Name of the pipeline that includes this stage.
IsClosed	Bool	False		False	Indicates whether this stage represents a closed state (such as won or lost) or remains open.
State	String	False		False	Current state of the pipeline stage.
Archived	Bool	True		False	Indicates whether this pipeline stage is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp marking when the pipeline stage was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the pipeline stage.
DisplayOrder	Int	False		False	Numeric value determining the display sequence of this stage within the pipeline.

CompanyProperties

Retrieves all available company property fields in HubSpot, supporting company data enrichment.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the company property, consisting of lowercase letters and numbers, starting with a letter. Serves as the unique identifier.
Label	String	False		False	User-friendly label displayed in HubSpot's UI to represent the company property.
FieldType	String	False		False	Defines the input field type (such as text, dropdown, checkbox) for this property as displayed in the UI.
Type	String	False		False	Underlying machine data type (such as string, number, or date) used to store the property's value.
GroupName	String	False		False	Identifies the property group this company property belongs to for organizational display.
Description	String	False		False	Detailed explanation of the property's purpose and how it is used in company records.
DisplayOrder	Int	False		False	Numeric value determining the order this property appears relative to others within its group.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are sourced from an external system.
IsFormField	Bool	False		False	Specifies whether this property appears as an editable field within HubSpot forms.
IsCalculated	Bool	False		False	Indicates whether the property's value is automatically calculated based on other data.
IsHidden	Bool	False		False	Determines whether the property is hidden from standard views in the HubSpot interface.
IsHubspotDefined	Bool	False		False	True if the property is predefined by HubSpot, false if it was custom-created.
Archivable	Bool	False		False	Indicates whether this property can be archived and removed from active use.
ReadOnlyDefinition	Bool	False		False	Specifies whether the property's definition (such as type or label) is locked and cannot be modified.
ReadOnlyValue	Bool	False		False	Specifies whether the property's value is read-only and not editable by users.
OptionsAggregate	String	False		False	Serialized list of selectable options for the property, relevant when FieldType supports multiple-choice fields (such as radio buttons, checkboxes, or boolean checkboxes).
HasUniqueValue	Bool	False		False	Indicates whether each company's value for this property must be unique across all records.

CompanyPropertyGroups

Provides access to groups used to organize company properties for easier data management.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name used to identify the company property group.
Label	String	False		False	Display label for the property group, shown in the HubSpot UI.
DisplayOrder	Int	False		False	Numeric value that determines the display sequence of this property group relative to others.

ContactAssociations

Lists object IDs associated with specific contacts, supporting management of contact associations.

View Specific Information

This is a sample associations table exposed when the ExpandAssociations connection property is set to False (default).

SELECT

A query to this table will return will return the Id-s of all the records and their corresponding object type associated to a specific Contact record.

SELECT * FROM ContactAssociations

Note: You cannot reference custom objects by base name. When querying ContactAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

INSERT

To add a new association between a Contacts record and a Deals one, you need to specify the Id-s of the two records to be associated and the deal object type.

INSERT INTO ContactAssociations (Id, AssociationId, Type) VALUES ('3432', '34654', 'Deal')

To add a new association between a Contacts record and a custom object one, you need to specify the Id-s of the two records to be associated and the custom object FullyQualifiedName as the Type. Note: You can find the Object FullyQualifiedName by querying the CustomObjects view.

INSERT INTO ContactAssociations (Id, AssociationId, Type) VALUES ('3432', '453545', 'p5692228_event')

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	Contacts.Id	False	Unique identifier for the contact involved in the association.
AssociationId [KEY]	Long	False		False	Unique ID of the HubSpot object (such as a deal, company, or ticket) associated with the contact.
Type [KEY]	String	False		True	Type of the associated HubSpot object (such as deal, company, or ticket) linked to the contact record.

ContactPipelines

Retrieves pipelines configured for managing contact progress through different lifecycle stages.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for the contact pipeline.
Label	String	False		False	Display name or label assigned to the contact pipeline.
Archived	Bool	True		False	Indicates whether the pipeline is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp marking when the pipeline was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the pipeline.
DisplayOrder	Int	False		False	Numeric value that determines the display order of this pipeline relative to others in the same table.
StagesAggregate	String	False		False	Serialized list of all stages included in this pipeline. Detailed stage information is available in the ContactPipelineStages table.

ContactPipelineStages

Lists stages within the contact pipeline to track the progress of contacts through various lifecycle stages.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for the individual stage within the contact pipeline.
PipelineId [KEY]	String	False	ContactPipelines.Id	False	Unique identifier of the pipeline to which this stage belongs.
Label	String	False		False	Display name or label assigned to the pipeline stage.
PipelineLabel	String	True	ContactPipelines.Label	False	Name of the pipeline that includes this stage.
IsClosed	Bool	False		False	Indicates whether this stage represents a closed state (such as won or lost) or remains open.
State	String	False		False	Current state of the pipeline stage.
Archived	Bool	True		False	Indicates whether this pipeline stage is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp marking when the pipeline stage was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the pipeline stage.
DisplayOrder	Int	False		False	Numeric value determining the display sequence of this stage within the pipeline.

ContactProperties

Retrieves all available contact property fields in HubSpot, including both standard and custom properties.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the contact property, consisting of lowercase letters and numbers, starting with a letter. Serves as the unique identifier.
Label	String	False		False	User-friendly label displayed in the HubSpot UI to represent the contact property.
FieldType	String	False		False	Defines the input field type (such as text, dropdown, or checkbox) for this property as displayed in the UI.
Type	String	False		False	Underlying machine data type (such as string, number, or date) used to store the property's value.
GroupName	String	False		False	Identifies the property group this contact property belongs to for organizational display.
Description	String	False		False	Detailed explanation of the property's purpose and how it is used in contact records.
DisplayOrder	Int	False		False	Numeric value determining the order this property appears relative to others within its group.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are sourced externally.
IsFormField	Bool	False		False	Specifies whether this property appears as an editable field within HubSpot forms.
IsCalculated	Bool	False		False	Indicates whether the property's value is automatically calculated based on other properties or data.
IsHidden	Bool	False		False	Determines whether the property is hidden from standard views in the HubSpot interface.
IsHubspotDefined	Bool	False		False	True if the property is predefined by HubSpot, false if it was custom-created.
Archivable	Bool	False		False	Indicates whether this property can be archived and removed from active use.
ReadOnlyDefinition	Bool	False		False	Specifies whether the property's definition (such as type or label) is locked and cannot be modified.
ReadOnlyValue	Bool	False		False	Specifies whether the property's value is read-only and not editable by users.
OptionsAggregate	String	False		False	Serialized list of selectable options for the property, relevant when FieldType supports multiple-choice fields (such as radio buttons, checkboxes, or boolean checkboxes).
HasUniqueValue	Bool	False		False	Indicates whether each contact's value for this property must be unique across all records.

ContactPropertyGroups

Provides groups used to organize contact properties, simplifying property management.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name used to identify the contact property group.
Label	String	False		False	Display label for the property group, shown in the HubSpot UI.
DisplayOrder	Int	False		False	Numeric value that determines the display sequence of this property group relative to others.

Contacts

Retrieves contact records from HubSpot, supporting both OAuth and private-app token authentication methods.

Table Specific Information

In HubSpot, contacts store information about individuals. The lead-specific data contained in contact records supports various functionalities, from marketing automation to smart content, helping users make the most of the platform.

SELECT

When selecting contacts, filtering is supported primarily by specific fields like Email or a custom unique identifier property. While some columns are marked as 'Filterable', server-side filtering is only truly effective for fields that HubSpot's API natively supports, such as email or properties specifically created as unique identifiers. For all other fields, the driver performs client-side filtering, retrieving a broader dataset from HubSpot and applying filters locally.

For example, for fields like Email, you can perform server-side filtering directly using the API:

SELECT * FROM Contacts WHERE Email = '[email protected]'
SELECT * FROM Contacts WHERE Email != '[email protected]'

For fields not natively supported by the API for server-side filtering, the query retrieves all contacts from HubSpot and applies filters locally:

SELECT * FROM Contacts WHERE [Company Name] = 'CData' OR [Last Name] = 'Robinson'
SELECT * FROM Contacts WHERE [Associated Deals] = 3 AND [First Deal Created Date] > '2019-01-01'

HubSpot also supports querying using custom unique identifier properties if these have been defined. For example:

SELECT * FROM Contacts WHERE CustomUniqueId = '12345'

INSERT

INSERT INTO Contacts ([Field of study]) VALUES ('uni')

UPSERT

UPSERT operations can be used to create a new contact record if it doesn't exist, or update it if it already exists. You must specify an ExternalIdColumn to identify the record.

UPSERT INTO Contacts (`First name`, `Email`, `Upsert Property`, `ExternalIdColumn`) VALUES ('John', '[email protected]', '31d06273-de69-4150-9ece-764d267222f6', 'Upsert Property')

Note

Only AtomicBatch upserts are supported for Contacts when ExternalIdColumn is set to 'Email'.
AtomicBatch: If one batch item fails, the entire batch fails. No records are written to HubSpot.

UPDATE

UPDATE Contacts SET [Field of study] = 'new uni' WHERE ID = '25151'

DELETE

DELETE FROM Contacts WHERE ID = '25151'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique numeric identifier for the contact record.
Archived	Bool	True		False	Indicates whether the contact record is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp marking when the contact record was created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the contact record.
ItemURL	String	True		False	Direct URL linking to the contact's record within HubSpot.
Company size	String	False		True	Size classification of the contact's company. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Date of birth	String	False		True	Contact's date of birth. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Days To Close	Decimal	True		True	Number of days from contact creation until they are marked as a customer. Set automatically.
Degree	String	False		True	Contact's academic degree. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Field of study	String	False		True	Contact's academic field of study. Required for Facebook Ads Integration; synced automatically from Lead Ads.
First Conversion Date	Datetime	True		True	Date when the contact first submitted a form or performed a conversion action.
First Conversion	String	True		True	The first form submitted by the contact.
First Deal Created Date	Datetime	True		True	Date when the first deal was created and associated with the contact. Set automatically.
Gender	String	False		True	Contact's gender. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Graduation date	String	False		True	Contact's graduation date. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Additional email addresses	String	True		True	List of additional email addresses associated with the contact.
Business units	String	False		True	The business units to which this contact record is assigned.
All vids for a contact	String	True		True	List of all visitor IDs (VIDs) linked to the contact, including canonical and merged VIDs.
First Touch Converting Campaign	String	True		True	Marketing campaign responsible for the first-touch creation of this contact.
Last Touch Converting Campaign	String	True		True	Marketing campaign responsible for the last-touch creation of this contact.
Avatar FileManager key	String	True		True	File path in HubSpot's FileManager CDN for the contact's avatar override image. Managed automatically.
Buying Role	String	False		True	Sales role assigned to the contact during the sales process. Contacts can have multiple roles or share roles.
All form submissions for a contact	String	True		True	List of all form submissions made by the contact.
Merged vids with timestamps of a contact	String	True		True	List of merged visitor IDs (VIDs) along with timestamps for the contact.
Calculated Mobile Number in International Format	String	True		True	Contact's mobile number formatted in international dialing format.
Calculated Phone Number in International Format	String	True		True	Contact's primary phone number formatted in international dialing format.
Calculated Phone Number Area Code	String	True		True	Area code extracted from the contact's primary phone number.
Calculated Phone Number Country Code	String	True		True	Country code extracted from the contact's primary phone number.
Calculated Phone Number Region	String	True		True	ISO2 country code derived from the contact's phone number.
Clicked on a LinkedIn Ad	String	False		True	Indicates whether the contact has clicked on a LinkedIn ad.
Email Confirmed	Bool	True		True	Indicates whether the contact's email address has been confirmed for content membership.
Registration Follow Up Email Enqueued At	Datetime	False		True	Timestamp of when the first content membership registration follow-up email was queued for sending.
Membership Notes	String	False		True	Notes or comments related to the contact's content membership status.
Registered At	Datetime	True		True	Datetime when the contact was registered for content membership.
Domain to which registration email was sent	String	True		True	Domain of the email address where the content membership registration invitation was sent.
Time registration email was sent	Datetime	True		True	Datetime when the content membership registration invitation email was sent.
Status	String	False		True	Current status of the contact's content membership.
Conversations visitor email	String	True		True	Email address provided by the visitor during a Conversations session.
Count of unengaged contacts	Decimal	True		True	Set to 1 if the contact is assigned but not yet engaged; set to 0 if assigned and engaged.
Count of engaged contacts	Decimal	True		True	Set to 1 if the contact is assigned and engaged; set to 0 if assigned but unengaged.
Created By Conversations	Bool	True		True	Indicates whether this contact was created via the Conversations API.
Created by user ID	Decimal	True		True	User ID of the individual who created this contact. Set automatically by HubSpot.
Object create date_time	Datetime	True		True	Timestamp marking when this contact record was created. Set automatically and not editable.
Date entered Customer (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact entered the 'Customer' stage within the Lifecycle Stage Pipeline.
Date entered Evangelist (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact entered the 'Evangelist' stage within the Lifecycle Stage Pipeline.
Date entered Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact entered the 'Lead' stage within the Lifecycle Stage Pipeline.
Date entered Marketing Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact entered the 'Marketing Qualified Lead' stage within the Lifecycle Stage Pipeline.
Date entered Opportunity (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact entered the 'Opportunity' stage within the Lifecycle Stage Pipeline.
Date entered Other (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact entered the 'Other' stage within the Lifecycle Stage Pipeline.
Date entered Sales Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact entered the 'Sales Qualified Lead' stage within the Lifecycle Stage Pipeline.
Date entered Subscriber (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact entered the 'Subscriber' stage within the Lifecycle Stage Pipeline.
Date exited Customer (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact exited the 'Customer' stage within the Lifecycle Stage Pipeline.
Date exited Evangelist (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact exited the 'Evangelist' stage within the Lifecycle Stage Pipeline.
Date exited Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact exited the 'Lead' stage within the Lifecycle Stage Pipeline.
Date exited Marketing Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact exited the 'Marketing Qualified Lead' stage within the Lifecycle Stage Pipeline.
Date exited Opportunity (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact exited the 'Opportunity' stage within the Lifecycle Stage Pipeline.
Date exited Other (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact exited the 'Other' stage within the Lifecycle Stage Pipeline.
Date exited Sales Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact exited the 'Sales Qualified Lead' stage within the Lifecycle Stage Pipeline.
Date exited Subscriber (Lifecycle Stage Pipeline)	Datetime	True		True	Date and time when the contact exited the 'Subscriber' stage within the Lifecycle Stage Pipeline.
Recent Document Revisit Date	Datetime	True		True	Last time the contact accessed a shared document or presentation.
Invalid email address	Bool	True		True	Indicates whether the email address associated with the contact is invalid.
Email address quarantine reason	String	False		True	Reason the email address has been quarantined, typically for security or compliance reasons.
Email Domain	String	True		True	Domain portion of the contact's primary email address.
Email hard bounce reason	String	True		True	Reason the contact's email address caused a hard bounce during email sending.
Email hard bounce reason2	String	True		True	Additional reason details for a hard bounce event on the contact's email address.
Email Address Quarantined	Bool	True		True	Indicates whether the contact's email address has been quarantined due to anti-abuse policies.
Email address automated quarantine reason	String	True		True	System-generated reason explaining why the email address was quarantined automatically.
Email Address Recipient Fatigue Next Available Sending Time	Datetime	True		True	Timestamp when the contact will next be eligible to receive marketing emails after reaching recipient fatigue limits.
Sends Since Last Engagement	Decimal	True		True	Total number of marketing emails sent to this contact since their last engagement, such as an open or click. Tracked automatically.
Marketing email confirmation status	String	True		True	Status indicating whether the contact is eligible to receive marketing emails. Managed automatically by HubSpot.
Clicked Facebook ad	Bool	False		True	Indicates whether the contact has clicked on a Facebook ad.
Facebook click id	String	False		True	Unique identifier associated with the contact's click on a Facebook ad for tracking purposes.
Facebook ID	String	False		True	Contact's unique Facebook ID, used for integration and tracking.
Last NPS survey comment	String	True		True	Comment provided by the contact during their most recent Net Promoter Score (NPS) survey.
Last NPS survey rating	String	True		True	Numeric rating submitted by the contact in their most recent NPS survey response.
Last NPS survey date	Datetime	True		True	Timestamp when the contact last submitted an NPS survey response. Set automatically by HubSpot.
Should be shown an NPS web survey	Bool	False		True	Indicates whether the contact is eligible to be shown a Net Promoter Score (NPS) web survey. Managed automatically by HubSpot.
ID of first engagement	Decimal	True		True	Object ID of the first engagement, such as a call or email, between the contact and their owner. Used in Sales Analytics.
First subscription create date	Datetime	True		True	Date when the contact's first subscription was created.
Google ad click id	String	False		True	Unique identifier linked to the contact's click on a Google ad for tracking purposes.
googleplus ID	String	False		True	Contact's Google+ ID, used for legacy social integrations.
Contact has an active subscription	Decimal	True		True	Indicates if the contact currently has an active subscription (1 = active, 0 = inactive).
IP Timezone	String	True		True	Time zone detected from the contact's IP address. Set automatically for segmentation and reporting.
Is a contact	Bool	True		True	Indicates whether the record represents an active contact, not deleted or classified as a visitor.
Contact unworked	Bool	True		True	Flag showing whether the contact has not been assigned or engaged since the last owner assignment or reassignment.
last sales activity date old	Datetime	True		True	Date of the last recorded sales activity involving this contact. Updated automatically for owned contacts.
Last Engagement Date	Datetime	True		True	Date of the last engagement by the contact, such as visiting a site, submitting a form, or replying to an email. Excludes bulk marketing emails.
Last Engagement Type	String	True		True	Type of the most recent engagement performed by the contact, excluding bulk marketing emails.
Object last modified date_time	Datetime	True		True	Timestamp of the most recent update to any property on the contact. Managed automatically by HubSpot.
Last sequence ended date	Datetime	True		True	Date when the contact last exited a sales sequence.
Last sequence enrolled	Decimal	True		True	ID of the last sales sequence in which the contact was enrolled.
Last sequence enrolled date	Datetime	True		True	Date when the contact was last enrolled in a sales sequence.
Last sequence finished date	Datetime	True		True	Date when the contact completed their last sales sequence.
Last sequence unenrolled date	Datetime	True		True	Date when the contact was unenrolled from their last sales sequence.
Latest Source Date	Date	False		True	Date of the most recent website session or tracked interaction for the contact.
Latest subscription create date	Datetime	True		True	Date when the contact's latest subscription was created.
Lead Status	String	False		True	Current sales, prospecting, or outreach status assigned to the contact.
Legal basis for processing contact's data	String	False		True	The legal justification for processing the contact's data. 'Not applicable' exempts the contact from GDPR protections.
Clicked LinkedIn Ad	String	False		True	Indicates whether the contact has clicked on a LinkedIn ad.
Linkedin ID	String	False		True	Contact's LinkedIn ID, used for integrations and profile enrichment.
Marketing contact status source name	String	True		True	ID of the process or activity that set this contact as a marketing contact.
Marketing contact status source type	String	True		True	Type of source, such as workflow or API, that assigned the marketing contact status.
Marketing contact status	String	True		True	The contact's current marketing status, determining eligibility for marketing emails and billing.
Marketing contact until next update	String	True		True	Specifies whether the contact will be converted to non-marketing status during the next update cycle.
Merged object IDs	String	True		True	List of contact record IDs merged into this contact. Managed automatically by HubSpot.
Record ID	Decimal	True		True	Unique identifier for this contact record, assigned by HubSpot.
Pinned engagement ID	Decimal	True		True	ID of the engagement pinned to the contact's timeline for quick reference.
Pipeline	String	False		True	The pipeline to which this contact is currently assigned, typically reflecting sales or marketing workflows.
Likelihood to close	Decimal	True		True	Predictive score indicating the probability of this contact becoming a customer within 90 days.
Contact priority	String	True		True	Tiered ranking indicating the contact's likelihood to convert, with tier one being the highest priority.
Read Only Object	Bool	True		True	Indicates whether the contact record is read-only and cannot be modified.
Date of first engagement	Datetime	True		True	Date when the contact owner first engaged with this contact, such as through a call, email, or meeting. Used in Sales Analytics.
Description of first engagement	String	True		True	Description of the initial engagement between the contact and their owner. Used in Sales Analytics.
Type of first engagement	String	True		True	The type of the first engagement object, such as call, email, or meeting. Used in Sales Analytics.
Recent Sales Email Clicked Date	Datetime	True		True	Date when the contact last clicked a link in a tracked sales email.
Recent Sales Email Opened Date	Datetime	True		True	Date when the contact last opened a tracked sales email. Excludes bulk marketing emails.
Calculated Mobile Number with country code	String	True		True	Contact's mobile phone number formatted to include the country code.
Calculated Phone Number with country code	String	True		True	Contact's primary phone number formatted to include the country code.
Calculated Mobile Number without country code	String	True		True	Contact's mobile phone number formatted without the country code.
Calculated Phone Number without country code	String	True		True	Contact's primary phone number formatted without the country code.
Number of sequences actively enrolled	Decimal	True		True	Number of active sales sequences in which the contact is currently enrolled.
Number of sequences enrolled	Decimal	True		True	Total number of sales sequences in which the contact has been enrolled.
Currently in Sequence	Bool	True		True	Indicates whether the contact is currently active in a sales sequence.
testpurge	String	True		True	Placeholder field used for testing purge operations.
testrollback	String	True		True	Placeholder field used for testing rollback operations.
Time between contact creation and deal close	Decimal	False		True	Total time elapsed between the contact's creation and the closing of an associated deal.
Time between contact creation and deal creation	Decimal	False		True	Total time elapsed between the contact's creation and the creation of an associated deal.
Time in Customer (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the contact spent in the 'Customer' stage within the Lifecycle Stage Pipeline.
Time in Evangelist (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the contact spent in the 'Evangelist' stage within the Lifecycle Stage Pipeline.
Time in Lead (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the contact spent in the 'Lead' stage within the Lifecycle Stage Pipeline.
Time in Marketing Qualified Lead (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the contact spent in the 'Marketing Qualified Lead' stage within the Lifecycle Stage Pipeline.
Time in Opportunity (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the contact spent in the 'Opportunity' stage within the Lifecycle Stage Pipeline.
Time in Other (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the contact spent in the 'Other' stage within the Lifecycle Stage Pipeline.
Time in Sales Qualified Lead (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the contact spent in the 'Sales Qualified Lead' stage within the Lifecycle Stage Pipeline.
Time in Subscriber (Lifecycle Stage Pipeline)	Decimal	True		True	Total time in seconds the contact spent in the 'Subscriber' stage within the Lifecycle Stage Pipeline.
Lead response time	Decimal	True		True	Time in milliseconds it took for the contact owner to make the first qualifying engagement. Used in Sales Analytics.
Time to move from lead to customer	Decimal	False		True	Time it took for the contact to progress from the Lead stage to the Customer stage.
Time to move from marketing qualified lead to customer	Decimal	False		True	Time it took for the contact to progress from the Marketing Qualified Lead stage to the Customer stage.
Time to move from opportunity to customer	Decimal	False		True	Time it took for the contact to progress from the Opportunity stage to the Customer stage.
Time to move from sales qualified lead to customer	Decimal	False		True	Time it took for the contact to progress from the Sales Qualified Lead stage to the Customer stage.
Time to move from subscriber to customer	Decimal	False		True	Time it took for the contact to progress from the Subscriber stage to the Customer stage.
Time Zone	String	False		True	Time zone associated with the contact, either set automatically by HubSpot or manually assigned.
Twitter ID	String	False		True	Unique identifier for the contact's Twitter account.
Unique creation key	String	True		True	Unique key used to ensure idempotent creation of the contact record.
Updated by user ID	Decimal	True		True	User ID of the person who last updated the contact record. Managed automatically by HubSpot.
User IDs of all notification followers	String	True		True	List of user IDs who have opted to receive notifications for updates related to this contact.
User IDs of all notification unfollowers	String	True		True	List of user IDs who opted out of receiving notifications about this contact.
User IDs of all owners	String	True		True	List of user IDs assigned as owners of this contact.
WhatsApp Phone Number	String	False		True	Phone number linked to the contact's WhatsApp account.
Owner Assigned Date	Datetime	True		True	Date and time when the contact was last assigned to a HubSpot owner. Set automatically.
IP City	String	True		True	City detected from the contact's IP address. Set automatically for segmentation and reporting.
IP Country	String	True		True	Country detected from the contact's IP address. Set automatically by HubSpot.
IP Country Code	String	True		True	Country code detected from the contact's IP address. Set automatically by HubSpot.
IP Latitude _ Longitude	String	True		True	Latitude and longitude coordinates detected from the contact's IP address.
IP State_Region	String	True		True	State or region detected from the contact's IP address. Set automatically by HubSpot.
IP State Code_Region Code	String	True		True	State or region code detected from the contact's IP address. Set automatically by HubSpot.
IP Zipcode	String	True		True	ZIP or postal code detected from the contact's IP address. Set automatically.
Job function	String	False		True	The contact's job function. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Last Modified Date	Datetime	True		True	Date when any property on the contact was last updated.
Marital Status	String	False		True	The contact's marital status. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Military status	String	False		True	The contact's military status. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Number of Associated Deals	Decimal	True		True	Total number of deals linked to this contact. Set automatically by HubSpot.
Number of Form Submissions	Decimal	True		True	Total number of forms submitted by this contact.
Number of Unique Forms Submitted	Decimal	True		True	Number of distinct forms submitted by this contact.
Recent Conversion Date	Datetime	True		True	Date when the contact last submitted a form.
Recent Conversion	String	True		True	Name of the most recent form submitted by the contact.
Recent Deal Amount	Decimal	True		True	Value of the most recent closed-won deal associated with this contact.
Recent Deal Close Date	Datetime	True		True	Date when the most recent associated deal was marked as closed-won.
Relationship Status	String	False		True	The contact's relationship status. Required for Facebook Ads Integration; synced automatically from Lead Ads.
School	String	False		True	The contact's school name. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Seniority	String	False		True	The contact's seniority level. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Start date	String	False		True	The contact's job start date. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Total Revenue	Decimal	True		True	Sum of revenue from all closed-won deals associated with this contact. Set automatically.
Work email	String	False		True	The contact's work email address. Required for Facebook Ads Integration; synced automatically from Lead Ads.
First Name	String	False		True	The contact's first name.
First Page Seen	String	True		True	The first page visited by the contact on your website. Set automatically.
Marketing emails delivered	Decimal	True		True	Total number of marketing emails delivered to this contact. Set automatically by HubSpot.
Opted out of emailCustomer Service Communication	String	True		True	Indicates if the contact has opted out of customer service-related emails.
Opted out of emailOne to One	String	True		True	Custom field indicating if the contact has opted out of one-to-one emails.
Twitter Username	String	False		True	The contact's Twitter handle.
Currently in workflow	String	True		True	Indicates if the contact is actively enrolled in a HubSpot workflow.
Follower Count	Decimal	False		True	The number of Twitter followers associated with the contact.
Last Page Seen	String	True		True	The last page visited by the contact on your website. Set automatically.
Marketing emails opened	Decimal	True		True	Total number of marketing emails opened by this contact. Set automatically.
Last Name	String	False		True	The contact's last name.
Number of Pageviews	Decimal	True		True	Total number of website page views recorded for this contact. Set automatically.
Marketing emails clicked	Decimal	True		True	Total number of marketing emails clicked by the contact. Set automatically.
Salutation	String	False		True	The title or greeting used to address the contact, such as Mr., Ms., or Dr.
Twitter Profile Photo	String	False		True	URL of the contact's Twitter profile photo, set automatically by HubSpot.
Email	String	False		True	The primary email address associated with the contact.
Number of Sessions	Decimal	True		True	Total number of sessions, or visits, the contact has initiated on your website. Set automatically.
Marketing emails bounced	Decimal	True		True	Total number of marketing emails that bounced for this contact. Set automatically.
Persona	String	False		True	Persona assigned to the contact, used for marketing segmentation and targeting.
Most Recent Social Click	Datetime	True		True	Date of the most recent click by the contact on a published social media post. Set automatically.
Number of event completions	Decimal	True		True	Total number of event completions by the contact, such as webinars or surveys. Set automatically.
Unsubscribed from all email	Bool	True		True	Indicates whether the contact has opted out of receiving all email communications.
Twitter Clicks	Decimal	True		True	Number of clicks made by the contact on links shared through Twitter posts managed by HubSpot. Set automatically.
Mobile Phone Number	String	False		True	The contact's mobile phone number.
Phone Number	String	False		True	The primary phone number for the contact.
Fax Number	String	False		True	The contact's fax number, if available.
Time First Seen	Datetime	True		True	Timestamp of the first time the contact visited your website. Set automatically.
Last marketing email name	String	True		True	Name of the last marketing email sent to the contact. Set automatically.
Last marketing email send date	Datetime	True		True	Date when the most recent marketing email was sent to the contact. Set automatically.
Facebook Clicks	Decimal	True		True	Number of times the contact clicked on links shared via Facebook posts. Set automatically.
Street Address	String	False		True	Street address for the contact, including apartment or unit number if applicable.
Date of last meeting booked in meetings tool	Datetime	True		True	Date when the last meeting was scheduled by the contact using the meetings tool.
Campaign of last booking in meetings tool	String	True		True	UTM campaign parameter identifying the campaign responsible for the last meeting booked.
Medium of last booking in meetings tool	String	True		True	UTM medium parameter identifying the channel (such as email) responsible for the last meeting booking.
Source of last booking in meetings tool	String	True		True	UTM source parameter identifying the site (such as LinkedIn or Twitter) responsible for the last meeting booking.
Time of First Session	Datetime	True		True	Timestamp of the first session initiated by the contact on your website. Set automatically.
Last marketing email open date	Datetime	True		True	Date when the contact last opened a marketing email. Set automatically.
Latest meeting activity	Datetime	True		True	Date of the most recent meeting, whether past or upcoming, involving the contact.
Recent Sales Email Replied Date	Datetime	True		True	Date when the contact last replied to a tracked sales email. Set automatically by HubSpot.
LinkedIn Clicks	Decimal	True		True	Total number of times the contact clicked on links shared via LinkedIn posts. Set automatically.
Contact owner	String	False		True	The HubSpot or Salesforce user assigned as the primary owner of the contact.
Last Contacted	Datetime	True		True	The date and time when the contact was last contacted via a call, email, or meeting. Set automatically based on user actions.
Last Activity Date	Datetime	True		True	The date and time of the last logged activity, such as a note, call, email, or task, involving the contact. Set automatically.
Next Activity Date	Datetime	True		True	The date of the next scheduled activity, such as a call, task, or meeting, involving the contact.
Number of times contacted	Decimal	True		True	Total number of logged calls, emails, or meetings made with the contact. Set automatically by HubSpot.
Number of Sales Activities	Decimal	True		True	Total number of sales-related activities logged for the contact, including calls, emails, and meetings.
HubSpot Owner Email _legacy_	String	False		True	Legacy field capturing the email address of the contact's owner. No longer actively updated.
HubSpot Owner Name _legacy_	String	False		True	Legacy field capturing the name of the contact's owner. No longer actively updated.
SurveyMonkey Event Last Updated	Decimal	True		True	Internal field used to trigger updates when SurveyMonkey event data is refreshed.
Webinar Event Last Updated	Decimal	True		True	Internal field used to trigger updates when webinar event data is refreshed.
City	String	False		True	The city of residence for the contact. Can be set manually, by import, or via forms.
Time Last Seen	Datetime	True		True	Timestamp when the contact was most recently seen on your website. Set automatically.
Last marketing email click date	Datetime	True		True	Date when the contact last clicked a link inside a marketing email. Set automatically.
Google Plus Clicks	Decimal	True		True	Total number of times the contact clicked on links shared via Google Plus posts. Set automatically.
HubSpot Team	String	True		True	Team assignment of the contact's owner within HubSpot.
LinkedIn Bio	String	False		True	Biography or professional summary of the contact pulled from LinkedIn, if available.
Twitter Bio	String	False		True	Contact's biography from their Twitter profile, populated automatically if linked.
All owner ids	String	True		True	List of all owner IDs, including default and custom owners, associated with the contact.
Time of Last Session	Datetime	True		True	Timestamp marking the beginning of the contact's most recent website session.
First marketing email send date	Datetime	True		True	Date when the first marketing email was sent to the contact. Set automatically.
Broadcast Clicks	Decimal	True		True	Number of clicks by the contact on published social media messages. Set automatically.
State_Region	String	False		True	State or region of residence for the contact. Can be populated via import, form, or integration.
All team ids	String	True		True	List of team IDs related to the contact's ownership, including default and custom fields.
Original Source	String	False		True	The first recorded source through which the contact discovered your business, such as organic search or paid social. Set automatically.
First marketing email open date	Datetime	True		True	Date when the contact first opened a marketing email. Set automatically.
Latest Source	String	False		True	Source of the contact's most recent session or interaction, such as direct traffic or referral.
Postal Code	String	False		True	Postal or ZIP code for the contact's address. Can be set manually or via forms.
Country_Region	String	False		True	Country or region associated with the contact's address. Can be set via import, form, or integration.
All accessible team ids	String	True		True	List of all accessible team IDs associated with the contact, including inherited ownership.
Original Source DrillDown 1	String	True		True	Additional detail about the original source that brought the contact to your business. Set automatically.
First marketing email click date	Datetime	True		True	Date when the contact first clicked a link in a marketing email. Set automatically.
Latest Source DrillDown 1	String	True		True	Additional detail about the source of the latest session recorded for the contact. Set automatically.
LinkedIn Connections	Decimal	False		True	The number of LinkedIn connections associated with the contact, if available.
Original Source DrillDown 2	String	True		True	Further breakdown of how the contact first discovered your business. Set automatically.
Is globally ineligible	Bool	True		True	Indicates whether the contact is globally ineligible to receive any marketing emails.
Preferred language	String	False		True	The preferred language of communication for the contact. Set manually or via forms, imports, or integrations.
Latest Source DrillDown 2	String	True		True	Further detail about the source of the contact's latest session. Set automatically.
Klout Score	Decimal	False		True	The contact's Klout Score, a measure of social media influence (retained for legacy use).
First Referring Site	String	True		True	URL of the site that first referred the contact to your website. Set automatically by HubSpot.
First marketing email reply date	Datetime	True		True	Date when the contact first replied to a marketing email. Set automatically.
Job Title	String	False		True	The contact's job title, collected through forms, imports, or integrations.
Photo	String	False		True	URL of the contact's social media profile photo, populated automatically if available.
Last Referring Site	String	True		True	URL of the last site that referred the contact to your website. Set automatically.
Last marketing email reply date	Datetime	True		True	Date when the contact most recently replied to a marketing email. Set automatically.
Message	String	False		True	General-purpose field for capturing a contact's message or comment submitted through a form.
Close Date	Datetime	False		True	Date when the contact was marked as a customer, usually tied to a closed-won deal.
Average Pageviews	Decimal	True		True	Average number of pageviews per session by the contact on your website. Set automatically.
Marketing emails replied	Decimal	True		True	Total number of marketing emails to which the contact has replied. Set automatically.
Event Revenue	Decimal	True		True	Revenue value attributed to the contact through tracked events. Used with Enterprise Events features.
Became a Lead Date	Datetime	True		True	Date when the contact's lifecycle stage changed to Lead. Set automatically.
Became a Marketing Qualified Lead Date	Datetime	True		True	Date when the contact's lifecycle stage changed to Marketing Qualified Lead (MQL). Set automatically.
Became an Opportunity Date	Datetime	True		True	Date when the contact's lifecycle stage changed to Opportunity. Set automatically.
Lifecycle Stage	String	False		True	The contact's current lifecycle stage, such as Subscriber, Lead, Customer, or Evangelist.
Became a Sales Qualified Lead Date	Datetime	True		True	Date when the contact's lifecycle stage changed to Sales Qualified Lead (SQL). Set automatically.
Create Date	Datetime	True		True	Date when the contact record was originally created in HubSpot.
Became an Evangelist Date	Datetime	True		True	Date when the contact's lifecycle stage changed to Evangelist. Set automatically.
Became a Customer Date	Datetime	True		True	Date when the contact's lifecycle stage changed to Customer. Set automatically.
HubSpot Score	Decimal	True		True	A numerical lead score reflecting the contact's qualification based on behavior and profile properties.
Company Name	String	False		True	The name of the company associated with the contact. Can differ from the associated company's name in HubSpot.
Became a Subscriber Date	Datetime	True		True	Date when the contact's lifecycle stage changed to Subscriber. Set automatically.
Became an Other Lifecycle Date	Datetime	True		True	Date when the contact's lifecycle stage changed to 'Other'. Set automatically.
Website URL	String	False		True	Website URL of the contact's associated company.
Number of Employees	String	False		True	The number of employees at the contact's associated company.
Annual Revenue	String	False		True	Annual revenue of the contact's associated company.
Industry	String	False		True	Industry classification of the contact's associated company.
Primary Associated Company ID	Decimal	False		True	Unique HubSpot ID of the primary company associated with the contact.
Associated Company Last Updated	Decimal	True		True	Internal field used to trigger updates when company information changes.
Lead Rating	String	True		True	Categorical lead rating assigned based on predictive scoring models, such as Hot, Warm, or Cold.
Predictive Lead Score	Decimal	True		True	A predictive score indicating the likelihood of the contact becoming a customer based on HubSpot's machine learning models.

ContactsToDealsAssociations

Lists deal IDs associated with specific contacts, useful for managing contact-deal relationships.

View Specific Information

This is a sample associations table exposed when the ExpandAssociations connection property is set to True.

SELECT

A query to this table will return will return all the Id pairs of the associated records from the two object types, Contacts and Deals.

SELECT * FROM ContactsToDealsAssociations

Note: You cannot reference custom objects by base name. When querying ContactToDealsAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

INSERT

To add a new association between a Contacts record and a Deals one, you simply need to specify the Id-s of the two records to be associated.

INSERT INTO ContactsToDealsAssociations (ContactsId, DealsId) VALUES ('3432', '34654')

Columns


Name	Type	ReadOnly	References	Filterable	Description
ContactsId [KEY]	Long	False	Contacts.Id	False	Unique identifier for the contact involved in the association.
DealsId [KEY]	Long	False	Deals.Id	False	Unique identifier for the deal associated with the contact.
Type	String	False		False	Specifies the type of association between the contact and the deal, such as primary, secondary, or custom.

CourseAssociations

Retrieve the IDs of all the objects associated to specific Courses objects in HubSpot.

View Specific Information

CourseAssociations retrieves the IDs of all objects associated with specific course records in HubSpot. This table shows the relationships between courses and other HubSpot objects such as contacts, companies, deals, and tickets.

SELECT

When selecting course associations, you must specify the course ID to retrieve its associated objects. For example:

SELECT * FROM CourseAssociations WHERE Id = '67890'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Courses.Id	False	Courses ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Courses object is associated with.
Type [KEY]	String	False		False	Type of the associated object, which can be a contact, deal etc.

CoursePipelines

Pipelines of Courses in HubSpot.

View Specific Information

CoursePipelines contains the pipeline configurations for course records in HubSpot. Each pipeline represents a series of stages that courses can progress through.

SELECT

SELECT * FROM CoursePipelines WHERE Id = 'course-pipeline-id'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	False		False	The unique identified of the pipeline.
Label	String	False		False	The label (name) of the pipeline.
Archived	Bool	True		False	Whether the pipeline is archived or not.
CreatedAt	Datetime	True		False	When the pipeline was created.
UpdatedAt	Datetime	True		False	When the pipeline was last updated.
DisplayOrder	Int	False		False	The order of this specific pipeline in the collection of pipelines for this table.
StagesAggregate	String	False		False	An aggregate of the stages included in this pipeline. This information can be viewed in more detail in TicketPipelineStages table.

CoursePipelineStages

PipelineStages of Courses in HubSpot.

View Specific Information

CoursePipelineStages contains the individual stages within course pipelines in HubSpot. Each stage represents a specific step in the course workflow process.

SELECT

SELECT * FROM CoursePipelineStages WHERE PipelineId = 'course-pipeline-id'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier of the stage in this pipeline.
PipelineId [KEY]	String	False	TicketPipelines.Id	False	Unique identifier of the pipeline.
Label	String	False		False	Label (name) of the pipeline stage.
PipelineLabel	String	True	TicketPipelines.Label	False	The label (name) of the pipeline.
IsClosed	Bool	False		False	Whether this stage is open or closed.
State	String	False		False	Current state of the pipeline stage.
Archived	Bool	True		False	Whether the stage is archived or not.
CreatedAt	Datetime	True		False	Time the stage was created.
UpdatedAt	Datetime	True		False	Time the stage was last updated.
DisplayOrder	Int	False		False	The order of the stage in the collection of stages for this pipeline.

Courses

Retrieve the available Courses in HubSpot.

Table Specific Information

In HubSpot, courses represent educational or training programs that can be tracked and managed. Course records support organizing educational content and tracking participant engagement.

SELECT

When selecting courses, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Courses WHERE [Course Name] = 'Advanced Marketing' AND [Enrollment Capacity] > 50
SELECT * FROM Courses WHERE [Pipeline] = 'Course Pipeline' OR [Course ID] = 'course-123'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Courses WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Courses WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Courses WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Courses WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO Courses ([Course Name], [Course Description], [Enrollment Capacity]) VALUES ('Digital Marketing 101', 'Introduction to digital marketing concepts', 25)

UPDATE

UPDATE Courses SET [Course Description] = 'Updated course description' WHERE ID = '67890'

DELETE

DELETE FROM Courses WHERE ID = '67890'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Course Description	String	False		True	Brief explanation of what the course covers.
Course ID	String	False		True	Unique ID for the course record.
Course Name	String	False		True	Title or name of the course.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Date entered 'Closed Stage (Course Pipeline)'	Datetime	True		True	The date and time when the Course entered the 'Closed Stage' stage, 'Course Pipeline' pipeline.
Date entered 'Open Stage (Course Pipeline)'	Datetime	True		True	The date and time when the Course entered the 'Open Stage' stage, 'Course Pipeline' pipeline.
Date exited 'Closed Stage (Course Pipeline)'	Datetime	True		True	The date and time when the Course exited the 'Closed Stage' stage, 'Course Pipeline' pipeline.
Date exited 'Open Stage (Course Pipeline)'	Datetime	True		True	The date and time when the Course exited the 'Open Stage' stage, 'Course Pipeline' pipeline.
Enrollment Capacity	Decimal	False		True	Maximum number of participants allowed.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Owning Teams	String	False		False	The teams that are attributed to this record.
Pipeline	String	False		False	The pipeline that contains this course.
Pipeline Stage	String	False		False	The pipeline stage that contains this course.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	False		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	False		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Time in 'Closed Stage (Course Pipeline)'	Decimal	True		True	The total time in seconds spent by the Course in the 'Closed Stage' stage, 'Course Pipeline' pipeline.
Time in 'Open Stage (Course Pipeline)'	Decimal	True		True	The total time in seconds spent by the Course in the 'Open Stage' stage, 'Course Pipeline' pipeline.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	Object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

CustomObjectAssociations

Manages associations between custom object types in HubSpot, facilitating complex object relationships.

View Specific Information

Note: Insert and Delete operations may not work for the OAuth Authentication scheme because of insufficient OAuth Apps scopes. Use the Private App Token authentication instead.

SELECT

A query to this table will return all the available associations for each custom object type.

SELECT * FROM CustomObjectAssociations

Note: You cannot reference custom objects by base name. When querying CustomObjectAssociations, if FromObjectTypeId or ToObjectTypeId refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

INSERT

To add a new association between a custom object type and another object type (custom or standard object type), the user must specify at least the ObjectFullyQualifiedName for the source custom object and the Object Type Id-s of the two objects to be associated, ToObjectTypeId and FromObjectTypeId.

INSERT INTO [CustomObjectAssociations] (ObjectFullyQualifiedName, Name, FromObjectTypeId, ToObjectTypeId, Cardinality, InverseCardinality) 
VALUES ('p5692228_MachinesObject', 'machine_to_contactAssoc', '2-1128325', 'contact', 'ONE_TO_MANY', 'ONE_TO_MANY')

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for this specific custom object association.
ObjectFullyQualifiedName [KEY]	String	False		False	Fully qualified name of the object type, combining meta type and unique ID (formatted as _meta_type__uniqueID_).
ObjectTypeId	String	True		False	Unique identifier of the custom object type involved in the association.
ObjectId	String	True		False	Unique ID assigned to the object instance, typically including the portal ID and object name.
ObjectName	String	True		False	Unique name assigned to the schema's object type for identification purposes.
ObjectLabelSingular	String	True		False	Singular display label for the object type, used throughout the CRM interface.
ObjectLabelPlural	String	True		False	Plural display label for the object type, used throughout the CRM interface.
Name	String	False		False	Unique name identifying this specific association between custom objects.
Cardinality	String	False		False	Defines the cardinality of the association, such as one-to-one or one-to-many.
InverseCardinality	String	False		False	Defines the inverse cardinality type, describing how the association appears from the target object's perspective.
FromObjectTypeId	String	False		False	ID of the primary (source) object type from which the association originates.
ToObjectTypeId	String	False		False	ID of the target object type to which the association points.

DealAssociations

Returns object IDs associated with specific deals, supporting the management of deal associations.

Table Specific Information

Select

Note: You cannot reference custom objects by base name. When querying DealAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	Deals.Id	False	Unique identifier for the deal involved in the association.
AssociationId [KEY]	Long	False		False	Unique identifier of the HubSpot object (such as a contact, company, or ticket) associated with the deal.
Type [KEY]	String	False		True	Type of the associated HubSpot object (such as contact, company, or ticket) linked to the deal.

DealPipelines

Provides pipelines associated with deals, used to visualize and manage sales stages.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for the deal pipeline.
Label	String	False		False	Display label or name assigned to the deal pipeline.
Archived	Bool	True		False	Indicates whether the pipeline is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp marking when the pipeline was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the pipeline.
DisplayOrder	Int	False		False	Numeric value determining the display sequence of this pipeline relative to others in the same table.
StagesAggregate	String	False		False	Serialized list of all stages included in this pipeline. Detailed stage information is available in the DealPipelineStages table.

DealPipelineStages

Lists stages within deal pipelines to track deal progress through different phases.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for the individual stage within the deal pipeline.
PipelineId [KEY]	String	False	DealPipelines.Id	False	Unique identifier of the deal pipeline to which this stage belongs.
Label	String	False		False	Display label or name assigned to the pipeline stage.
PipelineLabel	String	True	DealPipelines.Label	False	Label or name of the pipeline that includes this stage.
IsClosed	Bool	False		False	Indicates whether this stage represents a closed state (such as won or lost) or remains open.
Probability	Decimal	False		False	Probability percentage associated with successfully closing a deal in this stage.
Archived	Bool	True		False	Indicates whether this pipeline stage is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp marking when the pipeline stage was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the pipeline stage.
DisplayOrder	Int	False		False	Numeric value determining the display sequence of this stage within the pipeline.

DealProperties

Retrieves all available deal property fields in HubSpot, both standard and custom properties.

Table Specific Information

SELECT

SELECT * FROM DealProperties

INSERT

To create a new DealProperties record, the type, fieldType, and groupName fields are required. For example:

INSERT INTO DealProperties (Name, Label, type, fieldType, groupName) VALUES ('test','test', 'string', 'text', 'deal_revenue')

UPDATE

UPDATE DealProperties Set Label='TestProperty11' WHERE  Name = 'testproperty'

DELETE

DELETE FROM DealProperties WHERE Name='test'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the deal property, consisting of lowercase letters and numbers, starting with a letter. Serves as the unique identifier.
Label	String	False		False	User-friendly label displayed in the HubSpot UI to represent the deal property.
FieldType	String	False		False	Defines the input field type (such as text, dropdown, or checkbox) for this property as displayed in the UI.
Type	String	False		False	Underlying machine data type (such as string, number, or date) used to store the property's value.
GroupName	String	False		False	Identifies the property group this deal property belongs to for organizational display.
Description	String	False		False	Detailed explanation of the property's purpose and how it is used in deal records.
DisplayOrder	Int	False		False	Numeric value determining the order this property appears relative to others within its group.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are sourced externally.
IsFormField	Bool	False		False	Specifies whether this property appears as an editable field within HubSpot forms.
IsCalculated	Bool	False		False	Indicates whether the property's value is automatically calculated based on other properties or data.
IsHidden	Bool	False		False	Determines whether the property is hidden from standard views in the HubSpot interface.
IsHubspotDefined	Bool	False		False	True if the property is predefined by HubSpot, false if it was custom-created.
Archivable	Bool	False		False	Indicates whether this property can be archived and removed from active use.
ReadOnlyDefinition	Bool	False		False	Specifies whether the property's definition (such as type or label) is locked and cannot be modified.
ReadOnlyValue	Bool	False		False	Specifies whether the property's value is read-only and not editable by users.
OptionsAggregate	String	False		False	Serialized list of selectable options for the property, relevant when FieldType supports multiple-choice fields (such as radio buttons or checkboxes).
HasUniqueValue	Bool	False		False	Indicates whether each deal's value for this property must be unique across all records.

DealPropertyGroups

Provides access to groups used to organize deal properties logically.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name used to identify the deal property group.
Label	String	False		False	Display label for the property group, shown in the HubSpot UI.
DisplayOrder	Int	False		False	Numeric value determining the display sequence of this property group relative to others.

Deals

Retrieves all deals from HubSpot, supporting both OAuth and private-app token authentication methods.

Table Specific Information

A deal represents an ongoing transaction that a sales team is pursuing with a contact or company. It is tracked through pipeline stages until won or lost.

SELECT

When selecting deals, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Deals WHERE [Amount] > 100 AND [Close Date] > '2020-01-01'
SELECT * FROM Deals WHERE [Deal Name] = 'John' OR [Deal Name] = 'William'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Deals WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Deals WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Deals WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Deals WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO Deals (Currency) VALUES ('USD')

UPDATE

UPDATE Deals SET Currency = 'EUR' WHERE ID = '471395623'

DELETE

DELETE FROM Deals WHERE ID = '471395623'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier for the deal object.
Archived	Bool	True		False	Indicates whether the deal is archived and no longer actively managed.
CreatedAt	Datetime	True		False	Timestamp when the deal was initially created in HubSpot.
UpdatedAt	Datetime	True		False	Timestamp when the deal was most recently updated.
ItemURL	String	True		False	Direct URL linking to the detailed view of this specific deal record in HubSpot.
Amount in company currency	Decimal	True		True	Total value of the deal converted into your company's primary currency using the applicable exchange rate.
Days to close	Decimal	True		True	Number of days between the deal's creation and the date it was closed.
Currency	String	False		True	Currency code representing the currency used for the deal amount, such as USD or EUR.
Annual contract value	Decimal	True		True	Annual Contract Value (ACV) for the deal, representing expected recurring yearly revenue.
Business units	String	False		True	Business units assigned to the deal for organizational segmentation.
Deal Collaborator	String	True		True	IDs of HubSpot users who collaborated on managing or closing the deal.
Deal Split Users	String	True		True	IDs of users sharing revenue or credit for the deal through a revenue split.
Latest Source	String	True		True	Most recent session source tied to a contact directly or indirectly associated with the deal.
Latest Source Company	String	True		True	Most recent session source tied to a company associated with the deal.
Latest Source Contact	String	True		True	Most recent session source tied to a directly associated contact.
Latest Source Data 1	String	True		True	Additional detail about the most recent session source from a contact or company linked to the deal.
Latest Source Data 1 Company	String	True		True	Additional detail about the most recent session source for a company indirectly associated with the deal.
Latest Source Data 1 Contact	String	True		True	Additional detail about the most recent session source for a contact directly associated with the deal.
Latest Source Data 2	String	True		True	Secondary additional source information related to the latest session tied to the deal.
Latest Source Data 2 Company	String	True		True	Secondary additional source information from a company associated with the deal's latest session.
Latest Source Data 2 Contact	String	True		True	Secondary additional source information from a contact directly linked to the deal's latest session.
Latest Source Timestamp	Datetime	True		True	Timestamp of the latest recorded session activity for a contact associated with the deal.
Latest Source Timestamp Company	Datetime	True		True	Timestamp of the latest recorded session activity for a company associated with the deal.
Latest Source Timestamp Contact	Datetime	True		True	Timestamp of the latest recorded session activity for a contact directly tied to the deal.
Original Source Type	String	False		True	The original source category, such as Organic Search or Paid Social, associated with the earliest contact activity tied to the deal.
Original Source Data 1	String	True		True	Additional details about the original source for the associated contact or company.
Original Source Data 2	String	True		True	Further supplemental details about the original source for the contact or company linked to the deal.
Annual recurring revenue	Decimal	True		True	Annual Recurring Revenue (ARR) generated by the deal, if applicable.
HubSpot Campaign	String	False		True	Marketing campaign ID or name associated with the deal, if sourced from campaign activity.
Closed Deal Amount	Decimal	True		True	Final monetary amount recorded when the deal was marked as closed.
Closed Deal Amount In Home Currency	Decimal	True		True	Closed deal amount converted into the company's primary currency for reporting consistency.
Created by user ID	Decimal	True		True	ID of the user who originally created the deal. Automatically set by HubSpot.
Date entered Appointment Scheduled (Sales Pipeline)	Datetime	True		True	Date and time when the deal entered the 'Appointment Scheduled' stage within the Sales Pipeline.
Date entered Closed Lost (Sales Pipeline)	Datetime	True		True	Date and time when the deal entered the 'Closed Lost' stage within the Sales Pipeline.
Date entered Closed Won (Sales Pipeline)	Datetime	True		True	Date and time when the deal entered the 'Closed Won' stage within the Sales Pipeline.
Date entered Contract Sent (Sales Pipeline)	Datetime	True		True	Date and time when the deal entered the 'Contract Sent' stage within the Sales Pipeline.
Date entered Decision Maker BoughtIn (Sales Pipeline)	Datetime	True		True	Date and time when the deal entered the 'Decision Maker Bought-In' stage within the Sales Pipeline.
Date entered Presentation Scheduled (Sales Pipeline)	Datetime	True		True	Date and time when the deal entered the 'Presentation Scheduled' stage within the Sales Pipeline.
Date entered Qualified To Buy (Sales Pipeline)	Datetime	True		True	Date and time when the deal entered the 'Qualified To Buy' stage within the Sales Pipeline.
Date exited Appointment Scheduled (Sales Pipeline)	Datetime	True		True	Date and time when the deal exited the 'Appointment Scheduled' stage within the Sales Pipeline.
Date exited Closed Lost (Sales Pipeline)	Datetime	True		True	Date and time when the deal exited the 'Closed Lost' stage within the Sales Pipeline.
Date exited Closed Won (Sales Pipeline)	Datetime	True		True	Date and time when the deal exited the 'Closed Won' stage within the Sales Pipeline.
Date exited Contract Sent (Sales Pipeline)	Datetime	True		True	Date and time when the deal exited the 'Contract Sent' stage within the Sales Pipeline.
Date exited Decision Maker BoughtIn (Sales Pipeline)	Datetime	True		True	Date and time when the deal exited the 'Decision Maker Bought-In' stage within the Sales Pipeline.
Date exited Presentation Scheduled (Sales Pipeline)	Datetime	True		True	Date and time when the deal exited the 'Presentation Scheduled' stage within the Sales Pipeline.
Date exited Qualified To Buy (Sales Pipeline)	Datetime	True		True	Date and time when the deal exited the 'Qualified To Buy' stage within the Sales Pipeline.
Deal amount calculation preference	String	False		True	Specifies how the deal amount is determined based on associated line items or manual input.
Deal probability	Decimal	False		True	Probability percentage representing the likelihood that the deal will close. Defaults to the probability tied to the deal's stage.
Deal stage probability shadow	Decimal	True		True	Backup probability percentage used when the main deal probability is not set. Defaults to 0 if unavailable.
Exchange rate	Decimal	True		True	Exchange rate used to convert the deal's amount into your company's home currency.
Forecast amount	Decimal	True		True	Forecasted value calculated by multiplying the deal amount in company currency by the forecast probability.
Forecast probability	Decimal	False		True	Custom probability percentage assigned to forecast the deal's likelihood of closing.
Is Deal Closed_	Bool	True		True	Indicates whether the deal has been marked as closed, either won or lost.
Is Closed Won	Bool	True		True	Indicates whether the deal has been closed and marked as won.
Deal Split Added	Bool	True		True	Indicates whether revenue sharing (split) has been added to the deal among multiple users.
Last Modified Date	Datetime	True		True	Timestamp of the most recent update to any property on the deal, automatically set by HubSpot.
Likelihood to close by the close date	Decimal	True		True	Predicted probability, between 0 and 1, that the deal will close by its close date.
Global Term Line Item Discount Percentage	String	False		True	Internal value for applying a global discount percentage across line items in the deal.
Global Term Line Item Discount Percentage Enabled	Bool	False		True	Indicates whether a global discount percentage has been enabled for the deal's line items.
Global Term Line Item Recurring Billing Period	String	False		True	Internal value representing the recurring billing period for line items in the deal.
Global Term Line Item Recurring Billing Period Enabled	Bool	False		True	Indicates whether a global recurring billing period is enabled for the deal's line items.
Global Term Line Item Recurring Billing Start Date	String	False		True	Internal value representing the start date for recurring billing of line items in the deal.
Global Term Line Item Recurring Billing Start Date Enabled	Bool	False		True	Indicates whether the global recurring billing start date is enabled for the deal's line items.
Global Term Line Item Recurring Billing Frequency	String	False		True	Internal value specifying the recurring billing frequency for the deal's line items.
Global Term Line Item Recurring Billing Frequency Enabled	Bool	False		True	Indicates whether recurring billing frequency is globally enabled for the deal's line items.
Forecast category	String	False		True	Sales forecast category manually assigned to the deal, such as Best Case, Commit, or Closed Won.
Merged object IDs	String	True		True	List of object IDs that have been merged into this deal record. Set automatically by HubSpot.
Monthly recurring revenue	Decimal	True		True	Monthly Recurring Revenue (MRR) expected from the deal, based on recurring line items.
Next step	String	False		True	Description of the next planned action or activity for advancing the deal.
Number of Active Deal Registrations	Decimal	True		True	Count of currently active deal registrations linked to this deal. Automatically managed by HubSpot.
Number of Deal Registrations	Decimal	True		True	Total number of deal registrations associated with this deal. Automatically set by HubSpot.
Number of Deal Splits	Decimal	True		True	Number of revenue splits assigned to the deal, distributing deal value across multiple users.
Number of target accounts	Decimal	True		True	Number of target account companies associated with this deal. Set automatically by HubSpot.
Record ID	Decimal	True		True	Unique identifier for the deal record, assigned automatically by HubSpot.
Pinned Engagement ID	Decimal	True		True	ID of the engagement (such as a call or meeting) pinned to the top of the deal timeline. Managed automatically.
The predicted deal amount	Decimal	True		True	Expected revenue for the deal calculated by multiplying the deal amount by its likelihood to close by the close date.
The predicted deal amount in your company's currency	Decimal	True		True	Expected revenue in the company's primary currency, factoring in the predicted likelihood to close.
Priority	String	False		True	Priority classification assigned to the deal, used to indicate urgency or strategic importance.
Weighted amount	Decimal	True		True	Deal amount multiplied by the current probability to estimate likely revenue.
Weighted amount in company currency	Decimal	True		True	Weighted amount converted into the company's primary currency based on exchange rate.
Read Only Object	Bool	True		True	Indicates whether the deal is read-only and cannot be edited by users.
Total contract value	Decimal	True		True	Total Contract Value (TCV) representing the complete revenue expected from the deal over its full contract term.
Time in Appointment Scheduled (Sales Pipeline)	Decimal	True		True	Total time in seconds the deal spent in the 'Appointment Scheduled' stage within the Sales Pipeline.
Time in Closed Lost (Sales Pipeline)	Decimal	True		True	Total time in seconds the deal spent in the 'Closed Lost' stage within the Sales Pipeline.
Time in Closed Won (Sales Pipeline)	Decimal	True		True	Total time in seconds the deal spent in the 'Closed Won' stage within the Sales Pipeline.
Time in Contract Sent (Sales Pipeline)	Decimal	True		True	Total time in seconds the deal spent in the 'Contract Sent' stage within the Sales Pipeline.
Time in Decision Maker BoughtIn (Sales Pipeline)	Decimal	True		True	Total time in seconds the deal spent in the 'Decision Maker Bought-In' stage within the Sales Pipeline.
Time in Presentation Scheduled (Sales Pipeline)	Decimal	True		True	Total time in seconds the deal spent in the 'Presentation Scheduled' stage within the Sales Pipeline.
Time in Qualified To Buy (Sales Pipeline)	Decimal	True		True	Total time in seconds the deal spent in the 'Qualified To Buy' stage within the Sales Pipeline.
Unique creation key	String	True		True	Unique key assigned to ensure idempotent creation of the deal and avoid duplicate records.
Updated by user ID	Decimal	True		True	ID of the user who last made an update to the deal record. Set automatically by HubSpot.
User IDs of all notification followers	String	True		True	List of user IDs who subscribed to receive notifications when updates occur on the deal.
User IDs of all notification unfollowers	String	True		True	List of user IDs who unsubscribed from receiving notifications about the deal.
User IDs of all owners	String	True		True	List of user IDs assigned as owners of the deal, including default and additional owners.
Owner Assigned Date	Datetime	True		True	Date and time when the current owner was assigned to the deal. Updated automatically by HubSpot.
Deal Name	String	False		True	The name or title assigned to the deal to describe it in HubSpot.
Amount	Decimal	False		True	The current monetary value assigned to the deal.
Deal Stage	String	False		True	The current sales stage of the deal, reflecting its position in the pipeline.
Pipeline	String	False		True	The sales pipeline to which the deal belongs, which defines available sales stages.
Close Date	Datetime	False		True	Expected or actual date when the deal is anticipated to close or was closed.
Create Date	Datetime	False		True	Date when the deal was created in HubSpot. Automatically recorded.
Date of last meeting booked in meetings tool	Datetime	True		True	Date of the most recent meeting booked through HubSpot's meetings tool related to a contact associated with the deal.
Campaign of last booking in meetings tool	String	True		True	UTM campaign parameter associated with the last meeting booking for a contact linked to the deal.
Medium of last booking in meetings tool	String	True		True	UTM medium parameter (such as email or social media) that referred the associated contact to book their most recent meeting.
Source of last booking in meetings tool	String	True		True	UTM source parameter (such as LinkedIn or Twitter) that referred the associated contact to book their most recent meeting.
Latest meeting activity	Datetime	True		True	Timestamp of the most recent meeting logged, booked, or scheduled with a contact linked to the deal.
Recent Sales Email Replied Date	Datetime	True		True	Date when a reply was received to the most recent tracked sales email related to the deal.
Deal owner	String	False		True	Primary user or sales representative assigned ownership of the deal.
Last Contacted	Datetime	True		True	Timestamp when the last call, one-to-one sales email, or meeting was logged for this deal.
Last Activity Date	Datetime	True		True	Timestamp when the most recent activity (such as call, email, meeting, or note) was logged for the deal.
Next Activity Date	Datetime	True		True	Scheduled date of the next planned activity related to the deal, such as a follow-up call or meeting.
Number of times contacted	Decimal	True		True	Total number of sales communications (calls, emails, or meetings) logged for the deal.
Number of Sales Activities	Decimal	True		True	Total number of sales activities associated with the deal, such as calls or meetings.
HubSpot Create Date	Datetime	True		True	Date the deal record was first created inside HubSpot.
HubSpot Team	String	True		True	Team assignment of the primary owner of the deal within HubSpot.
Deal Type	String	False		True	Classification of the deal, such as New Business or Existing Business.
All owner ids	String	True		True	List of all ownership property IDs associated with this deal, both default and custom.
Deal Description	String	False		True	Descriptive notes or summary providing context about the deal's purpose, history, or details.
All team ids	String	True		True	IDs of all HubSpot teams assigned to the deal, including teams linked through custom properties.
All accessible team ids	String	True		True	List of all team IDs, including inherited ones, that have access permissions related to the deal.
Number of Associated Contacts	Decimal	True		True	Total number of contact records linked to this deal. Set automatically by HubSpot.
Closed Lost Reason	String	False		True	Stated reason why the deal was closed as lost, used for sales reporting and coaching insights.
Closed Won Reason	String	False		True	Stated reason why the deal was successfully closed as won, used for analysis of winning factors.

EmailAssociations

Lists object IDs associated with specific email records, enabling email engagement tracking.

Table Specific Information

Select

Note: You cannot reference custom objects by base name. When querying EmailAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		False	Unique identifier for the email engagement record.
AssociationId [KEY]	Long	False		False	ID of the HubSpot object associated with this email, such as a contact, company, or deal.
Type [KEY]	String	False		True	Specifies the type of object associated with the email, such as contact, deal, company, or ticket.

EmailProperties

Retrieves property fields associated with email records in HubSpot, used for email data management.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the email property, used in API calls and system logic. Must start with a lowercase letter and contain only lowercase alphanumeric characters.
Label	String	False		False	User-friendly label for the email property, displayed in the HubSpot UI.
FieldType	String	False		False	UI field type for this property, such as text, checkbox, or dropdown, used to render the input field in HubSpot.
Type	String	False		False	Underlying data type used to store the property value, such as string, number, or boolean.
GroupName	String	False		False	Name of the property group to which this email property belongs, used for UI organization.
Description	String	False		False	Explanation of the property's purpose or intended use within the context of email objects.
DisplayOrder	Int	False		False	Position of the property relative to others in the same group, with lower numbers shown first.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are managed externally rather than within the property configuration.
IsFormField	Bool	False		False	True if the property can be used as a field within HubSpot forms; false otherwise.
IsCalculated	Bool	False		False	True if the value of this property is automatically calculated based on other data or system rules.
IsHidden	Bool	False		False	Specifies whether the property is hidden from standard views in the HubSpot interface.
IsHubspotDefined	Bool	False		False	True if this is a default property provided by HubSpot; false if it is a custom property.
Archivable	Bool	False		False	Indicates whether the property can be archived and excluded from active use.
ReadOnlyDefinition	Bool	False		False	True if the property's definition (such as label or type) is locked and cannot be modified.
ReadOnlyValue	Bool	False		False	True if the property's value is not editable by users or workflows.
OptionsAggregate	String	False		False	Serialized list of predefined options for properties that support multiple choices. Has a value if the FieldType is radio, checkbox, or boolean checkbox.
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

EngagementsCalls

Retrieves all call engagement records in HubSpot, useful for tracking customer communication.

SELECT

When selecting Call Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM EngagementsCalls WHERE ID = '11896247257'

INSERT

INSERT INTO EngagementsCalls ([Call Title], [Call notes], [Call duration], [From Number], [To Number], [Recording URL], [Call status], [Activity date])
VALUES ('CallEngagement Title', 'CallEngagement Body', '60', '123-456-7890', '789-123-4560', 'https://www.cdata.com', 'CALLING_CRM_USER', current_timestamp() )

UPDATE

UPDATE EngagementsCalls SET [Call status] = 'COMPLETED' WHERE ID = '11896247257'

DELETE

DELETE FROM EngagementsCalls WHERE ID = '11896247257'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier for the call engagement object.
Archived	Bool	True		False	Indicates whether the call engagement has been archived.
CreatedAt	Datetime	True		False	Timestamp when the call engagement was originally created.
UpdatedAt	Datetime	True		False	Timestamp when the call engagement was most recently updated.
Call and meeting type	String	False		True	Type of activity, such as a call or meeting, associated with the engagement.
Business units	String	False		True	Business units this call engagement is associated with.
AtMentioned Owner Ids	String	False		True	User IDs of owners who were mentioned in the call notes.
Attached file IDs	String	False		True	Identifiers of files attached to the call engagement.
Call notes preview	String	True		True	A shortened preview of the call notes content.
HTML Body Preview	String	True		True	HTML-formatted version of the call notes preview.
Body Preview Truncated	Bool	True		True	Indicates whether the call notes preview was truncated due to length.
Integrating App ID	Decimal	False		True	Unique ID of the third-party app that integrated or logged the call.
Authenticated recording files url provider	String	True		True	Endpoint that returns a secure URL to access the call's audio or video recording.
Call notes	String	False		True	Full written notes or transcription of the call content.
Callee object id	Decimal	False		True	Identifier of the object (such as a contact) who received the call.
Callee object type	String	False		True	Type of the object that received the call, such as contact or company.
Call direction	String	False		True	Direction of the call—whether it was inbound or outbound.
Call outcome	String	False		True	Result or outcome of the call, such as completed, no answer, or left voicemail.
Call duration	Decimal	False		True	Length of the call in milliseconds.
External Account ID	String	False		True	ID of the external system account related to the call, if applicable.
External ID	String	False		True	Unique ID from an external system referencing this call engagement.
From Number	String	False		True	Phone number used to initiate the call.
From Number Name	String	True		True	Label or contact name associated with the originating phone number.
Transcript Available	Bool	False		True	Indicates whether a transcript is available for this call.
Voicemail Available	String	True		True	Specifies whether a voicemail recording exists for this call.
Recording URL	String	False		True	Direct URL to the call's recorded audio file, if available.
Call Source	String	False		True	Platform or technology used to make the call, such as VoIP or video conferencing.
Call status	String	False		True	Current status of the call engagement, such as completed or in progress.
Call Title	String	False		True	Title or subject line associated with the call.
To Number	String	False		True	Phone number that was dialed for the call.
To Number Name	String	True		True	Name or label linked to the recipient's phone number.
Tracked terms	String	True		True	List of keywords or phrases tracked within the call transcript.
Call transcription id	Decimal	False		True	Unique ID referencing the transcription data for the call.
Video url	String	False		True	URL to access the video recording of the call, if applicable.
Unique Zoom Meeting ID	String	False		True	Unique identifier for the Zoom meeting if the call was made through Zoom.
Calls Service Call ID	Decimal	True		True	Global unique identifier for the call as assigned by HubSpot's Calls Service.
Activity created by	Decimal	True		True	User ID of the person who originally created the call engagement activity.
Created by user ID	Decimal	True		True	User ID that created this record. This value is set automatically by HubSpot and cannot be modified.
Create date	Datetime	True		True	The date the call engagement was created in the CRM timeline.
Engagement Source	String	False		True	System or integration source that created the call engagement.
Engagement Source ID	String	False		True	Unique identifier of the source process or integration that created the engagement.
Follow up action	String	False		True	Recommended follow-up action related to the call, such as 'Send email' or 'Schedule meeting'.
GDPR deleted	Bool	True		True	Indicates whether the call content was cleared due to a GDPR delete request.
Last modified date	Datetime	True		True	Timestamp of the most recent change made to the call engagement.
Merged object IDs	String	True		True	IDs of records that were merged into this call engagement. Automatically maintained by HubSpot.
Updated by	Decimal	True		True	User ID of the person who last updated the engagement record.
Record ID	Decimal	True		True	HubSpot-assigned unique identifier for the engagement record.
Product name	String	False		True	Name of the product discussed or referenced during the call, if applicable.
Queue Memberships	String	False		True	List of queues in which the call engagement is currently placed.
Read Only Object	Bool	True		True	Indicates whether the record is locked for editing and is read-only.
Activity date	Datetime	False		True	Date and time when the call engagement took place, as recorded in the timeline.
Unique creation key	String	True		True	Unique key used for idempotent creation of the call engagement to avoid duplicates.
Unique ID	String	False		True	Another unique identifier used to reference the engagement, separate from Record ID.
Unknown Visitor Conversation	Bool	False		True	Indicates whether the engagement was made with a visitor whose identity is not known.
Updated by user ID	Decimal	True		True	User ID of the person who most recently updated this engagement. Automatically set by HubSpot.
User IDs of all notification followers	String	True		True	User IDs of individuals who have opted to receive notifications for updates to this engagement.
User IDs of all notification unfollowers	String	True		True	User IDs of owners who have opted out of notifications for this engagement.
User IDs of all owners	String	True		True	User IDs of all owners assigned to this engagement, including default and custom owners.
Owner Assigned Date	Datetime	True		True	Date and time when ownership was last assigned to the engagement. Automatically set by HubSpot.
Activity assigned to	String	False		True	User ID of the person this engagement is currently assigned to. Can be a HubSpot user or a Salesforce integration user.
HubSpot Team	String	True		True	Team associated with the owner of this engagement. Automatically assigned by HubSpot.
All owner ids	String	True		True	List of all owner property IDs linked to the engagement, including custom owners.
All team ids	String	True		True	IDs of all teams associated with the engagement owners, based on ownership properties.
All accessible team ids	String	True		True	IDs of all teams, including those higher in the hierarchy, that have access to this engagement based on owner permissions.

EngagementsEmails

Retrieves all email engagement records in HubSpot, supporting email interaction analysis.

SELECT

When selecting Email Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM EngagementsEmails WHERE ID = '11896047040'

INSERT

INSERT INTO EngagementsEmails ([Activity date], [Email Direction], [Attached Video Opened], [Attached Video Watched], [Email send status], [Email subject], [Email body], [UpdatedAt])
VALUES (CURRENT_TIMESTAMP(), 'EMAIL', TRUE, TRUE, 'BOUNCED', 'subject', 'text', CURRENT_TIMESTAMP() )

UPDATE

UPDATE EngagementsEmails SET [Email body] = 'Updated email body', [Email send status] = 'FAILED' WHERE ID = '11896047040'

DELETE

DELETE FROM EngagementsEmails WHERE ID = '11896047040'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier for the email engagement object.
Archived	Bool	True		False	Indicates whether the email engagement has been archived.
CreatedAt	Datetime	True		False	Timestamp when the email engagement was originally created.
UpdatedAt	Datetime	True		False	Timestamp when the email engagement was most recently updated.
Business units	String	False		True	The business units this email engagement is associated with.
AtMentioned Owner Ids	String	False		True	User IDs of owners who were mentioned in the email body.
Attached file IDs	String	False		True	Identifiers of files attached to the email engagement.
Body preview	String	True		True	A shortened preview of the email body content.
HTML Body Preview	String	True		True	HTML-formatted version of the email body preview.
Body Preview Truncated	Bool	True		True	Indicates whether the email body preview was truncated due to length.
Activity created by	String	True		True	The user who originally created the email engagement.
Created by user ID	Decimal	True		True	User ID that created this record. This value is set automatically by HubSpot and cannot be modified.
Create date	Datetime	True		True	The date the email engagement was created in the CRM timeline.
Email direction and unique ID	String	True		True	Direction of the email (sent or received) along with its unique identifier.
Attached Video	String	False		True	ID of a video file attached to the email, if applicable.
Attached Video Name	String	False		True	Name of the video file that was attached to the email.
Attached Video Opened	Bool	False		True	Indicates whether the attached video was opened by the recipient.
Attached Video Watched	Bool	False		True	Indicates whether the attached video was watched by the recipient.
Email BCC Address	String	True		True	Email addresses of the BCC recipients of the email.
Email BCC First Name	String	True		True	First names of recipients in the BCC field.
Email BCC Last Name	String	True		True	Last names of recipients in the BCC field.
Email BCC	String	True		True	Raw header value representing BCC recipients of the email.
Email Bounce Error Detail Message	String	False		True	Descriptive error message returned when the email bounced.
Email Bounce Error Detail Status Code	Decimal	False		True	Status code returned with the email bounce error.
Email CC Address	String	True		True	Email addresses of the CC recipients of the email.
Email CC First Name	String	True		True	First names of recipients in the CC field.
Email CC Last Name	String	True		True	Last names of recipients in the CC field.
Email CC	String	True		True	Raw header value representing CC recipients of the email.
Email Direction	String	False		True	Direction the email was sent in, such as inbound or outbound.
Encoded Email Associations Request	String	True		True	Encoded string representing the email's association request payload.
Error Message	String	False		True	Message describing any error that occurred during email sending.
Email Send Id	String	True		True	Identifier of the email send event, used when sent through Facsimile.
Email From Address	String	True		True	Email address of the sender.
Email From First Name	String	True		True	First name of the sender.
Email From Last Name	String	True		True	Last name of the sender.
Email From	String	True		True	Raw header value representing the sender of the email.
Email Headers	String	False		True	Raw header metadata including sender and recipient details.
Email body	String	False		True	The content of the email message sent from a HubSpot record. Does not include replies from recipients.
Logged From	String	False		True	Indicates the source from which the email was logged, such as Gmail, Outlook, or HubSpot CRM.
Media Processing Status	String	False		True	Current processing status of media files, such as images or attachments, included in the email.
Email is member of forwarded subthread	Bool	False		True	Indicates whether the email is part of a forwarded subthread in a conversation.
Message ID	String	False		True	Unique message identifier for the email, used for threading and tracking.
EmailMigratedViaPortalDataMigration	String	False		True	Shows whether the email was migrated from another portal using HubSpot's DataMigration tool.
Email pending inline image file IDs	String	False		True	IDs of inline image files pending processing within the email body.
PostSend Status	String	False		True	Summary of the final result after the email was sent, such as 'successful send', 'bounced', or 'dropped'.
RecipientDrop Reasons	String	False		True	List of recipients who did not receive the email, along with reasons for dropping.
Email Send Event Id	String	False		True	Unique ID of the email send event used for logging and tracking.
Email Send Event Id Created	Datetime	False		True	Timestamp when the email send event ID was created.
Email Sender Address	String	True		True	Email address of the actual sender of the message.
Email Sender First Name	String	True		True	First name of the email's sender.
Email Sender Last Name	String	True		True	Last name of the email's sender.
Email Sender	String	True		True	Raw header value representing the sender of the email.
Sent Via	String	False		True	Platform or method used to send the email, such as HubSpot, Gmail, or API.
Email send status	String	False		True	Status indicating the delivery result of the email, such as sent, failed, or pending.
Email subject	String	False		True	Subject line of the email, visible to recipients.
Text	String	False		True	Plaintext version of the email body, without HTML formatting.
Thread ID	String	False		True	ID representing the email thread or conversation this email is part of.
Email To Address	String	True		True	Email addresses of the primary recipients.
Email To First Name	String	True		True	First names of the recipients in the To field.
Email To Last Name	String	True		True	Last names of the recipients in the To field.
Email To	String	True		True	Raw header value representing the email's To field.
Tracker Key	String	False		True	Unique key used to track engagement with the email, such as opens and clicks.
Validation Skipped	String	False		True	Details if standard validations were skipped when logging this email.
Engagement Source	String	False		True	System or tool that initiated or logged the email engagement.
Engagement Source ID	String	False		True	Unique identifier of the process or system that created the email engagement.
Follow up action	String	False		True	Recommended follow-up action for the email, such as replying or scheduling a meeting.
GDPR deleted	Bool	True		True	Indicates whether the email body was deleted in response to a GDPR request.
Last modified date	Datetime	True		True	Timestamp of the most recent update to the email engagement record.
Merged object IDs	String	True		True	List of object IDs that were merged into this email engagement. Managed automatically by HubSpot.
Updated by	String	True		True	User who last modified the email engagement.
Record ID	Decimal	True		True	Unique HubSpot-assigned ID for the email engagement record. Automatically generated and unchangeable.
Product name	String	False		True	Name of the product or service referenced or associated with the email engagement.
Queue Memberships	String	False		True	List of queue identifiers where this email engagement is stored or categorized.
Read Only Object	Bool	True		True	Indicates whether the record is read-only and cannot be edited by users or workflows.
Activity date	Datetime	False		True	Date and time when the email activity occurred. Reflects the moment the email was logged or sent.
Unique creation key	String	True		True	A unique identifier used to ensure idempotent email engagement creation and avoid duplicates.
Unique ID	String	False		True	Secondary unique identifier for the email engagement, separate from the primary Record ID.
Updated by user ID	Decimal	True		True	User ID of the last person to update the email engagement. Automatically assigned by HubSpot.
User IDs of all notification followers	String	True		True	List of user IDs that are following this engagement for notification purposes.
User IDs of all notification unfollowers	String	True		True	List of owner user IDs who have opted out of notifications for this engagement.
User IDs of all owners	String	True		True	All owner user IDs associated with this engagement, including default and custom owners.
Owner Assigned Date	Datetime	True		True	Timestamp when an owner was most recently assigned to this email engagement.
Activity assigned to	String	False		True	User ID of the person assigned to this email activity. Can include HubSpot or Salesforce integration users.
HubSpot Team	String	True		True	Team name or ID associated with the primary owner of this email engagement.
All owner ids	String	True		True	All owner-related property values, including default and custom, associated with this engagement.
All team ids	String	True		True	Team IDs corresponding to all assigned owners of this email engagement.
All accessible team ids	String	True		True	Team IDs, including inherited ones from higher in the hierarchy, that have access to this engagement.

EngagementsMeetings

Retrieves all meeting engagement records, used to track meetings scheduled within HubSpot.

SELECT

When selecting Meeting Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM EngagementsMeetings WHERE ID = '11896378834'

INSERT

INSERT INTO EngagementsMeetings ([Activity date], [Meeting name], [Meeting description], [Internal Meeting Notes])
VALUES (current_timestamp(), 'Meeting Engagement Title', 'Meeting Engagement Body', 'Internal Note');

UPDATE

UPDATE EngagementsMeetings SET [Meeting start time] = current_timestamp() WHERE ID = '11896378834'

DELETE

DELETE FROM EngagementsMeetings WHERE ID = '11896378834'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier assigned to the meeting engagement object in HubSpot.
Archived	Bool	True		False	Indicates whether the meeting engagement has been archived and is no longer active.
CreatedAt	Datetime	True		False	Timestamp marking when the meeting engagement was first created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update made to the meeting engagement.
Call and meeting type	String	False		True	Specifies whether the engagement is categorized as a call or a meeting, and its sub-type.
Business units	String	False		True	The business units this meeting is associated with for segmentation and reporting purposes.
AtMentioned Owner Ids	String	False		True	List of HubSpot owner IDs who were mentioned in the meeting body.
Attached file IDs	String	False		True	IDs of files attached to the meeting, such as documents or presentations.
HubSpot attendee owner IDs	String	False		True	User IDs of additional HubSpot owners who attended the meeting.
Body preview	String	True		True	A short preview of the meeting body or notes content, truncated for display purposes.
HTML Body Preview	String	True		True	HTML-formatted version of the meeting preview, including formatting and inline media.
Body Preview Truncated	Bool	True		True	Boolean indicating whether the preview of the meeting body is truncated due to length.
Activity created by	Decimal	True		True	User ID of the person who initially created the meeting engagement.
Created by user ID	Decimal	True		True	HubSpot-assigned user ID of the creator. Automatically set and not user-editable.
Create date	Datetime	True		True	The date and time the meeting engagement was logged or created.
Engagement Source	String	False		True	The source system, integration, or user action that created the meeting record.
Engagement Source ID	String	False		True	Unique identifier of the integration or process that logged the engagement.
Follow up action	String	False		True	Suggested next step to take after the meeting, such as sending a follow-up email.
GDPR deleted	Bool	True		True	Indicates whether the meeting content was cleared due to a GDPR delete request.
iCalUid	String	True		True	The unique iCal identifier associated with the calendar event for this meeting.
Internal Meeting Notes	String	False		True	Internal notes related to the meeting, visible only to users with access. May be empty.
Last modified date	Datetime	True		True	Timestamp of the last property update made to the meeting engagement record.
Meeting description	String	False		True	The full text description or agenda of the meeting, as entered by the organizer.
Meeting calendar event hash	String	False		True	A unique hash used to identify and deduplicate the calendar event across syncs.
Meeting change id	String	False		True	Identifier representing the most recent change to the meeting, used for syncing.
Created From Link ID	String	False		True	ID of the scheduling link (such as HubSpot Meetings tool) used to book this meeting.
Meeting end time	Datetime	False		True	The scheduled end time of the meeting as logged or synced from the calendar event.
External URL	String	False		True	URL pointing to the external calendar or video meeting provider for this engagement.
Meeting location	String	False		True	The physical or virtual location where the meeting took place.
Location type	String	False		True	Classification of the meeting's location, such as in-person, phone, or video conference.
Meeting outcome	String	False		True	The recorded result or status of the meeting, such as 'Completed' or 'No show'.
Payments session id	String	False		True	Identifier linking the meeting to a HubSpot Payments session, if applicable.
PreMeeting prospect reminders	String	False		True	List of dates and times when reminder emails were sent to the prospect prior to the meeting.
Meeting source	String	True		True	Specifies how the meeting was created, such as through a scheduling link or manually logged.
Source ID	String	False		True	ID of the source that generated the meeting, used to trace back to tools or integrations.
Meeting start time	Datetime	False		True	The scheduled start time of the meeting.
Meeting name	String	False		True	The subject or title of the meeting, often pulled from the associated calendar event.
Web conference meeting ID	String	False		True	The unique identifier of the video conferencing event, such as a Zoom or Teams meeting ID.
Merged object IDs	String	True		True	List of object IDs that have been merged into this meeting engagement. Automatically managed by HubSpot.
Updated by	Decimal	True		True	User ID of the person who most recently updated the meeting engagement record.
Record ID	Decimal	True		True	The HubSpot-assigned unique identifier for the meeting record. This value is immutable.
Product name	String	False		True	Name of the product or service discussed or linked with this meeting engagement.
Queue Memberships	String	False		True	Queues this meeting is assigned to, used for task management and automation.
Read Only Object	Bool	True		True	Indicates whether this meeting engagement is read-only and cannot be modified.
Scheduled tasks	String	True		True	Tasks that are scheduled and associated with this meeting. May be empty if no tasks exist.
Activity date	Datetime	False		True	The date and time the meeting activity occurred, used in reporting and automation.
Unique creation key	String	True		True	A unique identifier used to prevent duplicate creation of the same meeting engagement.
Unique ID	String	False		True	A secondary unique identifier for the engagement, used internally for tracking and syncing.
Updated by user ID	Decimal	True		True	The HubSpot-assigned user ID of the user who last updated this engagement record.
User IDs of all notification followers	String	True		True	List of user IDs following this meeting engagement to receive notification updates.
User IDs of all notification unfollowers	String	True		True	List of owner IDs who have opted out of notifications for this engagement.
User IDs of all owners	String	True		True	All user IDs listed as owners of this meeting record, including primary and additional owners.
Owner Assigned Date	Datetime	True		True	Timestamp indicating when ownership was assigned or most recently updated on this record.
Activity assigned to	String	False		True	The HubSpot or Salesforce integration user assigned to this activity. Can be set via workflow or manually.
HubSpot Team	String	True		True	The team assigned to the engagement owner, used for permissions, filtering, and reporting.
All owner ids	String	True		True	All values from owner-referencing properties (default and custom) for this meeting engagement.
All team ids	String	True		True	IDs of the teams directly associated with the owners of this meeting engagement.
All accessible team ids	String	True		True	Full list of accessible team IDs, including parent teams in the hierarchy, that can access this meeting.

EngagementsNotes

Retrieves all note engagement records, helpful for logging internal or customer-related notes.

SELECT

When selecting Note Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM EngagementsNotes WHERE ID = '11896226519'

INSERT

INSERT INTO EngagementsNotes ([Note body], [UpdatedAt], [Activity date]) VALUES ('Body of the note.', current_timestamp(), current_timestamp() )

UPDATE

UPDATE EngagementsNotes SET [Note body] = 'Updated body of the note.' WHERE ID = '11896226519'

DELETE

DELETE FROM EngagementsNotes WHERE ID = '11896226519'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier assigned to the note engagement record in HubSpot.
Archived	Bool	True		False	Indicates whether the note has been archived and is no longer active or visible in the CRM timeline.
CreatedAt	Datetime	True		False	Timestamp of when the note was first created in HubSpot.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update made to the note engagement record.
Business units	String	False		True	Business units associated with this note engagement, useful for segmentation and access control.
AtMentioned Owner Ids	String	False		True	HubSpot owner IDs that were mentioned in the body of the note.
Attached file IDs	String	False		True	IDs of any files that are attached to the note for reference or record-keeping.
Body preview	String	True		True	A shortened preview of the note's content, truncated for display in summaries or lists.
HTML Body Preview	String	True		True	HTML-formatted version of the note body preview, used for display in the UI with formatting.
Body Preview Truncated	Bool	True		True	Boolean indicating whether the previewed note content was cut off due to length.
Activity created by	Decimal	True		True	ID of the user who originally created the note engagement.
Created by user ID	Decimal	True		True	HubSpot user ID of the note's creator. This value is automatically populated and read-only.
Create date	Datetime	True		True	Date and time when the note engagement was created.
Engagement Source	String	False		True	The origin of the engagement, such as CRM UI, API, or an integration.
Engagement Source ID	String	False		True	Unique identifier for the source or process that created the note engagement.
Follow up action	String	False		True	Suggested action to take after this note, such as a call or email follow-up.
GDPR deleted	Bool	True		True	Indicates whether the note content has been erased in response to a GDPR deletion request.
HdTicketIds	String	True		True	All Helpdesk ticketIds associated with the Note.
Last modified date	Datetime	True		True	Timestamp of the latest change to any property on the note engagement.
Merged object IDs	String	True		True	IDs of other note engagements that were merged into this record by HubSpot.
Updated by	Decimal	True		True	ID of the user who most recently edited or updated the note.
Note body	String	False		True	The full content of the note, containing relevant details, context, or observations.
Record ID	Decimal	True		True	Unique ID (generated by HubSpot) for this note engagement. Automatically set and immutable.
Product name	String	False		True	Product or service referenced or associated with this note, if applicable.
Queue Memberships	String	False		True	Names or IDs of queues to which this note engagement is assigned for task or ticket tracking.
Read Only Object	Bool	True		True	Boolean indicating whether this record is read-only and cannot be modified by users.
Activity date	Datetime	False		True	The date and time when the note activity took place or was logged.
Unique creation key	String	True		True	A unique identifier used to ensure idempotent note creation, avoiding duplicates.
Unique ID	String	False		True	Secondary unique identifier for the note engagement, used internally for tracking and syncing.
Updated by user ID	Decimal	True		True	HubSpot user ID of the person who last modified this engagement. Automatically tracked.
User IDs of all notification followers	String	True		True	List of user IDs who have opted to receive notifications when this engagement is updated.
User IDs of all notification unfollowers	String	True		True	Owner user IDs who have opted out of receiving notifications for this note engagement.
User IDs of all owners	String	True		True	List of all owners, both default and custom, associated with this note engagement.
Owner Assigned Date	Datetime	True		True	Timestamp indicating when ownership of this note engagement was assigned or most recently changed.
Activity assigned to	String	False		True	HubSpot or Salesforce integration user assigned to this note. Can be set manually or via automation.
HubSpot Team	String	True		True	Team that owns this note engagement, based on the assigned owner's team.
All owner ids	String	True		True	All values from owner-referencing properties (default and custom) tied to this engagement.
All team ids	String	True		True	Team IDs directly associated with the owners of this note engagement.
All accessible team ids	String	True		True	Full list of team IDs, including inherited ones from team hierarchy, that can access this note.

EngagementsTasks

Retrieves all task engagement records, allowing management of action items related to CRM records.

SELECT

When selecting Task Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM EngagementsTasks WHERE ID = '11896356808'

INSERT

INSERT INTO EngagementsTasks ([Task title], [Task notes], [Task status], [Task type], [Activity date])
VALUES ('Test Task Title', 'Body of the task', 'IN_PROGRESS', 'LINKED_IN_MESSAGE', current_timestamp())

UPDATE

UPDATE EngagementsTasks SET [Task notes] = 'Updated Task body test', [Task status] = 'COMPLETED' WHERE ID = '11896363224'

DELETE

DELETE FROM EngagementsTasks WHERE ID = '11896363224'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier for the task engagement record in HubSpot.
Archived	Bool	True		False	Indicates whether the task is archived and no longer active in workflows or CRM views.
CreatedAt	Datetime	True		False	Timestamp of when the task engagement was first created in HubSpot.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update made to this task engagement.
Business units	String	False		True	Business units associated with the task, used for segmentation and ownership management.
AtMentioned Owner Ids	String	False		True	HubSpot owner IDs that were @mentioned in the body of the task.
Attached file IDs	String	False		True	IDs of files attached to the task, used to provide supporting documents or context.
Notes _preview_	String	True		True	A plain text summary or preview of the notes field on the task.
HTML Body Preview	String	True		True	HTML-formatted version of the task body for rendering in the HubSpot UI.
Body Preview Truncated	Bool	True		True	Indicates whether the task body preview was truncated due to length constraints.
Calendar Event ID	String	True		True	Identifier for the calendar event linked or synced with this task engagement.
Created by	Decimal	True		True	ID of the user who originally created the task engagement.
Created by user ID	Decimal	True		True	HubSpot user ID of the individual who created this task. Automatically set by the system.
Created at	Datetime	True		True	The date and time when the task was created.
Source	String	False		True	The origin of the task creation, such as a CRM action, API call, or external integration.
Source ID	String	False		True	Unique identifier of the system, user, or tool that created this task.
Follow up action	String	False		True	The suggested follow-up action to be taken after this task, such as a call or meeting.
GDPR deleted	Bool	True		True	Indicates whether the task content was removed in compliance with a GDPR deletion request.
Last modified at	Datetime	True		True	The most recent timestamp when any property of the task was updated.
Merged object IDs	String	True		True	A list of engagement object IDs that have been merged into this task. Managed by HubSpot.
Last modified by	Decimal	True		True	User ID of the person who last updated the task engagement.
MS Teams message ID	String	True		True	Identifier for the Microsoft Teams message that resulted in the task being created.
Associated Companies	Decimal	True		True	The number of companies associated with this task for tracking or reporting.
Associated Contacts	Decimal	True		True	The number of contacts linked to this task for context and relationship tracking.
Associated Deals	Decimal	True		True	The number of deals tied to this task engagement.
Associated Queue Objects	Decimal	True		True	Count of all objects associated with this task that support queue-based workflows.
Associated Tickets	Decimal	True		True	The number of support tickets associated with the task for customer service follow-up.
Record ID	Decimal	True		True	System-generated unique ID for this specific task record in HubSpot.
Product name	String	False		True	The product or service referenced in or related to this task, if applicable.
Queue	String	False		True	The name of the queues that this task is a part of. Useful for task assignment and workflow organization.
Read Only Object	Bool	True		True	Indicates whether the task engagement is read-only and cannot be modified.
Task repeat status	String	True		True	Specifies whether the task is set to repeat, and its current repeat state.
Scheduled tasks	String	True		True	Details on any recurring tasks or schedules linked to this task engagement.
Notes	String	False		True	Full content entered in the notes field of the task, often used for reminders or context.
Completed at	Datetime	True		True	Timestamp of when the task was marked as completed.
Contact Time Zone	String	True		True	Time zone of the associated contact, useful for scheduling and reminder purposes.
For Object Type	String	False		True	Specifies the HubSpot object type (such as contact or deal) that this task is associated with.
Task is all day	Bool	False		True	Indicates whether the task is due all day or at a specific time on the due date.
Last contacted	Datetime	True		True	The most recent interaction (email, call, or meeting) logged for the associated contact.
Last engagement	Datetime	True		True	The last time any sales activity was recorded for the associated contact.
Priority	String	False		True	The importance level of the task (such as High, Medium, or Low).
Task probability to complete	Decimal	True		True	Numerical probability that the task will be completed, based on predictive modeling or rules.
Relative Task Reminders	String	False		True	Dates when reminders are triggered relative to the due date, such as one day before.
Reminder	String	False		True	Specific dates or times when the user will receive reminders for the task.
Interval	String	True		True	Frequency for repeating tasks (such as daily, weekly, or monthly).
Send Default Reminder	Bool	False		True	Specifies whether HubSpot should automatically send a reminder when the task is due.
Sequence Enrollment Is Active	Bool	True		True	Indicates whether the sequence enrollment that created the task is still active.
Sequence step enrollment Id	String	True		True	The identifier of the specific step in a sequence that generated this task.
Sequence step number	Decimal	True		True	The position of this task within its enrollment sequence.
Task Status	String	False		True	The current state of the task (such as Not Started, In Progress, or Completed).
Task Title	String	False		True	The subject or headline of the task, often shown in task lists or notifications.
Task template id	Decimal	True		True	Identifier of the template from which this task was created, if any.
Task Type	String	False		True	The type or category of the task (such as Follow-up, Email, or Call).
Due date	Datetime	False		True	Date and time the task is due to be completed.
Unique creation key	String	True		True	A unique string used to ensure idempotent creation of task records via API.
Unique ID	String	False		True	System-generated unique identifier for this specific task engagement.
Updated by user ID	Decimal	True		True	HubSpot user ID of the person who last modified the task.
User IDs of all notification followers	String	True		True	List of user IDs following this task to receive notifications on updates or completions.
User IDs of all notification unfollowers	String	True		True	List of user IDs who opted out of notifications for this task.
User IDs of all owners	String	True		True	User IDs of all owners assigned to this task, including default and custom owner fields.
Owner Assigned Date	Datetime	True		True	Timestamp when ownership of the task was most recently assigned.
Assigned to	String	False		True	HubSpot or Salesforce user assigned to this task. Can be set manually or via automation.
HubSpot Team	String	True		True	The team associated with the current owner of the task. Used for access control and reporting.
All owner ids	String	True		True	All values of properties that reference owners, both default and custom.
All team ids	String	True		True	All team IDs tied to this task's owner properties, for default and custom teams.
All accessible team ids	String	True		True	All team IDs with access to this task, including those inherited from team hierarchy.

FeedbackSubmissionAssociations

Lists object IDs associated with specific feedback submissions, supporting feedback-related associations.

View Specific Information

This is a sample associations table exposed when the ExpandAssociations connection property is set to False (default).

SELECT

A query to this table will return will return the Id-s of all the records and their corresponding object type associated to a specific FeedbackSubmission record.

SELECT * FROM FeedbackSubmissionAssociations

Note: You cannot reference custom objects by base name. When querying FeedbackSubmissionAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	FeedbackSubmissions.Id	False	The unique identifier for the feedback submission record.
AssociationId [KEY]	Long	False		False	The ID of the associated object linked to this feedback submission, such as a contact, company, or ticket.
Type [KEY]	String	False		True	The type of object associated with the feedback submission, such as contact, deal, ticket, or custom object.

FeedbackSubmissionProperties

Retrieves property fields for feedback submission records in HubSpot, enabling feedback analysis.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	The internal name of the feedback submission property, used in HubSpot APIs. Must start with a lowercase letter and contain only alphanumeric characters.
Label	String	False		False	The display name of the property as shown in the HubSpot UI, intended for human readability.
FieldType	String	False		False	The visual input type for the property in the UI, such as text field, dropdown, or date picker.
Type	String	False		False	The underlying data type of the property, such as string, number, or datetime.
GroupName	String	False		False	The group or category this property belongs to, used for organizing properties in the UI.
Description	String	False		False	A short explanation of the property's purpose or how it's used in feedback submissions.
DisplayOrder	Int	False		False	The position of this property within its group relative to others, used to determine display sequence.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are defined externally, rather than within the property settings.
IsFormField	Bool	False		False	Specifies whether this property is intended to appear on a form for user input.
IsCalculated	Bool	False		False	True if this property is automatically calculated by HubSpot; false if it must be manually entered.
IsHidden	Bool	False		False	Determines whether this property is hidden from the HubSpot user interface.
IsHubspotDefined	Bool	False		False	Indicates whether the property is a default field created by HubSpot rather than a custom property.
Archivable	Bool	False		False	Indicates whether the property's data can be archived in HubSpot.
ReadOnlyDefinition	Bool	False		False	True if the property definition (such as type or label) cannot be modified.
ReadOnlyValue	Bool	False		False	True if the value of the property is system-controlled and cannot be changed manually.
OptionsAggregate	String	False		False	A collection of the available options for the property. Has a value when FieldType is radio, checkbox, or boolean checkbox.
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

Forms

Retrieves forms used in HubSpot for lead capture and contact data collection.

SELECT

When selecting Forms, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM Forms WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'

INSERT

INSERT INTO Forms (Name, FormType, CreatedAt, language)
VALUES ('Test Form Name', 'hubspot', current_timestamp(), 'en')

UPDATE

UPDATE Forms SET Archivable = true, Editable = true, Cloneable = true, SubmitButtonText = 'Updated!'
WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'

DELETE

DELETE FROM Forms WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		True	Unique identifier of the marketing form.
Name	String	False		False	The title of the form as it appears in HubSpot.
FormType	String	False		True	The category of the form, such as blog_comment, captured, hubspot, or flow.
FieldGroups	String	False		False	An aggregate of field groups included in the form.
Language	String	False		False	The language the form is set to use.
Cloneable	Bool	False		False	Indicates whether the form can be cloned to create a duplicate.
Editable	Bool	False		False	Specifies whether the form can be edited.
Archivable	Bool	False		False	Determines whether the form can be archived.
RecaptchaEnabled	Bool	False		False	Indicates whether reCAPTCHA is enabled for the form to prevent spam submissions.
NotifyContactOwner	Bool	False		False	If true, notifies the contact owner when the form is submitted.
NewContactNewEmail	Bool	False		False	If true, creates a new contact record for a new email address submitted via the form.
PrePopulate	Bool	False		False	Indicates whether known values should be pre-populated in the form fields.
AllowLinkToReset	Bool	False		False	Allows users to reset known field values via a link.
RenderRawHtml	Bool	False		False	If true, renders the form using raw HTML.
Theme	String	False		False	The theme applied to the form for styling.
SubmitButtonText	String	False		False	Text displayed on the form's submit button.
CssClass	String	False		False	The CSS class used for styling the form.
Style	String	False		False	The display style of the form, such as pop-up or embedded.
CreatedAt	Datetime	False		False	The timestamp when the form was created.
UpdatedAt	Datetime	False		False	The timestamp when the form was last updated.
Archived	Bool	True		False	Indicates whether the form has been archived.

InvoiceAssociations

Retrieve the IDs of all the objects associated to specific Invoices objects in HubSpot.

Table Specific Information

SELECT

Note: You cannot reference custom objects by base name. When querying InvoiceAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Invoices.Id	False	Invoices ID
AssociationId [KEY]	Long	False		False	ID of the object that this Invoices object is associated with.
Type [KEY]	String	False		False	Type of the associated object, such as a contact or deal.

Invoices

Retrieve the available Invoices in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Allow partial payments	Bool	False		True	Allow your customer to pay less than the balance due
Allowed payment methods	String	False		False	The payment methods that can be used to pay the invoice.
Amount billed	Decimal	False		True	The amount billed on the invoice.
Amount billed in company currency	Decimal	True		True	The amount billed on the invoice in the company currency.
Amount billed (preTax)	Decimal	True		True	The amount billed on the invoice before tax.
Amount paid	Decimal	True		True	The total value of non-failed payments associated to the invoice.
Amount paid in company currency	Decimal	True		True	The total value of non-failed payments associated to the invoice in the company currency.
Amount processing	Decimal	True		True	The total value of processing payments associated to the invoice.
Line item names	String	True		True	The line item names associated to this invoice.
Balance due	Decimal	True		True	The balance due for the invoice.
Balance due in company currency	Decimal	True		True	The balance due for the invoice in the company currency.
Billing frequency type	String	True		False	Indicates whether or not the invoice is part of a recurring series (a subscription).
Address types to collect	String	False		False	The types of addresses that are collected while paying the invoice.
Comments	String	False		True	Comments to the invoice recipient.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Create Date	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Currency	String	False		True	The currency of the invoice.
Custom Invoice Fields	String	False		False	The custom fields that have been added to the invoice.
Days paid late	String	True		False	How many days the invoice was paid after the due date
Discounts total	Decimal	True		True	The sum of all line item level discounts and invoice level discounts applied to the invoice.
Domain	String	False		True	Domain of the hosted rendered invoice.
Due date	Datetime	False		True	The due date for the current invoice.
Automated taxes on	Bool	False		True	Whether or not automated tax is enabled for the invoice.
Exchange rate	Decimal	True		True	This is the exchange rate used to convert the invoice amount into your company currency.
External account id	String	True		True	The 3rd party account Id associated with this invoice.
Invoice external create date/time	Datetime	False		True	The date and time at which the invoice was created in the 3rd party accounting application
External id	String	True		True	The 3rd party unique Id associated with this invoice.
External recipient	String	False		True	The recipient of the current invoice.
Fees total	Decimal	True		True	The sum of all fees applied to the invoice.
Age category	String	True		False	How many days an invoice has been outstanding
Invoice billable	Bool	False		True	Whether or not the invoice is billable
Invoice class	String	False		True	Classification of an invoice, typically synced from third party accounting integrations.
Invoice date	Datetime	False		True	Date of the invoice.
Latest company name	String	True		True	The latest name value among companies associated to this invoice.
Latest contact email	String	True		True	The latest email value among contacts associated to this invoice.
Latest contact first name	String	True		True	The latest first name value among contacts associated to this invoice.
Latest contact last name	String	True		True	The latest last name value among contacts associated to this invoice.
Invoice link	String	True		True	The invoice url link, based on the domain and slug.
Invoice payment collection method	String	False		False	The method used to collect payment for the invoice.
Preset ID	Decimal	False		True	The id of the preset set for this invoice.
Invoice source	String	True		False	Creation source of the invoice.
Invoice status	String	False		False	The status of the invoice. Invoice statuses allow you to categorize and track billing progress.
Invoice status details	String	True		False	Additional invoice status details.
Invoice Tool Source	String	True		False	The tool that was used to create the invoice.
Invoice Tool Source ID	String	True		True	The ID of the tool used to create the invoice.
Language	String	False		True	Language of the invoice.
Last Edit Date	Datetime	True		True	The last time a finalized invoice was edited. This is automatically updated by HubSpot.
Last reminder sent date	Datetime	True		True	The last time an email reminder was sent to the customer. This is automatically updated by HubSpot.
Last sent date	Datetime	True		True	The last time the invoice was sent to the customer. This is updated automatically by HubSpot.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Locale	String	False		True	Locale of the invoice.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
net payment term	Decimal	False		True	Refers to the period, expressed in days (such as Net 30), within which invoice must be paid.
Number	String	False		True	The 3rd party number associated to this invoice.
Number of Subscriptions	Decimal	True		True	Number of subscriptions associated to the invoice.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Order level discounts total	Decimal	True		True	The sum of only invoice level discounts applied to the invoice.
Owning Teams	String	False		False	The teams that are attributed to this record.
Payment date	Datetime	False		True	The date when payment of an invoice has fully completed.
Payment status	String	True		False	The state of payment on an invoice.
PDF download link	String	True		True	The link to download the pdf of this invoice.
PO number	String	False		True	Purchase order number of the invoice.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Received by recipient date (QuickBooks Online)	Datetime	False		True	The date the invoice was received by the recipient.
Recipient company street address	String	False		True	The address of the recipient's company or organization.
Recipient company street address 2	String	False		True	Additional address of the recipient's company or organization.
Recipient company city	String	False		True	The city of the recipient's company or organization.
Recipient company country	String	False		True	The country of the recipient's company or organization.
Recipient company country code	String	False		True	The country code of the recipient's company or organization.
Recipient company state/region	String	False		True	The state or region of the recipient's company or organization.
Recipient company postal code	String	False		True	The postal or zip code of the recipient's company or organization.
Recipient shipping street address	String	False		True	The shipping address of the recipient.
Recipient shipping street address 2	String	False		True	Additional shipping address of the recipient.
Recipient shipping city	String	False		True	The shipping city of the recipient.
Recipient shipping country	String	False		True	The shipping country of the recipient.
Recipient shipping country code	String	False		True	The shipping country of the recipient.
Recipient shipping name	String	False		True	The shipping name of the recipient.
Recipient shipping state/region	String	False		True	The shipping state or region of the recipient.
Recipient shipping postal code	String	False		True	The shipping postal or zip code of the recipient.
Sender company address	String	True		True	The street address of the company sending this invoice.
Sender company address line 2	String	True		True	The second line of the street address of the company sending this invoice.
Sender company city	String	True		True	The city of the company sending this invoice.
Sender company country	String	True		True	The country of the company sending this invoice.
Sender company domain	String	True		True	The domain of the company sending this invoice.
Sender company logo url	String	True		True	The logo url of the company sending this invoice.
Sender company name	String	True		True	The name of the company sending this invoice.
Sender company state	String	True		True	The state of the company sending this invoice.
Sender company zip	String	True		True	The zip code of the company sending this invoice.
Shared teams	String	True		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	True		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Slug	String	False		True	Slug of the hosted rendered invoice.
External Invoice Status	String	True		False	The external status of the current invoice. This value is retrieved from a third party and may not be modified
Store payment method at checkout	Bool	False		True	Allow customers to store their payment method at checkout.
Subtotal	Decimal	True		True	The sum of all line items of the invoice including line item level taxes.
Tax calculation ID	String	True		True	The id reference to the tax calculation data for the invoice.
Tax ID	String	False		False	The account tax ID listed on this invoice. The tax ID includes a tax ID type and a tax ID number.
Taxes total	Decimal	True		True	The sum of all taxes applied to the invoice.
Test mode	String	False		False	Indicates if the invoice is in test mode
Time zone	String	False		True	The time zone of dates on the invoice.
Title	String	False		True	The title of the invoice.
Unique creation key	String	True		True	Unique property used for idempotent creates
Unique id	String	True		True	The unique identifier of the invoice. This value is automatically set by HubSpot and may not be modified.
Upcoming reminder dates	String	True		False	The upcoming dates in which email reminders will be sent to the customer. This is updated automatically by HubSpot.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	The object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

LeadAssociations

Lists object IDs associated with specific lead records in HubSpot, supporting lead associations.

Table Specific Information

Select

Note: You cannot reference custom objects by base name. When querying LeadAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	Leads.Id	False	The unique identifier for the lead.
AssociationId [KEY]	Long	False		False	The unique identifier of the object associated with the lead, such as a contact or deal.
Type [KEY]	String	False		True	The type of associated object, such as contact, deal, or company.

LeadPipelineStages

Lists stages within lead pipelines, helping visualize and manage the lead funnel.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	The unique identifier for the lead pipeline stage.
PipelineId [KEY]	String	False	LeadPipelines.Id	False	The unique identifier of the pipeline that this stage belongs to.
Label	String	False		False	The display name of the pipeline stage.
PipelineLabel	String	False	LeadPipelines.Label	False	The display name of the pipeline containing this stage.
IsClosed	Bool	False		False	Indicates whether the stage is considered closed.
State	String	False		False	The current state or classification of the pipeline stage.
Archived	Bool	True		False	Indicates whether the stage has been archived.
CreatedAt	Datetime	True		False	The timestamp when the stage was originally created.
UpdatedAt	Datetime	True		False	The timestamp of the most recent update to the stage.
DisplayOrder	Int	False		False	The numerical order in which this stage appears within the pipeline.

LeadProperties

Retrieves all available lead property fields, supporting lead data management and enrichment.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	The internal name of the lead property, which must begin with a lowercase letter and include only lowercase letters and numbers.
Label	String	False		False	The human-readable label for the property as it appears in the HubSpot UI.
FieldType	String	False		False	The type of input field used to display this property in forms or UI components, such as text, dropdown, or checkbox.
Type	String	False		False	The underlying data type used to store the property's value, such as string, number, or datetime.
GroupName	String	False		False	The name of the group that this property belongs to for organizational purposes.
Description	String	False		False	A brief explanation of the property's purpose or intended usage.
DisplayOrder	Int	False		False	The order in which the property appears relative to other properties in the same group.
ExternalOptions	Bool	False		False	Indicates whether this property pulls its selectable options from an external source.
IsFormField	Bool	False		False	Indicates whether the property is used in forms submitted by users or leads.
IsCalculated	Bool	False		False	True if the property's value is automatically calculated based on other fields or rules.
IsHidden	Bool	False		False	Indicates whether the property is hidden from the UI or standard views.
IsHubspotDefined	Bool	False		False	True if the property was created by HubSpot as part of its default schema.
Archivable	Bool	False		False	Indicates whether the property can be archived in HubSpot.
ReadOnlyDefinition	Bool	False		False	True if the property's definition cannot be modified.
ReadOnlyValue	Bool	False		False	True if the value of this property is locked and cannot be updated.
OptionsAggregate	String	False		False	A combined list of possible values for the property. Has a value when FieldType is radio, checkbox, or boolean checkbox.
HasUniqueValue	Bool	False		False	Indicates whether each record must have a unique value for this property.

LeadPropertyGroups

Provides groups used to organize lead properties for easier data management.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	The internal name of the lead property group used for grouping related properties.
Label	String	False		False	The display label for the property group, as shown in the HubSpot UI.
DisplayOrder	Int	False		False	The relative position of the property group among other groups, used to determine display order.

Leads

Retrieves all lead records from HubSpot for lead tracking and management.

Table Specific Information

In HubSpot, leads are contacts or companies that are potential customers.

SELECT

When selecting leads, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Leads;
SELECT * FROM Leads WHERE [Id] = '385815394826';
SELECT * FROM Leads WHERE [Workflow updated lifecycle stage of company] = true OR [Associated Company Domain] = 'http://HubTest.com';

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Leads WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Leads WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Leads WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Leads WHERE ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value})

INSERT

When creating Leads, either the 'Primary Associated Contact Object ID' column or the 'Primary Associated Company Object ID' column (these names can change based on UseDisplayNames and UseSimpleNames) must be specified in the INSERT statement, otherwise the query will fail. For example:

INSERT INTO Leads (`Lead Name`, `Primary Associated Contact Object ID`) VALUES ('Inserted Lead 1', 31501492998);
INSERT INTO Leads (`Lead Name`, `Primary Associated Company Object ID`) VALUES ('Inserted Lead 1', 21960329051);
INSERT INTO Leads (`Lead Name`, `Primary Associated Contact Object ID`, `Primary Associated Company Object ID`) VALUES ('Inserted Lead 1', 31501492998, 21960329051);

The same applies for bulk INSERTs:

INSERT INTO Leads#TEMP (`Lead Name`, `Primary Associated Contact Object ID`) VALUES ('Inserted Lead 1', 31501492998);
INSERT INTO Leads#TEMP (`Lead Name`, `Primary Associated Contact Object ID`) VALUES ('Inserted Lead 1', 31501492998);
INSERT INTO Leads#TEMP (`Lead Name`, `Primary Associated Contact Object ID`) VALUES ('Inserted Lead 1', 31501492998);
INSERT INTO Leads (`Lead Name`, `Primary Associated Contact Object ID`) SELECT * FROM Leads#TEMP;

UPDATE

UPDATE Leads SET [Business units] = '10' WHERE [Id] = '3917882265'
UPDATE Leads SET [Lead Disqualification Note] = 'testing note', [Disqualification Reason] = 'BAD_TIMING' WHERE [Id] = '386085073667'

DELETE

DELETE FROM Leads WHERE ID = '3917882265'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier for the lead record.
Archived	Bool	True		False	Indicates whether the lead record is archived.
CreatedAt	Datetime	True		False	Timestamp when the lead record was initially created.
UpdatedAt	Datetime	True		False	Timestamp when the lead record was most recently updated.
All teams	String	True		True	Team IDs, including inherited teams in the hierarchy, associated with this lead's owner properties.
Business units	String	False		True	Business units this lead is assigned to within HubSpot.
All owner ids	String	True		True	All owner IDs, including custom and default owner assignments, linked to this lead.
All team ids	String	True		True	Team IDs corresponding to all owner properties linked to this lead.
Associated Company Domain	String	True		True	Domain name of the company associated with the lead, if available.
Associated Company Name	String	True		True	Name of the company associated with the lead, if available.
Associated Contact Email	String	True		True	Email address of the primary contact associated with the lead, if available.
Associated Contact First Name	String	True		True	First name of the primary contact associated with the lead, if available.
Associated Contact Last Name	String	True		True	Last name of the primary contact associated with the lead, if available.
Calls Connected Count	Decimal	True		True	Total number of calls associated with the lead that were successfully connected.
Primary company analytics source	String	True		True	Primary company's most recent analytics source at the time of lead association. Not updated after initial rollup.
Primary company analytics source first drilldown	String	True		True	First-level drilldown of the primary company's analytics source when initially associated with the lead.
Primary company analytics source second drilldown	String	True		True	Second-level drilldown of the primary company's analytics source when initially associated with the lead.
Company Avatar FileManager key	String	True		True	FileManager path to the avatar override image for the associated company.
Is Target Account	String	True		True	Indicates if the associated company is considered a target account in marketing or sales strategy.
Company Last Activity Date	Datetime	True		True	Date of the most recent activity involving the lead's associated company.
Company Last Engagement Date	Datetime	True		True	Date of the most recent contact engagement with the associated company, excluding marketing and bulk emails.
Company Last Engagement Type	String	True		True	Type of the last engagement activity from the associated company, excluding marketing and bulk emails.
Company Time of Last Session	Datetime	True		True	Timestamp of the last recorded web session for the associated company's contacts.
Company Next Activity Date	Datetime	True		True	Date of the next scheduled activity associated with the lead's primary company.
Company Next Activity Type	String	True		True	Type of the next scheduled activity associated with the lead's primary company.
Company Number of Pageviews	Decimal	True		True	Total number of web pageviews from contacts associated with the lead's primary company.
Associated company timezone	String	True		True	Time zone associated with the lead's primary company, if known.
Primary contact analytics source	String	True		True	Most recent analytics source from the primary contact when initially associated with the lead.
Primary contact analytics source first drilldown	String	True		True	First-level drilldown of the primary contact's analytics source at the time of lead association.
Primary contact analytics source second drilldown	String	True		True	Second-level drilldown of the primary contact's analytics source at the time of lead association.
Contact Avatar FileManager key	String	True		True	FileManager path to the avatar override image for the lead's primary contact.
Contact Buying Role	String	True		True	Sales buying role of the lead's primary contact.
Associated contact job title	String	True		True	Job title of the lead's primary contact, if available.
Contact Last Activity Date	Datetime	True		True	Date of the most recent activity involving the lead's primary contact.
Contact Last Engagement Date	Datetime	True		True	Date of the most recent engagement by the primary contact, excluding marketing and bulk emails.
Contact Last Engagement Type	String	True		True	Type of the most recent engagement by the primary contact, excluding marketing and bulk emails.
Contact Time of Last Session	Datetime	True		True	Timestamp for the start of the most recent web session by the lead's primary contact.
Contact Next Activity Date	Datetime	True		True	Scheduled date of the next activity involving the lead's primary contact.
Contact Next Activity Type	String	True		True	Type of the next scheduled activity involving the lead's primary contact.
Contact Number of Pageviews	Decimal	True		True	Total number of pageviews recorded for the lead's primary contact.
Associated contact timezone	String	True		True	Time zone of the associated contact, if available.
Created by user ID	Decimal	True		True	User ID of the HubSpot user who created this lead. Automatically assigned.
Object create date/time	Datetime	True		True	Date and time when this lead object was created. Automatically set by HubSpot.
Emails Connected Count	Decimal	True		True	Number of email communications with this lead that were successfully connected.
Initial Assign Notification State	String	True		True	Status of the initial lead assignment notification sent at creation.
Last Activity Date	Datetime	True		True	Date of the most recent activity, prioritizing contact data first, then company data if contact is unavailable.
Last Engagement Date	Datetime	True		True	Latest engagement date for the primary contact or, if absent, the associated company. Excludes marketing and mass emails.
Last Engagement Type	String	True		True	Latest engagement type for the primary contact or, if absent, the associated company. Excludes marketing and mass emails.
Lead Time of Last Session	Datetime	True		True	Timestamp for the latest session of the lead's contact or, if unavailable, the associated company.
Object last modified date/time	Datetime	True		True	Timestamp of the most recent update to the lead object, including hidden internal properties. Set automatically by HubSpot.
Associated Deal Pipeline Stage	String	True		True	Current pipeline stage of the primary associated deal.
Associated deals	Decimal	True		True	Total number of deals associated with this lead.
Call Count	Decimal	True		True	Total number of calls made to the lead.
Closed won deal amount	Decimal	True		True	Aggregate value of all associated deals marked as closed-won.
Message Thread Count	Decimal	True		True	Number of message threads (SMS, LinkedIn, WhatsApp) opened with this lead.
Currency	String	True		True	Currency code used in the lead's most recent associated deal.
Lead Disqualification Note	String	False		True	Free-text explanation provided when a lead is marked disqualified.
Disqualification Reason	String	False		True	Standardized dropdown option selected when disqualifying a lead.
Email Count	Decimal	True		True	Total number of emails sent to the lead.
First Outreach Date	Datetime	True		True	Date of the first outreach attempt to the lead, including calls, emails, or meetings.
Lead Inferred Pseudostage	String	True		True	Inferred stage of the lead based on user or system activity, not necessarily matching the formal pipeline stage.
Is Disqualified	Decimal	True		True	Indicates whether the lead is disqualified (1) or not (0). Used for reporting.
In progress leads	Decimal	True		True	Indicates whether the lead is actively in progress (1) or not (0). Used for reporting.
Is New	Decimal	True		True	Indicates whether the lead is newly created (1) or not (0). Used for reporting.
Open leads	Decimal	True		True	Indicates whether the lead is considered 'open' based on the pipeline stage not being qualified or unqualified.
Is Qualified	Decimal	True		True	Indicates whether the lead is qualified (1) or not (0). Used for reporting.
Lead Label	String	False		True	Current user-defined status label applied to the lead.
Meeting Count	Decimal	True		True	Total number of meetings booked with this lead.
Lead Name	String	False		True	Full name of the lead, as entered in the system.
Lead name calculated	String	True		True	System-calculated full name of the lead, typically derived from associated contact data.
Outreach activity count	Decimal	True		True	Cumulative number of outreach activities such as calls, emails, and meetings related to this lead.
Open deal amount	Decimal	True		True	Total value of all open deals associated with this lead.
Primary Company Owner	String	True		True	HubSpot owner ID of the lead's associated primary company.
Primary Contact Owner	String	True		True	HubSpot owner ID of the lead's associated primary contact.
Lead Source	String	True		True	Analytics source of the lead, based on the primary contact or company at the time of creation.
Initial company lifecycle stage	String	True		True	Lifecycle stage detected on the lead's associated primary company at creation. Not updated thereafter.
Initial contact lifecycle stage	String	True		True	Lifecycle stage detected on the lead's associated primary contact at creation. Not updated thereafter.
Lead Source DrillDown 1	String	True		True	Secondary level of detail for the lead's analytics source.
Lead Source DrillDown 2	String	True		True	Tertiary level of detail for the lead's analytics source.
Initial source lifecycle stage	String	True		True	Lifecycle stage of the lead's source contact or company at time of lead creation.
Time to First Touch	Decimal	True		True	Elapsed time in seconds between lead creation and the first outreach activity.
Lead Title (DEPRECATEDUse hsLeadName)	String	True		True	Deprecated field for lead title. Use hsLeadName instead.
Lead Type	String	False		True	Classification of the lead such as New Business, Existing Business, or Re-attempting.
Meetings Connected Count	Decimal	True		True	Number of associated meetings that are considered to be connected or successful.
Merged record IDs	String	True		True	Record IDs that were merged into this lead. Automatically assigned by HubSpot.
Next Activity Date	Datetime	True		True	Date of the next scheduled activity related to this lead or its associated contact or company.
Next Activity Type	String	True		True	Type of the next scheduled activity related to this lead or its associated contact or company.
Lead Number of Pageviews	Decimal	True		True	Number of website pageviews from the associated contact, or the associated company if contact is not available.
Record ID	Decimal	True		True	Unique record ID assigned to this lead. Automatically set by HubSpot.
Record Creation Source	String	True		True	System source that created this lead, stored in the internal RequestMeta.
Record Source Detail 1	String	True		True	Primary level of detail on how this lead was created.
Record Source Detail 2	String	True		True	Secondary level of detail on how this lead was created.
Record Source Detail 3	String	True		True	Tertiary level of detail on how this lead was created.
Record Creation Source ID	String	True		True	Source ID from the internal RequestMeta that created this lead.
Record Source	String	True		True	Text description of how this lead record was created.
Record Creation Source User ID	Decimal	True		True	User ID from the internal RequestMeta that created this lead.
Lead owner calculated	String	True		True	Calculated owner of the lead, based on the primary contact if available or the company otherwise.
Lead Pipeline	String	False		True	Name of the pipeline that this lead currently belongs to.
Lead Pipeline Stage	String	False		True	Current stage of the lead within its assigned pipeline.
Pipeline Stage Category	String	True		True	Category type for the current pipeline stage of the lead.
Pipeline Stage Category Last Updated At	Datetime	True		True	Timestamp of the most recent change to the lead's pipeline stage category.
Primary Associated Object Name	String	True		True	Name of the lead's primary associated contact or company.
Primary Associated Company Object ID	Decimal	False		True	Object ID of the lead's primary associated company.
Primary contact enrolled in sequence	Bool	True		True	Indicates if the primary contact for this lead is currently active in a sequence.
Primary Associated Contact Object ID	Decimal	False		True	Object ID of the lead's primary associated contact.
Read Only Object	Bool	True		True	Indicates whether the object is read-only and cannot be edited.
Shared Team IDs	String	True		True	Team IDs of all teams granted shared access to this lead.
Shared User IDs	String	True		True	User IDs of all users granted shared access to this lead.
Lead tags	String	True		True	List of tag IDs applied to the lead. Automatically managed by HubSpot.
Time in Attempting (Lead Pipeline)	Decimal	True		True	Total time in seconds spent by the lead in the 'Attempting' stage of the Lead pipeline.
Time in Connected (Lead Pipeline)	Decimal	True		True	Total time in seconds spent by the lead in the 'Connected' stage of the Lead pipeline.
Time in New (Lead Pipeline)	Decimal	True		True	Total time in seconds spent by the lead in the 'New' stage of the Lead pipeline.
Time in Qualified (Lead Pipeline)	Decimal	True		True	Total time in seconds spent by the lead in the 'Qualified' stage of the Lead pipeline.
Time in Disqualified (Lead Pipeline)	Decimal	True		True	Total time in seconds spent by the lead in the 'Disqualified' stage of the Lead pipeline.
Unique creation key	String	True		True	Property used to uniquely identify and safely retry create operations without duplication.
Updated by user ID	Decimal	True		True	User ID of the person who last updated the lead. Automatically assigned by HubSpot.
User IDs of all notification followers	String	True		True	User IDs of all users subscribed to notifications for changes on this lead.
User IDs of all notification unfollowers	String	True		True	User IDs of all users who have opted out of notifications for this lead.
User IDs of all owners	String	True		True	User IDs of all users assigned ownership of this lead.
Cumulative time in Attempting (Lead pipeline)	Decimal	True		True	Cumulative time in seconds the lead has spent in the 'Attempting' stage across all entries into that stage.
Cumulative time in Connected (Lead pipeline)	Decimal	True		True	Cumulative time in seconds the lead has spent in the 'Connected' stage across all entries into that stage.
Cumulative time in New (Lead pipeline)	Decimal	True		True	Cumulative time in seconds the lead has spent in the 'New' stage across all entries into that stage.
Cumulative time in Qualified (Lead pipeline)	Decimal	True		True	Cumulative time in seconds the lead has spent in the 'Qualified' stage across all entries into that stage.
Cumulative time in Disqualified (Lead pipeline)	Decimal	True		True	Cumulative time in seconds the lead has spent in the 'Disqualified' stage across all entries into that stage.
Date entered Attempting (Lead pipeline)	Datetime	True		True	Date and time when the lead entered the 'Attempting' stage in the Lead pipeline.
Date entered Connected (Lead pipeline)	Datetime	True		True	Date and time when the lead entered the 'Connected' stage in the Lead pipeline.
Date entered New (Lead pipeline)	Datetime	True		True	Date and time when the lead entered the 'New' stage in the Lead pipeline.
Date entered Qualified (Lead pipeline)	Datetime	True		True	Date and time when the lead entered the 'Qualified' stage in the Lead pipeline.
Date entered Disqualified (Lead pipeline)	Datetime	True		True	Date and time when the lead entered the 'Disqualified' stage in the Lead pipeline.
Date exited Attempting (Lead pipeline)	Datetime	True		True	Date and time when the lead exited the 'Attempting' stage in the Lead pipeline.
Date exited Connected (Lead pipeline)	Datetime	True		True	Date and time when the lead exited the 'Connected' stage in the Lead pipeline.
Date exited New (Lead pipeline)	Datetime	True		True	Date and time when the lead exited the 'New' stage in the Lead pipeline.
Date exited Qualified (Lead pipeline)	Datetime	True		True	Date and time when the lead exited the 'Qualified' stage in the Lead pipeline.
Date exited Disqualified (Lead pipeline)	Datetime	True		True	Date and time when the lead exited the 'Disqualified' stage in the Lead pipeline.
Latest time in Attempting (Lead pipeline)	Decimal	True		True	Duration in seconds of the most recent time the lead spent in the 'Attempting' stage.
Latest time in Connected (Lead pipeline)	Decimal	True		True	Duration in seconds of the most recent time the lead spent in the 'Connected' stage.
Latest time in New (Lead pipeline)	Decimal	True		True	Duration in seconds of the most recent time the lead spent in the 'New' stage.
Latest time in Qualified (Lead pipeline)	Decimal	True		True	Duration in seconds of the most recent time the lead spent in the 'Qualified' stage.
Latest time in Disqualified (Lead pipeline)	Decimal	True		True	Duration in seconds of the most recent time the lead spent in the 'Disqualified' stage.
Performed in an import	Bool	True		True	Indicates whether the lead was created or updated as part of a data import.
Workflow updated lifecycle stage of company	Bool	False		True	Indicates whether a workflow was responsible for updating the lifecycle stage of the lead's associated company.
Workflow updated lifecycle stage of contact	Bool	False		True	Indicates whether a workflow was responsible for updating the lifecycle stage of the lead's associated contact.
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was most recently assigned to the lead. Automatically set by HubSpot.
Lead Owner	String	False		True	Owner of the lead. Defaults to the owner of the primary contact, or the primary company if the contact is not available.
HubSpot Team	String	True		True	Primary team of the lead owner. Automatically assigned by HubSpot.
lead custom field	String	False		True	Custom field associated with the lead. Purpose varies depending on configuration.

LineitemAssociations

Lists object IDs associated with specific line items, supporting line item associations in deals.

Table Specific Information

SELECT

Note: You cannot reference custom objects by base name. When querying LineitemAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	Lineitems.Id	False	Unique identifier of the line item.
AssociationId [KEY]	Long	False		False	Unique identifier of the object associated with this line item, such as a deal or contact.
Type [KEY]	String	False		True	Type of object associated with the line item, such as a deal or contact.

LineItemProperties

Retrieves all properties for line items, including standard and custom fields, supporting detailed item tracking.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the line item property. Must start with a lowercase letter and contain only lowercase letters and numbers.
Label	String	False		False	Human-readable label for the property, displayed in the HubSpot user interface.
FieldType	String	False		False	Type of input field used to display the property on forms and records, such as text or dropdown.
Type	String	False		False	Stored machine-readable data type for the property, such as string, number, or date.
GroupName	String	False		False	Name of the property group where this line item property belongs.
Description	String	False		False	Text description explaining the purpose or intended use of the property.
DisplayOrder	Int	False		False	Order number determining how the property appears relative to others in the same group.
ExternalOptions	Bool	False		False	Indicates whether the property options are managed externally rather than inside HubSpot.
IsFormField	Bool	False		False	Indicates whether the property is included in forms presented to users.
IsCalculated	Bool	False		False	Indicates whether the property's value is calculated automatically rather than entered manually.
IsHidden	Bool	False		False	Indicates whether the property is hidden from the HubSpot user interface.
IsHubspotDefined	Bool	False		False	Indicates whether the property definition was created and managed by HubSpot.
Archivable	Bool	False		False	Indicates whether the property can be archived.
ReadOnlyDefinition	Bool	False		False	Indicates whether the structure or configuration of the property is read-only.
ReadOnlyValue	Bool	False		False	Indicates whether the value of the property is read-only after it is set.
OptionsAggregate	String	False		False	Additional options available for the property if the field type supports multiple options, such as radio buttons or checkboxes.
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

Lineitems

Lists all line items in HubSpot, with support for both OAuth and private-app token authentications.

Table Specific Information

In HubSpot, line items can be thought of as a subset of products. When a product is attached to a deal, it becomes a line item. You can create line items that are unique to an individual quote, but they will not be added to your product library.

SELECT

When selecting line items, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM LineItems
SELECT * FROM LineItems WHERE [Amount] > 1000 AND [Quantity] >= 10
SELECT * FROM LineItems WHERE [Product price] = 40 OR [Product description] = 'White t-shirt'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM LineItems WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM LineItems WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM LineItems WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM LineItems WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO LineItems (Description, [Product ID]) VALUES ('description', '33318601')

UPDATE

UPDATE LineItems SET Description = 'new description' WHERE ID = '168209183'

DELETE

DELETE FROM Deals WHERE ID = '168209183'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier assigned to the line item object in HubSpot.
Archived	Bool	True		False	Indicates whether the line item has been archived and is no longer active.
CreatedAt	Datetime	True		False	Timestamp marking when the line item was first created.
UpdatedAt	Datetime	True		False	Timestamp marking when the line item was last updated.
Net price	Decimal	True		True	Final price of the line item after any discounts are applied.
Create Date	Datetime	False		True	Date when the line item record was created.
Description	String	False		True	Detailed description of the product associated with the line item.
Unit discount	Decimal	False		True	Discount amount applied to each unit of the product.
Annual contract value	Decimal	True		True	Annual contract value (ACV) generated by the product in the line item.
All accessible team IDs	String	True		True	List of all accessible team IDs, including hierarchical teams, associated with this line item.
Business units	String	False		True	Business units assigned to this line item for organizational reporting.
All owner ids	String	True		True	List of all owner user IDs assigned to this line item, both default and custom.
All team ids	String	True		True	List of all team IDs associated with this line item ownership.
Allow buyer selected quantity	String	True		True	Indicates whether buyers are allowed to select the quantity for this line item during checkout.
Annual recurring revenue	Decimal	True		True	Annual recurring revenue (ARR) associated with the product in this line item.
Delayed billing start by days	Decimal	False		True	Number of days by which billing for this line item should be delayed.
Delayed billing start by months	Decimal	False		True	Number of months by which billing for this line item should be delayed.
Start billing terms	String	True		True	Method used to define billing start date, such as a fixed date or a relative delay in days or months.
Unit cost	Decimal	False		True	Cost incurred by the seller for each unit of the product sold in the line item.
Created by user ID	Decimal	True		True	HubSpot user ID of the individual who created the line item. This value is set automatically.
Object create date_time	Datetime	True		True	Timestamp indicating when the line item object was created. This value is automatically set by HubSpot.
Discount Percentage	Decimal	False		True	Percentage discount applied to the unit price of the line item.
External LineItem id	Decimal	True		True	External ID referencing the line item from an outside system if applicable.
Image URL	String	False		True	URL link to the product image associated with the line item.
Last Modified Date	Datetime	True		True	Timestamp when any property of the line item was last modified.
Currency	String	False		True	Currency code in which the line item amount is recorded, such as USD or EUR.
Margin	Decimal	True		True	Profit margin value for the product included in the line item.
Annual contract value margin	Decimal	True		True	Profit margin calculated on the annual contract value (ACV) of the line item.
Annual recurring revenue margin	Decimal	True		True	Profit margin calculated on the annual recurring revenue (ARR) of the line item.
Monthly recurring revenue margin	Decimal	True		True	Profit margin calculated on the monthly recurring revenue (MRR) of the line item.
Total contract value margin	Decimal	True		True	Profit margin calculated on the total contract value (TCV) of the line item.
Merged object IDs	String	True		True	List of merged line item object IDs. This value is automatically set by HubSpot.
Monthly recurring revenue	Decimal	True		True	Monthly recurring revenue (MRR) generated by the product in the line item.
Record ID	Decimal	True		True	Unique HubSpot-generated ID for the line item record.
Position on quote	Decimal	False		True	Order or position number of the line item as it appears on quotes.
Pre Discount Amount	Decimal	True		True	Total amount of the line item before any discounts are applied.
Product ID	Decimal	False		True	Identifier of the product this line item is based on, typically from the product catalog.
Read Only Object	Bool	True		True	Indicates whether the line item is read-only and cannot be modified.
End Date	Date	True		True	Date when recurring billing ends for this line item.
Number of payments	Decimal	True		True	Total number of scheduled payments for this line item.
Term	String	False		True	Duration of recurring billing for the product associated with the line item.
Billing start date	Date	False		True	Date when recurring billing begins for the line item.
Billing terms	String	True		True	Billing structure, such as fixed payment count or continuous until canceled.
SKU	String	False		True	Stock Keeping Unit — a unique identifier used to track the product in inventory or commerce systems.
Sync amount	Decimal	True		True	Amount value pulled in from ecommerce platform sync integrations.
Total contract value	Decimal	True		True	Total contract value (TCV) of the product included in the line item.
Term in months	Decimal	True		True	Length of the contract or recurring billing term expressed in months.
Calculated Total Discount	Decimal	True		True	Total discount value for the line item, accounting for both flat amount and percentage discounts.
Unique creation key	String	True		True	Unique key used to prevent duplication during idempotent creation of the line item.
Updated by user ID	Decimal	True		True	User ID of the individual who last updated this line item. Automatically managed by HubSpot.
URL	String	False		True	URL pointing to the product page associated with this line item.
User IDs of all notification followers	String	True		True	List of user IDs who have opted in to receive notifications for this line item.
User IDs of all notification unfollowers	String	True		True	List of owner user IDs who opted out of receiving follow notifications for this line item.
User IDs of all owners	String	True		True	List of all user IDs assigned as owners of this line item.
Variant id of the product	Decimal	True		True	ID of the specific product variant associated with this line item, often from platforms like Shopify.
Owner Assigned Date	Datetime	True		True	Date and time when an owner was assigned to the line item. Useful for reporting and segmentation.
Owner	String	False		True	User currently assigned as the owner of the line item.
HubSpot Team	String	True		True	Primary HubSpot team associated with the owner of the line item.
Name	String	False		True	Name of the product linked to the line item.
Unit price	Decimal	False		True	Unit price of the product before any discounts are applied.
Quantity	Decimal	False		True	Number of units of the product included in this line item.
Billing frequency	String	False		True	How often the line item is billed for recurring billing (such as monthly, annually, or one-time).
Tax	Decimal	False		True	Amount of tax applied to the line item.

ListingAssociations

Retrieve the IDs of all the objects associated to specific Listings objects in HubSpot.

View Specific Information

ListingAssociations retrieves the IDs of all objects associated with specific listing records in HubSpot. This table shows the relationships between listings and other HubSpot objects such as contacts, companies, deals, and tickets.

SELECT

When selecting listing associations, you must specify the listing ID to retrieve its associated objects. For example:

SELECT * FROM ListingAssociations WHERE Id = '11111'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Listings.Id	False	Listings ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Listings object is associated with.
Type [KEY]	String	False		False	Type of the associated object, which can be a contact, deal etc.

ListingPipelines

Pipelines of Listings in HubSpot.

View Specific Information

ListingPipelines contains the pipeline configurations for listing records in HubSpot. Each pipeline represents a series of stages that listings can progress through.

SELECT

SELECT * FROM ListingPipelines WHERE Id = 'listing-pipeline-id'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	False		False	The unique identified of the pipeline.
Label	String	False		False	The label (name) of the pipeline.
Archived	Bool	True		False	Whether the pipeline is archived or not.
CreatedAt	Datetime	True		False	When the pipeline was created.
UpdatedAt	Datetime	True		False	When the pipeline was last updated.
DisplayOrder	Int	False		False	The order of this specific pipeline in the collection of pipelines for this table.
StagesAggregate	String	False		False	An aggregate of the stages included in this pipeline. This information can be viewed in more detail in TicketPipelineStages table.

ListingPipelineStages

PipelineStages of Listings in HubSpot.

View Specific Information

ListingPipelineStages contains the individual stages within listing pipelines in HubSpot. Each stage represents a specific step in the listing workflow process.

SELECT

SELECT * FROM ListingPipelineStages WHERE PipelineId = 'listing-pipeline-id'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier of the stage in this pipeline.
PipelineId [KEY]	String	False	TicketPipelines.Id	False	Unique identifier of the pipeline.
Label	String	False		False	Label (name) of the pipeline stage.
PipelineLabel	String	True	TicketPipelines.Label	False	The label (name) of the pipeline.
IsClosed	Bool	False		False	Whether this stage is open or closed.
State	String	False		False	Current state of the pipeline stage.
Archived	Bool	True		False	Whether the stage is archived or not.
CreatedAt	Datetime	True		False	Time the stage was created.
UpdatedAt	Datetime	True		False	Time the stage was last updated.
DisplayOrder	Int	False		False	The order of the stage in the collection of stages for this pipeline.

Listings

Retrieve the available Listings in HubSpot.

Table Specific Information

In HubSpot, listings represent real estate properties or inventory items that can be tracked and managed. Listing records support property management, inventory tracking, and sales processes.

SELECT

When selecting listings, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Listings WHERE [Price] > 100000 AND [Bedrooms] >= 2
SELECT * FROM Listings WHERE [City] = 'New York' OR [State/Province] = 'NY'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Listings WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Listings WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Listings WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Listings WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO Listings ([Name], [Price], [City], [State/Province]) VALUES ('Modern Downtown Condo', 350000, 'Boston', 'MA')

UPDATE

UPDATE Listings SET [Price] = 375000 WHERE ID = '11111'

DELETE

DELETE FROM Listings WHERE ID = '11111'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
Address 1	String	False		True	Primary street address line.
Address 2	String	False		True	Secondary address info (apartment, suite, unit).
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Bathroom(s)	Decimal	False		True	Number of bathrooms (full/partial) in the property.
Bedroom(s)	Decimal	False		True	Number of bedrooms in the property.
City	String	False		True	City where the listing is located.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Date entered 'Closed Stage (Listing Pipeline)'	Datetime	True		True	The date and time when the Listing entered the 'Closed Stage' stage, 'Listing Pipeline' pipeline.
Date entered 'Open Stage (Listing Pipeline)'	Datetime	True		True	The date and time when the Listing entered the 'Open Stage' stage, 'Listing Pipeline' pipeline.
Date exited 'Closed Stage (Listing Pipeline)'	Datetime	True		True	The date and time when the Listing exited the 'Closed Stage' stage, 'Listing Pipeline' pipeline.
Date exited 'Open Stage (Listing Pipeline)'	Datetime	True		True	The date and time when the Listing exited the 'Open Stage' stage, 'Listing Pipeline' pipeline.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Listing Type	String	False		False	Type of listing (for sale / rent / lease).
Lot Size	Decimal	False		True	Size of the land lot (outside area).
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Name	String	False		True	Name/title of the listing, such as '3-bed house on Main Street'.
Neighborhood	String	False		True	Name of the neighborhood or local area.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Owning Teams	String	False		False	The teams that are attributed to this record.
Pipeline	String	False		False	The pipeline that contains this listing.
Pipeline Stage	String	False		False	The pipeline stage that contains this listing.
Price	Decimal	False		True	Listing price (currency).
Price/sqft	Decimal	True		True	Price per square foot (or per unit area).
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	False		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	False		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Square Footage	Decimal	False		True	Size of the interior living space.
State/Province	String	False		True	State or province region of the listing.
Time in 'Closed Stage (Listing Pipeline)'	Decimal	True		True	The total time in seconds spent by the Listing in the 'Closed Stage' stage, 'Listing Pipeline' pipeline.
Time in 'Open Stage (Listing Pipeline)'	Decimal	True		True	The total time in seconds spent by the Listing in the 'Open Stage' stage, 'Listing Pipeline' pipeline.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	Object is part of an import.
Year Built	Decimal	False		True	Year when the property was constructed.
Zip	Decimal	False		True	Postal or ZIP code.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

ListMemberships

Represents the relationships between HubSpot lists and CRM objects (contacts, companies, deals, etc.). Each record defines a single object's membership in a specific list, enabling segmentation and targeted marketing activities.

Columns


Name	Type	ReadOnly	References	Filterable	Description
ObjectId [KEY]	Long	False			The unique HubSpot Object identifier (recordId).
ListId [KEY]	Long	False		True	Identifier of the HubSpot list (listId) that contains this CRM object. Required for querying specific list memberships.
ObjectTypeId	String	True			CRM object type identifier for this membership. Common values include '0-1' (contacts), '0-2' (companies), '0-3' (deals), or custom object IDs.
MembershipTimestamp	Datetime	True			UTC datetime (joinTime) indicating when the CRM object was added to the list. Useful for tracking membership history and recency.

Lists

Retrieves and describes all lists in your HubSpot account.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique numeric identifier for the list.
Name	String	False		True	Human-readable name of the list.
ObjectTypeId	String	False			Object type the list applies to ('0-1').
Size	Int	True			Current count of records in the list.
FolderName	String	True			Name of the folder where the list is organized (if any).
ProcessingType	String	False		True	Type of list processing (such as 'SNAPSHOT', 'MANUAL', or 'DYNAMIC'). 使用できる値は次のとおりです。SNAPSHOT, MANUAL, DYNAMIC
ProcessingStatus	String	True			Current state of list processing (such as 'PROCESSING' or 'COMPLETE').
FiltersUpdatedAt	Datetime	True			Timestamp when the list’s filter criteria were last modified.
LastRecordAddedAt	Datetime	True			Timestamp when the most recent record was added to the list.
LastRecordRemovedAt	Datetime	True			Timestamp when the most recent record was removed from the list.
ReferenceCount	Int	True			Number of other HubSpot assets referencing this list.
Version	Int	True			Version number, incremented each time the list definition changes.
CreatedById	Long	True			User ID of the account that created the list.
UpdatedById	Long	True			User ID of the account that last updated the list.
CreatedAt	Datetime	True			Timestamp when the list was originally created.
UpdatedAt	Datetime	True			Timestamp of the most recent update to the list metadata.

MarketingEmails

Marketing emails in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		True	The email ID.
Subject	String	False			The subject of the email.
Type	String	False		True	The email type, this is derived from other properties on the email such as subcategory. Accepted values https://developers.hubspot.com/docs/api-reference/marketing-marketing-emails-v3-v3/marketing-emails/post-marketing-v3-emails-#response-type
Name	String	False			The name of the email, as displayed on the email dashboard.
FeedbackSurveyId	String	False			The ID of the feedback survey linked to the email.
PublishedByEmail	String	True			Email address of the publisher.
PublishDate	String	False			The date and time the email is scheduled for, in ISO8601 representation. This is only used in local time or scheduled emails.
IsTransactional	Boolean	True			Returns whether the email is a transactional email or not. This is read only.
Language	String	False			Language setting for the content. Accepted values https://developers.hubspot.com/docs/api-reference/marketing-marketing-emails-v3-v3/marketing-emails/post-marketing-v3-emails-#response-language
CampaignUtm	String	True			UTM campaign tracking identifier.
BusinessUnitId	String	False			Identifier for the business unit.
Archived	Boolean	False			Determines if the email is archived or not.
PublishedByName	String	True			Name of the person who published the content.
CreatedAt	String	True			The date and time of the email's creation, in ISO8601 representation.
JitterSendTime	Boolean	False			Whether to apply jitter to the email send time.
State	String	False			Current state of the content or entity State. Accepted values https://developers.hubspot.com/docs/api-reference/marketing-marketing-emails-v3-v3/marketing-emails/post-marketing-v3-emails-#response-state
CreatedById	String	True			The id of the user who created the email.
UpdatedAt	String	True			The date and time of the last update to the email, in ISO8601 representation.
ClonedFrom	String	False			The ID of the email this email was cloned from.
PublishedAt	String	True			The date and time the email was published at, in ISO8601 representation.
PublishedById	String	True			The ID of the user who published the email.
IsPublished	Boolean	False		True	Returns the published status of the email. This is read only.
UpdatedById	String	True			The ID of the user who last updated the email.
FolderId	Int	True			Identifier for the folder containing the content FolderId.
EmailCampaignGroupId	String	True			Identifier for the associated email campaign group.
DeletedAt	String	True			The date and time the email was deleted at, in ISO8601 representation.
ActiveDomain	String	False			The active domain of the email.
Campaign	String	False		True	The campaign GUID on the email.
Subcategory	String	False			The email subcategory. Accepted values https://developers.hubspot.com/docs/api-reference/marketing-marketing-emails-v3-v3/marketing-emails/post-marketing-v3-emails-#body-subcategory
CampaignName	String	True			The name of the campaign.
SendOnPublish	Boolean	False			Determines whether the email will be sent immediately on publish.
ContentPlainTextVersion	String	False			Content related data ContentPlainTextVersion.
ContentTemplatePath	String	False			Content related data ContentTemplatePath.
ContentSmartFields	String	False			Content related data ContentSmartFields.
ContentThemeSettingsValues	String	False			Content related data ContentThemeSettingsValues.
ContentFlexAreas	String	False			Content related data ContentFlexAreas.
ContentWidgets	String	False			Content related data ContentWidgets.
ContentWidgetContainers	String	False			Content related data ContentWidgetContainers.
StyleSettingsEmailBodyPadding	String	False			Content StyleSettings related data StyleSettingsEmailBodyPadding.
StyleSettingsBodyColor	String	False			Content StyleSettings related data StyleSettingsBodyColor.
StyleSettingsBackgroundImage	String	False			Content StyleSettings related data StyleSettingsBackgroundImage.
StyleSettingsEmailBodyWidth	String	False			Content StyleSettings related data StyleSettingsEmailBodyWidth.
StyleSettingsSecondaryFont	String	False			Content StyleSettings related data StyleSettingsSecondaryFont.
StyleSettingsPrimaryAccentColor	String	False			Content StyleSettings related data StyleSettingsPrimaryAccentColor.
StyleSettingsSecondaryFontColor	String	False			Content StyleSettings related data StyleSettingsSecondaryFontColor.
StyleSettingsPrimaryFontLineHeight	String	False			Content StyleSettings related data StyleSettingsPrimaryFontLineHeight.
StyleSettingsSecondaryFontLineHeight	String	False			Content StyleSettings related data StyleSettingsSecondaryFontLineHeight.
StyleSettingsColorPickerFavorite1	String	False			Content StyleSettings related data StyleSettingsColorPickerFavorite1.
StyleSettingsColorPickerFavorite2	String	False			Content StyleSettings related data StyleSettingsColorPickerFavorite2.
StyleSettingsColorPickerFavorite3	String	False			Content StyleSettings related data StyleSettingsColorPickerFavorite3.
StyleSettingsColorPickerFavorite4	String	False			Content StyleSettings related data StyleSettingsColorPickerFavorite4.
StyleSettingsColorPickerFavorite5	String	False			Content StyleSettings related data StyleSettingsColorPickerFavorite5.
StyleSettingsColorPickerFavorite6	String	False			Content StyleSettings related data StyleSettingsColorPickerFavorite6.
StyleSettingsBodyBorderColor	String	False			Content StyleSettings related data StyleSettingsBodyBorderColor.
StyleSettingsBodyBorderWidth	Int	False			Content StyleSettings related data StyleSettingsBodyBorderWidth.
StyleSettingsBackgroundColor	String	False			Content StyleSettings related data StyleSettingsBackgroundColor.
StyleSettingsSecondaryAccentColor	String	False			Content StyleSettings related data StyleSettingsSecondaryAccentColor.
StyleSettingsPrimaryFontSize	Int	False			Content StyleSettings related data StyleSettingsPrimaryFontSize.
StyleSettingsSecondaryFontSize	Int	False			Content StyleSettings related data StyleSettingsSecondaryFontSize.
StyleSettingsPrimaryFontColor	String	False			Content StyleSettings related data StyleSettingsPrimaryFontColor.
StyleSettingsPrimaryFont	String	False			Content StyleSettings related data StyleSettingsPrimaryFont.
StyleSettingsBodyBorderColorChoice	String	False			Content StyleSettings related data StyleSettingsBodyBorderColorChoice.
StyleSettingsBackgroundImageType	String	False			Content StyleSettings related data StyleSettingsBackgroundImageType.
StyleSettingsHeadingOneFont	String	False			Content StyleSettings related data StyleSettingsHeadingOneFont.
StyleSettingsHeadingTwoFont	String	False			Content StyleSettings related data StyleSettingsHeadingTwoFont.
StyleSettingsLinksFont	String	False			Content StyleSettings related data StyleSettingsLinksFont.
StyleSettingsButtonStyleSettings	String	False			Content StyleSettings related data StyleSettingsButtonStyleSettings.
StyleSettingsDividerStyleSettings	String	False			Content StyleSettings related data StyleSettingsDividerStyleSettings.
StatsDeviceBreakdown	String	False			Breakdown of statistics by device type.
StatsQualifierStats	String	False			Statistics related to qualifiers or filters.
StatsCounters	String	False			Basic counter-based statistics StatsCounters.
StatsRatios	String	False			Ratio-based statistics such as open or click rates.
FromCustomReplyTo	String	False			The reply to recipients will see.
FromFromName	String	False			The name recipients will see.
FromReplyTo	String	False			The from address and reply to email address (if no customReplyTo defined) recipients will see.
WebversionDomain	String	False			Webversion related data WebversionDomain.
WebversionRedirectToPageId	String	False			Webversion related data WebversionRedirectToPageId.
WebversionIsPageRedirected	Boolean	False			Webversion related data WebversionIsPageRedirected.
WebversionRedirectToUrl	String	False			Webversion related data WebversionRedirectToUrl.
WebversionTitle	String	False			Webversion related data WebversionTitle.
WebversionMetaDescription	String	False			Webversion related data WebversionMetaDescription.
WebversionPageExpiryEnabled	Boolean	False			Webversion related data WebversionPageExpiryEnabled.
WebversionEnabled	Boolean	False			Webversion related data WebversionEnabled.
WebversionSlug	String	False			Webversion related data WebversionSlug.
WebversionUrl	String	False			Webversion related data WebversionUrl.
WebversionExpiresAt	String	False			Webversion related data WebversionExpiresAt.
RssDataBlogImageMaxWidth	Int	False			RSS related data BlogImageMaxWidth.
RssDataBlogEmailType	String	False			RSS related data RssDataBlogEmailType.
RssDataHubspotBlogId	String	False			RSS related data RssDataHubspotBlogId.
RssDataRssEntryTemplate	String	False			RSS related data RssDataRssEntryTemplate.
RssDataMaxEntries	Int	False			RSS related data RssDataMaxEntries.
RssDataUseHeadlineAsSubject	Boolean	False			RSS related data RssDataUseHeadlineAsSubject.
RssDataBlogLayout	String	False			RSS related data RssDataBlogLayout.
RssDataUrl	String	False			RSS related data RssDataUrl.
RssDataTiming	String	False			RSS related data RssDataTiming.
ToLimitSendFrequency	Boolean	False			Controls whether to limit the send frequency for recipients.
ToSuppressGraymail	Boolean	False			Controls whether to suppress graymail (low engagement) recipients.
ToContactLists	String	False			Data structure representing lists of IDs that should be included and excluded.
ToContactIds	String	False			Data structure representing lists of IDs that should be included and excluded.
ToContactIlsLists	String	False			Data structure representing lists of IDs that should be included and excluded.
TestingAbSamplingDefault	String	False			Version of the email that should be sent if the results are inconclusive after the test period, master or variant.
TestingAbSampleSizeDefault	String	False			Version of the email that should be sent if there are too few recipients to conduct an AB test.
TestingAbStatus	String	False			Status of the AB test.
TestingAbTestPercentage	Int	False			The size of your test group.
TestingHoursToWait	Int	False			Time limit on gathering test results. After this time is up, the winning version will be sent to the remaining contacts.
TestingTestId	String	False			The ID of the AB test.
TestingAbSuccessMetric	String	False			Metric to determine the version that will be sent to the remaining contacts.
TestingIsAbVariation	Boolean	False			Metric to determine tif it is an AbVariation.
SubscriptionDetailsOfficeLocationId	String	False			ID of the selected office location.
SubscriptionDetailsPreferencesGroupId	String	False			ID of the preferences group associated with the subscription.
SubscriptionDetailsSubscriptionId	String	False			ID of the subscription.
SubscriptionDetailsSubscriptionName	String	False			Name of the subscription.

MeetingAssociations

Returns object IDs associated with specific meeting records, enabling meeting-related CRM associations.

Table Specific Information

SELECT

Note: You cannot reference custom objects by base name. When querying MeetingAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		False	Unique identifier of the meeting record.
AssociationId [KEY]	Long	False		False	Unique identifier of the object associated with this meeting, such as a contact or deal.
Type [KEY]	String	False		True	Type of the object associated with the meeting, such as contact, deal, or company.

MeetingProperties

Retrieves available property fields associated with meeting records for meeting data management.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the meeting property. Must start with a lowercase letter and include only lowercase letters and numbers.
Label	String	False		False	User-facing label for the meeting property, shown in the HubSpot interface.
FieldType	String	False		False	Type of UI input element used to display the property, such as text, dropdown, or date picker.
Type	String	False		False	Underlying data type used to store the property's value, such as string, number, or datetime.
GroupName	String	False		False	Name of the property group that this meeting property belongs to in HubSpot.
Description	String	False		False	Description explaining the purpose or function of the meeting property.
DisplayOrder	Int	False		False	Display order of this property within its group, used to organize the interface layout.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are managed externally rather than within HubSpot.
IsFormField	Bool	False		False	Indicates whether this property can be used as a field in a form.
IsCalculated	Bool	False		False	Indicates whether this property value is automatically calculated based on other data.
IsHidden	Bool	False		False	Indicates whether the property is hidden from the standard HubSpot UI.
IsHubspotDefined	Bool	False		False	Indicates whether the property was defined by HubSpot as part of the core schema.
Archivable	Bool	False		False	Indicates whether the property can be archived and removed from active use.
ReadOnlyDefinition	Bool	False		False	Indicates whether the structure and configuration of the property are locked from changes.
ReadOnlyValue	Bool	False		False	Indicates whether the value of this property is read-only and cannot be changed manually.
OptionsAggregate	String	False		False	List of available options for the property, if it uses a multiple-choice format such as radio or checkbox.
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

NoteAssociations

Lists object IDs associated with specific notes, supporting associations of notes to other CRM objects.

Table Specific Information

SELECT

Note: You cannot reference custom objects by base name. When querying NoteAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		False	Unique identifier of the note record.
AssociationId [KEY]	Long	False		False	Unique identifier of the object associated with this note, such as a contact, deal, or company.
Type [KEY]	String	False		True	Type of the object associated with the note, such as contact, deal, or company.

NoteProperties

Retrieves all available property fields for notes, useful for managing note metadata.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the note property. Must begin with a lowercase letter and contain only lowercase letters and numbers.
Label	String	False		False	Display name for the note property, visible to users in the HubSpot interface.
FieldType	String	False		False	Type of UI control used to enter or display the property's value, such as text, date picker, or dropdown.
Type	String	False		False	Underlying data type used to store the property's value, such as string, number, or boolean.
GroupName	String	False		False	Name of the property group to which this note property belongs.
Description	String	False		False	Explanation of the purpose and intended use of the property.
DisplayOrder	Int	False		False	Numerical value that determines the order in which this property appears relative to others in the same group.
ExternalOptions	Bool	False		False	Indicates whether the options for this property are managed from an external source.
IsFormField	Bool	False		False	Indicates whether this property can be included in forms.
IsCalculated	Bool	False		False	Indicates whether the value of the property is calculated automatically.
IsHidden	Bool	False		False	Indicates whether the property is hidden from standard views in the HubSpot interface.
IsHubspotDefined	Bool	False		False	Indicates whether the property is a standard field created by HubSpot.
Archivable	Bool	False		False	Indicates whether this property can be archived if no longer in use.
ReadOnlyDefinition	Bool	False		False	Indicates whether the configuration of this property can be edited.
ReadOnlyValue	Bool	False		False	Indicates whether the property's value is read-only and cannot be manually changed.
OptionsAggregate	String	False		False	List of predefined options available for this property if it is a choice field such as checkbox or radio.
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

OrderAssociations

Returns object IDs associated with specific orders, supporting both OAuth and private-app token authentications.

Table Specific Information

SELECT

Note: You cannot reference custom objects by base name. When querying OrderAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	Orders.Id	False	Unique identifier of the order record.
AssociationId [KEY]	Long	False		False	Unique identifier of the object associated with this order, such as a contact or deal.
Type [KEY]	String	False		True	Type of the object associated with the order, such as contact, deal, or company.

OrderPipelines

Provides pipelines configured for managing orders, useful for order processing workflows.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for the order pipeline.
Label	String	False		False	Human-readable name of the order pipeline displayed in the HubSpot interface.
Archived	Bool	True		False	Indicates whether the pipeline is archived and no longer active.
CreatedAt	Datetime	True		False	Timestamp marking when the order pipeline was created.
UpdatedAt	Datetime	True		False	Timestamp marking when the order pipeline was last modified.
DisplayOrder	Int	False		False	Position of this pipeline relative to others in the list, used for sorting and display.
StagesAggregate	String	False		False	List of all stages included in this pipeline. For detailed stage information, see the OrderPipelineStages table.

OrderPipelineStages

Lists stages within order pipelines, representing steps in the order lifecycle.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for the stage within the order pipeline.
PipelineId [KEY]	String	False	OrderPipelines.Id	False	Identifier of the pipeline to which this stage belongs.
Label	String	False		False	Human-readable name of the pipeline stage displayed in the HubSpot interface.
PipelineLabel	String	True	OrderPipelines.Label	False	Name of the pipeline that includes this stage.
IsClosed	Bool	False		False	Indicates whether this stage is considered closed in the pipeline process.
State	String	False		False	Current status of the stage, such as open or closed.
Archived	Bool	True		False	Indicates whether the stage has been archived and is no longer in active use.
CreatedAt	Datetime	True		False	Timestamp indicating when the stage was created.
UpdatedAt	Datetime	True		False	Timestamp indicating when the stage was last modified.
DisplayOrder	Int	False		False	Numeric order in which this stage appears relative to others within the same pipeline.

OrderProperties

Retrieves all properties associated with orders, including standard and custom fields.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the order property. Must begin with a lowercase letter and include only lowercase letters and numbers.
Label	String	False		False	User-friendly label for the property as it appears in the HubSpot interface.
FieldType	String	False		False	UI input type used to display the property, such as text field, dropdown, or date picker.
Type	String	False		False	Underlying data type used to store the property's value, such as string, number, or datetime.
GroupName	String	False		False	Name of the property group this field belongs to within the order object.
Description	String	False		False	Explanation of the property's purpose and how it is used.
DisplayOrder	Int	False		False	Numeric value that determines this property's position relative to others in its group.
ExternalOptions	Bool	False		False	Indicates whether selectable options for this property are managed externally from HubSpot.
IsFormField	Bool	False		False	Indicates whether the property can be used as a field on a form.
IsCalculated	Bool	False		False	Indicates whether the property's value is derived from calculations rather than manually entered.
IsHidden	Bool	False		False	Indicates whether the property is hidden from standard views in the user interface.
IsHubspotDefined	Bool	False		False	Indicates whether the property was created by HubSpot as part of the standard object model.
Archivable	Bool	False		False	Indicates whether the property can be archived and removed from active use.
ReadOnlyDefinition	Bool	False		False	Indicates whether the property's configuration (such as name or type) is locked from editing.
ReadOnlyValue	Bool	False		False	Indicates whether the property's value is read-only and cannot be modified by users.
OptionsAggregate	String	False		False	List of possible options for the property, used if the field type supports selectable values such as checkboxes or radio buttons.
HasUniqueValue	Bool	False		False	Indicates whether the property must contain a unique value across all order records.

OrderPropertyGroups

Provides access to groups used to organize order properties logically.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the order property group used to organize related properties.
Label	String	False		False	Human-readable label for the property group displayed in the HubSpot interface.
DisplayOrder	Int	False		False	Position of the group relative to others, used to determine the display order in the UI.

Orders

Lists all orders in HubSpot, with support for OAuth and private-app token authentication.

Table Specific Information

In HubSpot, order records store information about ecommerce purchases.

SELECT

When selecting orders, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Orders;
SELECT * FROM Orders WHERE [Id] = '385815394826';
SELECT * FROM Orders WHERE [Discount] = 10 OR [Exchange rate] = 1.5;

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Orders WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Orders WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Orders WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Orders WHERE ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value})

INSERT

INSERT INTO Orders ([Currency Code]) VALUES ('INR')
INSERT INTO Orders ([Currency Code], [Exchange rate], [Created Date]) VALUES ('USD', 1.6, '2024-12-14 18:30:00.000'), ('ALL', 160.3, '2024-11-14 18:30:00.000')

UPDATE

UPDATE Orders SET [Exchange rate] = '2.5' WHERE ID = '3917882265'

DELETE

DELETE FROM Orders WHERE ID = '3917882265'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier assigned to the order record in HubSpot.
Archived	Bool	True		False	Indicates whether the order is archived and no longer active.
CreatedAt	Datetime	True		False	Timestamp marking when the order was first created in the system.
UpdatedAt	Datetime	True		False	Timestamp marking when the order was most recently updated.
All teams	String	True		True	List of team IDs, including inherited teams, associated with ownership properties for this order.
Business units	String	False		True	Business units to which this order record is assigned.
All owner ids	String	True		True	All user IDs assigned as owners of the order, including default and custom ownership fields.
All team ids	String	True		True	List of team IDs directly associated with owner properties on the order.
Billing City	String	False		True	City specified in the billing address of the order.
Billing Country	String	False		True	Country specified in the billing address of the order.
Billing Email	String	False		True	Email address provided by the customer in the billing information.
Billing First Name	String	False		True	Customer's first name from the billing address.
Billing Last Name	String	False		True	Customer's last name from the billing address.
Billing Phone Number	String	False		True	Phone number provided for the billing address.
Billing ZIP/Postal Code	String	False		True	ZIP or postal code provided in the billing address.
Billing State	String	False		True	State or province listed in the billing address.
Billing Street	String	False		True	Street address entered for billing purposes.
Buyer Accepts Marketing	Bool	False		True	Indicates whether the customer has opted in to receive marketing emails.
Cancellation Reason	String	False		True	Reason provided for canceling the order, if available.
Closed Date	Datetime	True		True	Date and time when the order was marked as closed. Automatically populated if applicable.
Created by user ID	Decimal	True		True	HubSpot user ID of the individual who created the order. Automatically managed by the system.
Object create date/time	Datetime	True		True	Date and time when the order object was created. Automatically populated by HubSpot.
Currency Code	String	False		True	Three-letter currency code used for the order, such as USD or EUR.
Customer Phone	String	False		True	Phone number provided by the customer placing the order.
Date entered Stage 1 (Pipeline 1)	Datetime	True		True	Timestamp when the order entered the 'Stage 1' stage in 'Pipeline 1'.
Date exited Stage 1 (Pipeline 1)	Datetime	True		True	Timestamp when the order exited the 'Stage 1' stage in 'Pipeline 1'.
Discount Codes	String	False		True	List of discount codes applied to the order, if any.
Exchange rate	Decimal	False		True	Exchange rate used to convert the order amount into the company's home currency.
Canceled Date	Datetime	False		True	Date and time when the order was officially canceled.
Cart ID	String	False		True	Identifier for the cart associated with the order in an external commerce platform.
Checkout ID	String	False		True	Identifier for the checkout session associated with the order in an external system.
Created Date	Datetime	False		True	Original date when the order was created. May differ from when it was imported into HubSpot.
Modified Date	Datetime	False		True	Most recent date and time when the order record was modified in the source system.
Order ID	String	False		True	Identifier for the order in an external system such as Shopify or WooCommerce.
Status	String	False		True	Current status of the order, such as pending, fulfilled, or canceled.
Order URL	String	False		True	URL linking to the order's detail page in the external commerce platform.
Fulfillment Status	String	False		True	Current fulfillment status of the order, such as fulfilled, partially fulfilled, or unfulfilled.
Amount in company currency	Decimal	False		True	Total order amount converted to your company's currency using the specified exchange rate.
Landing Site	String	False		True	URL of the first page the customer landed on before placing the order.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any update to the order, including internal property changes.
Merged record IDs	String	True		True	List of record IDs that have been merged into this order. Automatically generated by HubSpot.
Record ID	Decimal	True		True	HubSpot-assigned unique identifier for this order record.
Record Creation Source	String	True		True	Internal source indicator of how the record was originally created, such as API, import, or form submission.
Record Source Detail 1	String	True		True	First-level detail about the origin of this order record, such as form name or integration name.
Record Source Detail 2	String	True		True	Second-level detail about how the order record was created.
Record Source Detail 3	String	True		True	Third-level detail about how the order record was created.
Record Creation Source ID	String	True		True	Internal ID referencing the system or tool that created this order record.
Record Source	String	True		True	Description of the method or system that created the order record.
Record Creation Source User ID	Decimal	True		True	User ID associated with the creation of this record if created manually or via user-authored import.
Discount	Decimal	False		True	Total discount applied to the order as a monetary value.
Name	String	False		True	Unique order number used as the primary display name of the order.
Notes	String	False		True	Freeform text field for internal notes or comments related to the order.
Payment Processing Method	String	False		True	Type of payment method used for processing the order, such as credit card or PayPal.
Payment Status	String	False		True	Current payment status of the order, such as paid, pending, or refunded.
Pinned engagement ID	Decimal	False		True	ID of the engagement (such as a note or email) currently pinned to the order.
Pipeline	String	False		True	Name of the order pipeline that contains this order.
Stage	String	False		True	Stage within the pipeline that the order currently resides in.
Processed Date	Datetime	False		True	Date and time when the order was processed and imported into HubSpot.
Read Only Object	Bool	True		True	Indicates whether the order is read-only and cannot be edited.
Referring Site	String	False		True	URL of the website that referred the customer to the seller's site before placing the order.
Refund Amount	Decimal	False		True	Total amount refunded to the customer, if applicable.
Shared Team IDs	String	True		True	List of team IDs that have shared access to the order record.
Shared User IDs	String	True		True	List of user IDs that have shared access to the order record.
Shipping City	String	False		True	City entered in the shipping address of the order.
Shipping Country	String	False		True	Country listed in the shipping address.
Shipping Phone Number	String	False		True	Phone number entered in the shipping address.
Shipping ZIP/Postal Code	String	False		True	ZIP or postal code used in the shipping address.
Shipping State	String	False		True	State or region specified in the shipping address.
Shipping Street	String	False		True	Street address for shipping the order.
Shipping Cost	Decimal	False		True	Base cost of shipping, in the currency associated with the order, excluding discounts.
Shipping Status URL	String	False		True	URL where the shipping or delivery status of the order can be tracked.
Shipping Tracking Number	String	False		True	Tracking number(s) associated with the shipment of the order.
Source ID	Decimal	True		True	HubSpot developer app ID or source system ID where the order originated.
Source Store	String	False		True	Identifier for the storefront or ecommerce system where the order was placed.
Subtotal Price	Decimal	False		True	Total amount of the order before discounts, taxes, shipping, or duties.
Tags	String	False		True	List of tag values applied to this order for segmentation or categorization.
Tax Price	Decimal	False		True	Total tax amount applied to the order, including applicable duties.
Time in Stage 1 (Pipeline 1)	Decimal	True		True	Total time in seconds that the order remained in the 'Stage 1' stage of 'Pipeline 1'.
Total Price	Decimal	False		True	Grand total for the order, including product cost, tax, shipping, and adjustments.
Total Weight	String	False		True	Combined shipping weight of all items in the order.
Unique creation key	String	True		True	Unique key used to prevent duplicate order creation during automated or batch processes.
Updated by user ID	Decimal	True		True	User ID of the individual who last modified this order. Automatically set by HubSpot.
User IDs of all notification followers	String	True		True	List of user IDs who opted in to receive notifications about changes to this order.
User IDs of all notification unfollowers	String	True		True	List of owner user IDs who opted out of receiving notifications for this order.
User IDs of all owners	String	True		True	List of all users assigned as owners of this order record.
Performed in an import	Bool	True		True	Indicates whether the order was created as part of a bulk import.
Owner Assigned Date	Datetime	True		True	Timestamp of the most recent owner assignment on the order. Automatically tracked by HubSpot.
Owner	String	False		True	Current owner of the order as recorded in HubSpot.
HubSpot Team	String	True		True	Primary HubSpot team associated with the order owner.

PostalMailProperties

Retrieves all property fields associated with postal mails, enabling management of postal mail records.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	The name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		False	The human readable label for the property that will display in the HubSpot UI.
FieldType	String	False		False	The type of field that will display on the screen for the property.
Type	String	False		False	The stored machine type for the property.
GroupName	String	False		False	The group that the property is a part of.
Description	String	False		False	A description of what the property is for.
DisplayOrder	Int	False		False	The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Bool	False		False	Boolean indicating whether there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating whether the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating whether the property is calculated.
IsHidden	Bool	False		False	Boolean indicating whether the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating whether the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating whether the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating whether the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating whether the value of the property is read only.
OptionsAggregate	String	False		False	An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

PostalMails

Lists all postal mail records in HubSpot, used for tracking postal communication.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
Properties	String	True		False	An aggregate of the properties defined for a given object type.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
AtMentioned Owner Ids	String	False		False	The owners that have been at-mentioned on the engagement.
Attached file IDs	String	False		False	The IDs of the files that are attached to the postal mail.
Body preview	String	True		True	A truncated preview of the engagement body.
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview.
Body Preview Truncated	Bool	True		True	Indicates whether the engagement body was truncated for the preview.
Activity created by	Decimal	True		True	The user who created the postal mail.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Engagement Source	String	False		True	The source that created this engagement.
Engagement Source ID	String	False		True	The specific ID of the process that created this engagement.
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Updated by	Decimal	True		True	The user who last updated the postal mail.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	The method in which this record was initially created in the system.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Postal Mail Body	String	False		True	The body text of the postal mail.
Postal Mail Type	String	False		False	The category of postal mail, as defined by the user.
Queue Memberships	String	False		False	The list of queues that contain this engagement.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	True		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	True		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Activity date	Datetime	False		True	The date that an engagement occurred.
Unique creation key	String	True		True	The unique property used for idempotent creates.
Unique ID	String	False		True	The unique ID of the engagement.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	The object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

ProductAssociations

Returns object IDs associated with specific product records, supporting product associations.

Table Specific Information

SELECT

Note: You cannot reference custom objects by base name. When querying ProductAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	Products.Id	False	Unique identifier for the product association record.
AssociationId [KEY]	Long	False		False	Unique identifier of the object associated with this product, such as a deal or quote.
Type [KEY]	String	False		True	Type of the associated object, such as contact, deal, or quote.

ProductProperties

Retrieves all available product property fields, including standard and custom fields.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the product property. Must start with a lowercase letter and contain only lowercase letters and numbers.
Label	String	False		False	User-facing label that appears for the product property in the HubSpot interface.
FieldType	String	False		False	Type of input field displayed for the property, such as text, dropdown, or date picker.
Type	String	False		False	Underlying machine data type used to store the property value, such as string, number, or boolean.
GroupName	String	False		False	Name of the group that organizes this property within the product object.
Description	String	False		False	Explanation of the purpose and usage of the property.
DisplayOrder	Int	False		False	Numeric value that determines the display order of the property within its group.
ExternalOptions	Bool	False		False	Indicates whether the property options are sourced externally rather than defined within HubSpot.
IsFormField	Bool	False		False	Indicates whether the property can be used in forms for data collection.
IsCalculated	Bool	False		False	Indicates whether the property's value is automatically calculated based on other properties.
IsHidden	Bool	False		False	Indicates whether the property is hidden from standard user views in the interface.
IsHubspotDefined	Bool	False		False	Indicates whether the property was created by HubSpot as part of the default object schema.
Archivable	Bool	False		False	Indicates whether the property can be archived when no longer needed.
ReadOnlyDefinition	Bool	False		False	Indicates whether the configuration of the property (such as name or type) is locked from editing.
ReadOnlyValue	Bool	False		False	Indicates whether the value of the property is read-only and cannot be modified.
OptionsAggregate	String	False		False	List of selectable options available for the property if the field type supports multiple choices, such as radio buttons or checkboxes.
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

Products

Lists all product records configured in HubSpot, supporting both OAuth and private-app token authentications.

Table Specific Information

In HubSpot, products represent the goods or services you sell. Building a product library allows you to quickly add products to deals, generate quotes, and report on product performance.

SELECT

When selecting products, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Products
SELECT * FROM Products WHERE [Created by user ID] = 4465089 AND [Product price] > 250
SELECT * FROM Products WHERE [Created by user ID] = 4465089 OR [Created by user ID] = 4465090

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Products WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Products WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Products WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Products WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO Products ([Product description]) VALUES ('description')

UPDATE

UPDATE Products SET [Product description] = 'new description' WHERE ID = '75229453'

DELETE

DELETE FROM Products WHERE ID = '75229453'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier assigned to the product record in HubSpot.
Archived	Bool	True		False	Indicates whether the product is archived and no longer active.
CreatedAt	Datetime	True		False	Timestamp when the product was first created.
UpdatedAt	Datetime	True		False	Timestamp when the product was last updated.
Net price	Decimal	True		True	Internal placeholder to avoid conflicts with line item property of the same name.
Create Date	Datetime	False		True	Date when the product record was created.
Product description	String	False		True	Full descriptive text providing details about the product.
Unit discount	Decimal	False		True	Amount of discount applied per unit of the product.
All accessible team IDs	String	True		True	List of team IDs, including inherited teams, associated with ownership of the product.
Business units	String	False		True	Business units to which this product record is assigned.
All owner ids	String	True		True	User IDs assigned as owners of the product, including default and custom ownership fields.
All team ids	String	True		True	Team IDs associated with all ownership properties for this product.
Avatar FileManager key	String	True		True	Path to the product's image in the HubSpot FileManager CDN. Set automatically by HubSpot.
Unit cost	Decimal	False		True	Cost to the HubSpot customer for each unit of the product.
Created by user ID	Decimal	True		True	User ID of the individual who created the product record. Set automatically by HubSpot.
Object create date_time	Datetime	True		True	Datetime when the product object was created. Managed automatically by HubSpot.
Discount Percentage	Decimal	False		True	Percentage discount applied to the product price.
Folder Id	Decimal	False		True	ID of the folder where the product is organized within the HubSpot system.
Image Url	String	False		True	URL pointing to images associated with the product.
Last Modified Date	Datetime	True		True	Datetime of the most recent update to any property of the product.
Merged object IDs	String	True		True	List of product record IDs that have been merged into this record. Managed automatically by HubSpot.
Record ID	Decimal	True		True	HubSpot-generated unique ID for the product record.
Product Type	String	False		True	Categorization of the product such as Inventory, Non-Inventory, or Service.
Read Only Object	Bool	True		True	Indicates whether the product record is locked and cannot be edited.
Term	String	False		True	Duration of recurring billing terms for the product if applicable.
Start Date	Date	False		True	Start date for recurring billing for this product.
SKU	String	False		True	Unique stock keeping unit (SKU) identifier for the product.
Unique creation key	String	True		True	Unique property used to ensure idempotent creation of the product record.
Updated by user ID	Decimal	True		True	User ID of the last person who updated this product record.
URL	String	False		True	URL linking to the product's detailed page or resource.
User IDs of all notification followers	String	True		True	User IDs of all users who opted in to follow updates for this product.
User IDs of all notification unfollowers	String	True		True	User IDs of owners who opted out of receiving notifications for this product.
User IDs of all owners	String	True		True	List of user IDs assigned as owners of this product.
Owner Assigned Date	Datetime	True		True	Timestamp of the most recent owner assignment for the product. Set automatically by HubSpot.
Owner	String	False		True	Current owner of the product record.
HubSpot Team	String	True		True	Primary HubSpot team associated with the owner of the product.
Name	String	False		True	Name of the product.
Unit price	Decimal	False		True	Price per unit of the product.
Quantity	Decimal	True		True	Internal placeholder to avoid conflicts with line item property of the same name.
Recurring billing frequency	String	False		True	Frequency with which the product is billed if it uses recurring billing.
Tax	Decimal	False		True	Tax amount applied to the product price.

QuoteAssociations

Lists object IDs associated with specific quotes, enabling management of quote associations.

Table Specific Information

SELECT

Note: You cannot reference custom objects by base name. When querying QuoteAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	Quotes.Id	False	Unique identifier for the quote association record.
AssociationId [KEY]	Long	False		False	Identifier of the object associated with this quote, such as a deal or contact.
Type [KEY]	String	False		True	Type of the associated object, such as contact, deal, or company.

QuoteProperties

Retrieves available property fields for quotes, supporting quote record management.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the quote property. Must begin with a lowercase letter and contain only lowercase letters and numbers.
Label	String	False		False	Display label of the quote property shown in the HubSpot interface.
FieldType	String	False		False	Type of UI component used to display or enter the property value, such as text, dropdown, or checkbox.
Type	String	False		False	Underlying machine-readable data type of the property, such as string, number, or date.
GroupName	String	False		False	Name of the property group this field belongs to within the quote object.
Description	String	False		False	Explanation of the property's purpose and how it is used within the quote object.
DisplayOrder	Int	False		False	Order in which the property is displayed relative to other properties in the same group.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are defined externally rather than in HubSpot.
IsFormField	Bool	False		False	Indicates whether the property is eligible for inclusion in HubSpot forms.
IsCalculated	Bool	False		False	Indicates whether the property's value is derived from a calculation rather than entered manually.
IsHidden	Bool	False		False	Indicates whether the property is hidden from standard user views in the UI.
IsHubspotDefined	Bool	False		False	Indicates whether the property is part of HubSpot's default schema for quotes.
Archivable	Bool	False		False	Indicates whether the property can be archived and excluded from future use.
ReadOnlyDefinition	Bool	False		False	Indicates whether the property's configuration is read-only and cannot be modified.
ReadOnlyValue	Bool	False		False	Indicates whether the property's value is locked and cannot be changed manually.
OptionsAggregate	String	False		False	Aggregate of available options for choice-based fields, populated if the FieldType supports options such as radio or checkbox.
HasUniqueValue	Bool	False		False	Indicates whether each quote is required to have a unique value for this property.

Quotes

Lists all quotes in HubSpot, useful for managing proposals and sales offers.

Table Specific Information

In HubSpot, quotes are used to share pricing information with potential buyers.

SELECT

When selecting quotes, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Quotes
SELECT * FROM Quotes WHERE [Sender company city] = 'San Francisco' AND [Quote amount] > 1000
SELECT * FROM Quotes WHERE [Sender company city] = 'San Francisco' OR [Sender company city] = 'Los Angeles'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Quotes WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Quotes WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Quotes WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Quotes WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO Quotes ([Quote Title]) VALUES ('title')

UPDATE

UPDATE Quotes SET [Quote Title] = 'new title' WHERE ID = '75229453'

DELETE

DELETE FROM Quotes WHERE ID = '75229453'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier assigned to the quote record.
Archived	Bool	True		False	Indicates whether the quote record is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp marking when the quote was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the quote record.
Business units	String	False		True	Business units to which this quote record is assigned.
Allowed Payment Methods	String	False		True	Accepted forms of payment if the quote uses HubSpot Payments.
Quote Approver	String	False		True	Name or identifier of the individual who approved the quote, if applicable.
Collect Billing Address	Bool	False		True	Indicates whether the billing address should be collected with this quote.
Created by user ID	Decimal	True		True	User ID of the individual who created the quote. Set automatically by HubSpot.
Create date	Datetime	True		True	Date when the quote was created.
Quote Domain	String	False		True	Domain from which this quote will be served publicly.
ESign Date	Datetime	True		True	Timestamp when all required parties completed electronic signing of the quote.
Expiration Template Path	String	False		True	Internal path to the expiration template associated with the quote.
Quote approval feedback	String	False		True	Feedback submitted during the approval process for the quote.
Language	String	False		True	Language in which the quote is displayed publicly.
Last modified date	Datetime	True		True	Date and time when any property on the quote was last modified.
Global Term Line Item Discount Percentage	String	False		True	Internal HubSpot value representing the global discount percentage applied to line items.
Global Term Line Item Discount Percentage Enabled	Bool	False		True	Indicates whether the global discount percentage is enabled for this quote.
Global Term Line Item Recurring Billing Period	String	False		True	Internal HubSpot value representing the global recurring billing duration for line items.
Global Term Line Item Recurring Billing Period Enabled	Bool	False		True	Indicates whether the global recurring billing period is enabled for this quote.
Global Term Line Item Recurring Billing Start Date	String	False		True	Internal HubSpot value representing the global recurring billing start date for line items.
Global Term Line Item Recurring Billing Start Date Enabled	Bool	False		True	Indicates whether the global recurring billing start date is enabled for this quote.
Global Term Line Item Recurring Billing Frequency	String	False		True	Internal HubSpot value representing how often recurring billing occurs for line items.
Global Term Line Item Recurring Billing Frequency Enabled	Bool	False		True	Indicates whether the global recurring billing frequency is enabled for this quote.
Locale	String	False		True	Locale settings used to display the quote publicly, such as date formats and number formatting.
Locked	Bool	True		True	Indicates whether the quote is locked to prevent further edits.
Merged object IDs	String	True		True	List of object IDs that were merged into this quote record. Managed automatically by HubSpot.
Record ID	Decimal	True		True	Unique HubSpot-generated identifier for the quote record.
Payment date	Datetime	True		True	Date when the quote was paid by the customer, if applicable.
Payment Status	String	True		True	Current payment status of the quote, such as Paid or Pending.
Payment Type	String	False		True	Payment method used for the quote, if payment is enabled.
Quote PDF download link	String	True		True	Direct download link to the PDF version of the quote.
Proposal Domain	String	True		True	Domain from which this proposal document will be served publicly.
Proposal Slug	String	True		True	URL path segment used to serve the proposal document.
Proposal Template	String	False		True	Template path used to render the proposal associated with this quote.
Public URL key	String	True		True	Security key used for accessing the quote's public URL.
Quote Total Preference	String	False		True	The property from the line items that determines the quote's total amount.
Read Only Object	Bool	True		True	Indicates whether the quote record is set as read-only.
Sender image URL	String	False		True	URL of the sender's avatar image displayed on the quote.
Quote Slug	String	False		True	URL path segment used to serve the quote publicly.
Template Type	String	False		True	Indicates whether the quote uses a default HubSpot template for rendering.
Test mode	Bool	False		True	Indicates whether the quote is in test mode for non-production purposes.
Unique creation key	String	True		True	Unique property used to ensure idempotent creation of the quote record.
Updated by user ID	Decimal	True		True	User ID of the individual who last updated the quote. Set automatically by HubSpot.
User IDs of all notification followers	String	True		True	List of user IDs who opted in to receive notifications about updates to this quote.
User IDs of all notification unfollowers	String	True		True	List of owner user IDs who opted out of receiving notifications about this quote.
User IDs of all owners	String	True		True	List of user IDs who are owners of the quote.
Owner assigned date	Datetime	True		True	Date when an owner was last assigned to the quote. Set automatically by HubSpot.
Sender company name	String	False		True	Name of the company sending the quote.
Sender first name	String	False		True	First name of the person sending the quote.
Quote title	String	False		True	Title or headline given to the quote.
Expiration date	Datetime	False		True	Date when the quote expires and is no longer valid.
Sender company domain	String	False		True	Domain name of the company sending the quote.
Sender last name	String	False		True	Last name of the person sending the quote.
Comments to buyer	String	False		True	Optional comments provided to the buyer along with the quote.
Sender company street address	String	False		True	Street address of the company sending the quote.
Sender email	String	False		True	Email address of the person sending the quote.
Sender company street address 2	String	False		True	Additional address line for the company sending the quote, such as suite or apartment number.
Sender phone number	String	False		True	Phone number of the person sending the quote.
Terms	String	False		True	Terms and conditions, including pricing, purchasing terms, or master agreements associated with the quote.
Logo URL	String	False		True	URL of the logo image displayed on the quote document.
Sender company city	String	False		True	City where the company sending the quote is located.
Sender job title	String	False		True	Job title of the sender associated with the quote.
Sender company state_region	String	False		True	State or region where the company sending the quote is located.
Space for written signature	Bool	False		True	Indicates whether a space for a handwritten signature should be included on the quote.
Branding color	String	False		True	Primary color used for branding elements on the quote document.
Recent Sales Email Replied Date	Datetime	True		True	Date when a tracked sales email related to this quote was last replied to.
Sender company postal code	String	False		True	Postal code where the company sending the quote is located.
Space for written countersignature	Bool	False		True	Indicates whether a space for a handwritten countersignature should be included on the quote.
Quote owner	String	False		True	The HubSpot user assigned as the owner of the quote.
Last Contacted	Datetime	True		True	Date and time when the quote record was last associated with a logged call, email, or meeting.
Last Activity Date	Datetime	True		True	Date and time when the last activity (note, call, email, meeting, or task) was logged for the quote. Set automatically.
Next Activity Date	Datetime	True		True	Scheduled date for the next activity (such as a call or meeting) related to the quote.
Number of times contacted	Decimal	True		True	Total number of logged calls, emails, or meetings associated with the quote.
Number of Sales Activities	Decimal	True		True	Total number of logged sales activities, such as calls or meetings, related to the quote.
Currency	String	False		True	Currency code, such as USD or EUR, associated with the quote's financial amounts.
Sender company country	String	False		True	Country where the company sending the quote is located.
HubSpot team	String	True		True	Name of the HubSpot team associated with the owner of the quote.
All owner ids	String	True		True	List of all owner IDs, both default and custom, associated with the quote.
Sender company image URL	String	False		True	URL of the image representing the sender's company on the quote document.
Time zone	String	False		True	Time zone used to display dates and times on the quote document.
All team ids	String	True		True	List of team IDs related to all ownership fields for the quote, both default and custom.
Payment enabled	Bool	False		True	Indicates whether payments can be collected directly through the quote's public link.
All accessible team ids	String	True		True	List of all team IDs accessible through team hierarchy for ownership fields linked to the quote.
ESign enabled	Bool	False		True	Indicates whether electronic signature (eSign) functionality is enabled for the quote.
Associated Deals	Decimal	True		True	Number of deals associated with this quote. Set automatically by HubSpot.
ESign number of signers required	Decimal	True		True	Total number of signatures required for the quote to be considered fully signed.
Legacy Quote Template	String	False		True	The legacy template used to generate the quote document. These templates were sunset on December 12, 2022.
ESign completed signatures	Decimal	True		True	Number of completed electronic signatures collected so far on the quote.
Quote amount	Decimal	True		True	The total monetary value due for the quote.
Quote approval status	String	False		True	Approval status of the quote, such as Approved, Pending, or Rejected.
Quote number	String	False		True	Reference number assigned to the quote, displayed on the quote document.
Collect shipping address	Bool	False		True	Indicates whether a shipping address should be collected with this quote.

ServiceAssociations

Retrieve the IDs of all the objects associated to specific Services objects in HubSpot.

View Specific Information

ServiceAssociations retrieves the IDs of all objects associated with specific service records in HubSpot. This table shows the relationships between services and other HubSpot objects such as contacts, companies, deals, and tickets.

SELECT

When selecting service associations, you must specify the service ID to retrieve its associated objects. For example:

SELECT * FROM ServiceAssociations WHERE Id = '22222'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Services.Id	False	Services ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Services object is associated with.
Type [KEY]	String	False		False	Type of the associated object, which can be a contact, deal etc.

ServicePipelines

Pipelines of Services in HubSpot.

View Specific Information

ServicePipelines contains the pipeline configurations for service records in HubSpot. Each pipeline represents a series of stages that services can progress through.

SELECT

SELECT * FROM ServicePipelines WHERE Id = 'service-pipeline-id'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	False		False	The unique identified of the pipeline.
Label	String	False		False	The label (name) of the pipeline.
Archived	Bool	True		False	Whether the pipeline is archived or not.
CreatedAt	Datetime	True		False	When the pipeline was created.
UpdatedAt	Datetime	True		False	When the pipeline was last updated.
DisplayOrder	Int	False		False	The order of this specific pipeline in the collection of pipelines for this table.
StagesAggregate	String	False		False	An aggregate of the stages included in this pipeline. This information can be viewed in more detail in TicketPipelineStages table.

ServicePipelineStages

PipelineStages of Services in HubSpot.

View Specific Information

ServicePipelineStages contains the individual stages within service pipelines in HubSpot. Each stage represents a specific step in the service workflow process.

SELECT

SELECT * FROM ServicePipelineStages WHERE PipelineId = 'service-pipeline-id'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier of the stage in this pipeline.
PipelineId [KEY]	String	False	TicketPipelines.Id	False	Unique identifier of the pipeline.
Label	String	False		False	Label (name) of the pipeline stage.
PipelineLabel	String	True	TicketPipelines.Label	False	The label (name) of the pipeline.
IsClosed	Bool	False		False	Whether this stage is open or closed.
State	String	False		False	Current state of the pipeline stage.
Archived	Bool	True		False	Whether the stage is archived or not.
CreatedAt	Datetime	True		False	Time the stage was created.
UpdatedAt	Datetime	True		False	Time the stage was last updated.
DisplayOrder	Int	False		False	The order of the stage in the collection of stages for this pipeline.

Services

Retrieve the available Services in HubSpot.

Table Specific Information

In HubSpot, services represent professional offerings, support packages, or other service-related activities that can be tracked and managed. Service records support customer success, professional services, and ongoing engagement tracking.

SELECT

When selecting services, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Services WHERE [Total Cost] > 5000 AND [Status] = 'In Progress'
SELECT * FROM Services WHERE [Category] = 'Consulting' OR [Name] = 'Premium Support'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Services WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Services WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Services WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Services WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO Services ([Name], [Description], [Total Cost]) VALUES ('Website Maintenance', 'Monthly website maintenance and updates', 1200)

UPDATE

UPDATE Services SET [Status] = 'Completed' WHERE ID = '22222'

DELETE

DELETE FROM Services WHERE ID = '22222'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Amount paid	Decimal	False		True	What the customer has already paid.
Amount remaining	Decimal	False		True	What the customer will pay in the future.
Category	String	False		False	A drop down or multi-select field where customers can differentiate among varied offerings, such as Marketing hub onboarding and full suite onboarding.
Close date	Datetime	False		True	Date the record is
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Description	String	False		True	An explanation of the offering that is being represented.
Duration	Decimal	True		True	Calculates the time between the start date and close date. If the start date occurs after the close date, the value returned is 0. The create date and target end date will be used as fallbacks for the start date and close date respectively.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Name	String	False		True	Short-summary of the offering the record represents.
Next activity date	Datetime	True		True	The date of the next upcoming activity for a service. This property is set automatically by HubSpot based on user action. This includes logging a future call, sales email, or meeting using the Log feature, as well as creating a future task or scheduling a future meeting. This is updated automatically by HubSpot.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Owning Teams	String	False		False	The teams that are attributed to this record.
Pipeline	String	False		False	The pipeline that contains this service.
Pipeline Stage	String	False		False	The pipeline stage that contains this service.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	False		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	False		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Start date	Datetime	False		True	Date the offering starts being worked on by either the customer or the company.
Status	String	False		False	This represents how the project is tracking relative towards expectations.
Service Tags	String	True		False	List of tag ids applicable to a service. This property is set automatically by HubSpot.
Tags	String	False		False	Deal tags associated with your service.
Target duration	Decimal	True		True	Calculates the time between the start date and target date. If the start date occurs after the target date, the value returned is 0.
Target end date	Datetime	False		True	Date the offering is anticipated to be completed.
Time in 'In progress (Service Pipeline)'	Decimal	True		True	The total time in seconds spent by the service in the 'In progress' stage, 'Service Pipeline' pipeline.
Time in 'New (Service Pipeline)'	Decimal	True		True	The total time in seconds spent by the service in the 'New' stage, 'Service Pipeline' pipeline.
Time in 'Closed (Service Pipeline)'	Decimal	True		True	The total time in seconds spent by the service in the 'Closed' stage, 'Service Pipeline' pipeline.
Total cost	Decimal	False		True	The total value in US dollars of the offering.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Cumulative time in New (test)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'New' stage, 'test' pipeline.
Cumulative time in In progress (test)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'In progress' stage, 'test' pipeline.
Cumulative time in Closed (test)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'Closed' stage, 'test' pipeline.
Cumulative time in In progress (Service Pipeline)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'In progress' stage, 'Service Pipeline' pipeline.
Cumulative time in New (Service Pipeline)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'New' stage, 'Service Pipeline' pipeline.
Cumulative time in Closed (Service Pipeline)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'Closed' stage, 'Service Pipeline' pipeline.
Date entered New (test)	Datetime	True		True	The date and time when the service entered the 'New' stage, 'test' pipeline.
Date entered In progress (test)	Datetime	True		True	The date and time when the service entered the 'In progress' stage, 'test' pipeline.
Date entered Closed (test)	Datetime	True		True	The date and time when the service entered the 'Closed' stage, 'test' pipeline.
Date entered In progress (Service Pipeline)	Datetime	True		True	The date and time when the service entered the 'In progress' stage, 'Service Pipeline' pipeline.
Date entered New (Service Pipeline)	Datetime	True		True	The date and time when the service entered the 'New' stage, 'Service Pipeline' pipeline.
Date entered Closed (Service Pipeline)	Datetime	True		True	The date and time when the service entered the 'Closed' stage, 'Service Pipeline' pipeline.
Date exited New (test)	Datetime	True		True	The date and time when the service exited the 'New' stage, 'test' pipeline.
Date exited In progress (test)	Datetime	True		True	The date and time when the service exited the 'In progress' stage, 'test' pipeline.
Date exited Closed (test)	Datetime	True		True	The date and time when the service exited the 'Closed' stage, 'test' pipeline.
Date exited In progress (Service Pipeline)	Datetime	True		True	The date and time when the service exited the 'In progress' stage, 'Service Pipeline' pipeline.
Date exited New (Service Pipeline)	Datetime	True		True	The date and time when the service exited the 'New' stage, 'Service Pipeline' pipeline.
Date exited Closed (Service Pipeline)	Datetime	True		True	The date and time when the service exited the 'Closed' stage, 'Service Pipeline' pipeline.
Latest time in New (test)	Decimal	True		True	The total time in seconds spent by the service in the 'New' stage, 'test' pipeline since it last entered this stage.
Latest time in In progress (test)	Decimal	True		True	The total time in seconds spent by the service in the 'In progress' stage, 'test' pipeline since it last entered this stage.
Latest time in Closed (test)	Decimal	True		True	The total time in seconds spent by the service in the 'Closed' stage, 'test' pipeline since it last entered this stage.
Latest time in In progress (Service Pipeline)	Decimal	True		True	The total time in seconds spent by the service in the 'In progress' stage, 'Service Pipeline' pipeline since it last entered this stage.
Latest time in New (Service Pipeline)	Decimal	True		True	The total time in seconds spent by the service in the 'New' stage, 'Service Pipeline' pipeline since it last entered this stage.
Latest time in Closed (Service Pipeline)	Decimal	True		True	The total time in seconds spent by the service in the 'Closed' stage, 'Service Pipeline' pipeline since it last entered this stage.
Performed in an import	Bool	True		True	Object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

TaskAssociations

Returns object IDs associated with specific tasks, supporting task-related CRM associations.

Table Specific Information

SELECT

Note: You cannot reference custom objects by base name. When querying TaskAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		False	Unique identifier for the task association record.
AssociationId [KEY]	Long	False		False	Identifier of the object associated with this task, such as a contact, deal, or ticket.
Type [KEY]	String	False		True	Type of the associated object, such as contact, deal, company, or ticket.

TaskProperties

Retrieves available property fields associated with tasks, useful for managing task records.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the task property. Must start with a lowercase letter and contain only lowercase letters and numbers.
Label	String	False		False	Display label of the task property as shown in the HubSpot interface.
FieldType	String	False		False	Type of UI component used for this property, such as text field, dropdown, or checkbox.
Type	String	False		False	Underlying machine-readable data type of the property, such as string, number, or boolean.
GroupName	String	False		False	Group that organizes the task property within the task object.
Description	String	False		False	Description explaining the property's purpose and how it is used.
DisplayOrder	Int	False		False	Numeric value that controls the position of this property within its group.
ExternalOptions	Bool	False		False	Indicates whether the property's options are defined externally rather than within HubSpot.
IsFormField	Bool	False		False	Indicates whether this property can be included in a form for data input.
IsCalculated	Bool	False		False	Indicates whether the property's value is automatically calculated based on other properties.
IsHidden	Bool	False		False	Indicates whether the property is hidden from the standard user interface.
IsHubspotDefined	Bool	False		False	Indicates whether the property is part of HubSpot's default schema.
Archivable	Bool	False		False	Indicates whether the property can be archived and excluded from future use.
ReadOnlyDefinition	Bool	False		False	Indicates whether the configuration of the property is locked from editing.
ReadOnlyValue	Bool	False		False	Indicates whether the value of the property is locked and cannot be manually changed.
OptionsAggregate	String	False		False	List of selectable options available for this property, applicable if the field type supports choices such as radio or checkbox.
HasUniqueValue	Bool	False		False	Boolean indicating whether the value of the property is unique.

Threads

Lists all available conversation threads in HubSpot, useful for managing customer interactions.

SELECT

When selecting Threads, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM Threads;
SELECT * FROM Threads WHERE Id = 8413472578;

UPDATE

UPDATE Threads SET Status = 'OPEN' WHERE Id = 8413472578;

DELETE

DELETE FROM Threads WHERE Id = 8413472575

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		True	Unique identifier for the conversation thread.
CreatedAt	Datetime	True			Timestamp indicating when the thread was initiated.
ClosedAt	Datetime	True			Timestamp indicating when the thread was closed, if applicable.
Status	String	False		True	Current status of the thread, typically either open or closed.
LatestMessageTimestamp	Datetime	True			Timestamp of the most recent message sent or received within the thread.
LatestMessageSentTimestamp	Datetime	True			Timestamp of the most recent message sent from within the thread.
LatestMessageReceivedTimestamp	Datetime	True			Timestamp of the most recent message received in the thread.
AssignedTo	String	True			Identifier of the user or participant currently assigned to manage the thread.
Spam	Bool	True			Indicates whether the thread has been flagged as spam.
InboxId	String	True			Identifier for the inbox that contains the thread within the conversations tool.
AssociatedContactId	String	True		True	Identifier of the contact in the CRM that is associated with the thread.
Archived	Bool	False			Indicates whether the thread has been archived.

TicketAssociations

Returns object IDs associated with specific ticket records, supporting ticket associations in CRM.

Table Specific Information

SELECT

Note: You cannot reference custom objects by base name. When querying TicketAssociations, if Type refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True	Tickets.Id	False	Unique identifier for the ticket association record.
AssociationId [KEY]	Long	False		False	Identifier of the object associated with this ticket, such as a contact, deal, or company.
Type [KEY]	String	False		True	Type of the associated object, such as contact, deal, or company.

TicketPipelines

Lists pipelines configured for managing tickets, representing customer support workflows.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier assigned to the ticket pipeline.
Label	String	False		False	Display name of the ticket pipeline as it appears in HubSpot.
Archived	Bool	True		False	Indicates whether the pipeline is archived and no longer in active use.
CreatedAt	Datetime	True		False	Timestamp when the ticket pipeline was created.
UpdatedAt	Datetime	True		False	Timestamp when the ticket pipeline was last modified.
DisplayOrder	Int	False		False	Numeric order used to determine this pipeline's position among other pipelines.
StagesAggregate	String	False		False	Combined list of all ticket stages in this pipeline. Detailed stage data is available in the TicketPipelineStages table.

TicketPipelineStages

Lists stages within ticket pipelines, used to track progress of customer support cases.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	Unique identifier for the ticket stage within the pipeline.
PipelineId [KEY]	String	False	TicketPipelines.Id	False	Unique identifier of the pipeline to which this stage belongs.
Label	String	False		False	Name of the ticket stage as displayed in HubSpot.
PipelineLabel	String	True	TicketPipelines.Label	False	Name of the pipeline that includes this stage.
IsClosed	Bool	False		False	Indicates whether the stage represents a closed status for the ticket.
State	String	False		False	Current operational state of the pipeline stage, such as open or closed.
Archived	Bool	True		False	Indicates whether this stage has been archived and is no longer in active use.
CreatedAt	Datetime	True		False	Timestamp indicating when the pipeline stage was created.
UpdatedAt	Datetime	True		False	Timestamp indicating when the pipeline stage was last updated.
DisplayOrder	Int	False		False	Numeric value that determines the order of this stage within the pipeline.

TicketProperties

Retrieves all property fields associated with tickets, supporting ticket data management.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the ticket property. Must start with a lowercase letter and include only lowercase letters and numbers.
Label	String	False		False	User-friendly label displayed for the ticket property in the HubSpot UI.
FieldType	String	False		False	Visual input type shown to users, such as text field, dropdown, or checkbox.
Type	String	False		False	Underlying machine data type used to store the property value, such as string or number.
GroupName	String	False		False	Property group this ticket field belongs to, used for organizing fields in the UI.
Description	String	False		False	Text explaining the purpose or usage of this property in the ticket object.
DisplayOrder	Int	False		False	Numerical order determining where the property appears within its group.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options come from an external source.
IsFormField	Bool	False		False	Specifies if the property can be included in forms for user input.
IsCalculated	Bool	False		False	Indicates whether the property's value is computed based on other values.
IsHidden	Bool	False		False	Indicates whether the property is hidden from the standard UI view.
IsHubspotDefined	Bool	False		False	True if the property was created by HubSpot as part of its default schema.
Archivable	Bool	False		False	Indicates whether the property can be archived and hidden from future use.
ReadOnlyDefinition	Bool	False		False	Specifies if the field definition (such as type or label) is locked from editing.
ReadOnlyValue	Bool	False		False	Specifies if the property value cannot be manually updated.
OptionsAggregate	String	False		False	List of predefined selectable values for this property, if applicable to its field type.
HasUniqueValue	Bool	False		False	Indicates whether the property must contain a unique value across records.

TicketPropertyGroups

Provides access to groups used to organize ticket properties logically.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name used to identify the ticket property group.
Label	String	False		False	Display name of the property group as shown in the HubSpot UI.
DisplayOrder	Int	False		False	Order in which the property group appears relative to other groups.

Tickets

Lists all tickets in HubSpot, supporting both OAuth and private-app token authentication methods.

Table Specific Information

In HubSpot, a ticket represents a customer request for help or support. The tickets endpoints allow you to manage this data and sync it between HubSpot and other systems.

SELECT

When selecting tickets, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Tickets WHERE [Number of times contacted] > 5 AND [Ticket status] < 4
SELECT * FROM Tickets WHERE [Source] = 'EMAIL' OR [Source] = 'PHONE'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Tickets WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Tickets WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM Tickets WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Tickets WHERE ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

INSERT

INSERT INTO Tickets ([Ticket name]) VALUES ('ticket')

UPDATE

UPDATE Tickets SET [Ticket name] = 'new ticket' WHERE ID = '50962544'

DELETE

DELETE FROM Tickets WHERE ID = '50962544'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the ticket object.
Archived	Bool	True		False	Indicates whether the ticket has been archived.
CreatedAt	Datetime	True		False	Timestamp when the ticket was originally created.
UpdatedAt	Datetime	True		False	Timestamp when the ticket was last modified.
ItemURL	String	True		False	URL linking directly to the HubSpot record for the ticket.
Close date	Datetime	False		True	The date the ticket was marked as closed.
Created by	Decimal	False		True	VID of the contact who created the ticket.
Create date	Datetime	False		True	The creation date of the ticket, as captured in the record.
First agent email response date	Datetime	True		True	Timestamp of the first email response sent by an agent after ticket creation.
Business units	String	False		True	Business units assigned to the ticket record.
Assignment Method	String	False		True	Defines the method used to assign the ticket to an owner.
AutoGenerated from thread id	Decimal	True		True	ID of the thread for which this ticket was auto-created using ticket rules.
Originating Conversations Message Id	String	False		True	Message ID from Conversations that originated the ticket.
Conversations originating thread id	Decimal	False		True	Thread ID from Conversations that originally created the ticket.
Created by user ID	Decimal	True		True	ID of the HubSpot user who created the ticket. Automatically populated.
HubSpot create date	Datetime	True		True	Internal property showing the HubSpot system creation date for the ticket.
Custom inbox ID	Decimal	False		True	ID of the custom inbox linked to this ticket.
Date entered New (Support Pipeline)	Datetime	True		True	Timestamp when the ticket entered the 'New' stage of the 'Support Pipeline' pipeline.
Date entered Waiting on contact (Support Pipeline)	Datetime	True		True	Timestamp when the ticket entered the 'Waiting on contact' stage of the 'Support Pipeline' pipeline.
Date entered Waiting on us (Support Pipeline)	Datetime	True		True	Timestamp when the ticket entered the 'Waiting on us' stage of the 'Support Pipeline' pipeline.
Date entered Closed (Support Pipeline)	Datetime	True		True	Timestamp when the ticket entered the 'Closed' stage of the 'Support Pipeline' pipeline.
Date exited New (Support Pipeline)	Datetime	True		True	Timestamp when the ticket exited the 'New' stage of the 'Support Pipeline' pipeline.
Date exited Waiting on contact (Support Pipeline)	Datetime	True		True	Timestamp when the ticket exited the 'Waiting on contact' stage of the 'Support Pipeline' pipeline.
Date exited Waiting on us (Support Pipeline)	Datetime	True		True	Timestamp when the ticket exited the 'Waiting on us' stage of the 'Support Pipeline' pipeline.
Date exited Closed (Support Pipeline)	Datetime	True		True	Timestamp when the ticket exited the 'Closed' stage of the 'Support Pipeline' pipeline.
External object ids	String	False		True	Unique identifiers for linked tickets from external systems.
Last CES survey comment	String	True		True	Latest customer comment received via CES survey for this ticket.
Last CES survey rating	String	True		True	Most recent CES survey rating provided by the customer for this ticket.
Last CES survey date	Datetime	True		True	Timestamp when the most recent CES survey response was submitted for the ticket.
File upload	String	False		True	Files attached to a ticket via the support form submission.
First agent response date	Datetime	True		True	Timestamp when the first agent responded across all associated conversations.
In Help Desk	Bool	False		True	Indicates if the ticket is displayed in the Help Desk view.
Inbox ID	Decimal	True		True	Inbox ID where this ticket resides.
Last email activity	String	True		True	Type of the last email interaction related to the ticket's associated contact.
Last email date	Datetime	True		True	Timestamp of the last email interaction with the ticket's associated contact.
Last message received date	Datetime	True		True	Timestamp of the last customer reply message related to the ticket.
Last response date	Datetime	True		True	Timestamp of the most recent agent or bot response on the ticket.
Last activity date	Datetime	True		True	Timestamp of the most recent logged activity on the ticket, such as a note, call, email, meeting, or task.
Last contacted date	Datetime	True		True	Timestamp of the last sales or service interaction logged against the ticket.
Last modified date	Datetime	True		True	Most recent timestamp of any property update for the ticket, including internal HubSpot changes.
Latest message seen by agent ids	String	True		True	IDs of agents who have seen the newest message across all conversations associated with the ticket.
Merged ticket ids	String	True		True	IDs of all tickets merged into this ticket record.
Microsoft Teams message ID for this ticket.	String	True		True	The Microsoft Teams message ID associated with this ticket.
Next activity date	Datetime	True		True	Date of the next planned activity related to this ticket, such as a call or meeting.
Number of Associated Companies	Decimal	True		True	Total number of companies associated with the ticket.
Number of times contacted	Decimal	True		True	Total number of logged contacts, including calls, emails, or meetings related to the ticket.
Record ID	Decimal	True		True	The unique record ID for this ticket, automatically generated by HubSpot.
Originating channel account	String	True		True	The first channel account used when the originating conversation was started.
Originating email engagement id	Decimal	True		True	Engagement ID of the email that originated the ticket.
Originating channel type	String	True		True	Type of communication channel that originated the ticket, such as email, chat, or form.
Pinned Engagement ID	Decimal	True		True	ID of the engagement currently pinned to this ticket record.
Pipeline	String	False		True	The name of the pipeline that contains this ticket.
Ticket status	String	False		True	The current pipeline stage assigned to this ticket.
Read Only Object	Bool	True		True	Indicates whether the ticket is read-only.
Resolution	String	False		True	Description of the actions taken to resolve the ticket.
Thread IDs To Restore	String	False		True	Thread IDs from conversations used to support custom delete and restore operations.
Category	String	False		True	Primary reason or category describing why the customer opened the ticket.
Ticket ID	Decimal	True		True	Internal HubSpot-generated unique ID for this ticket.
Priority	String	False		True	Priority level assigned to the ticket to determine urgency and service level.
Time in New (Support Pipeline)	Decimal	True		True	Total time in seconds spent in the 'New' stage of the 'Support Pipeline' pipeline.
Time in Waiting on contact (Support Pipeline)	Decimal	True		True	Total time in seconds spent in the 'Waiting on contact' stage of the 'Support Pipeline' pipeline.
Time in Waiting on us (Support Pipeline)	Decimal	True		True	Total time in seconds spent in the 'Waiting on us' stage of the 'Support Pipeline' pipeline.
Time in Closed (Support Pipeline)	Decimal	True		True	Total time in seconds spent in the 'Closed' stage of the 'Support Pipeline' pipeline.
Time to Close SLA Due Date	Datetime	True		True	Deadline for meeting the Time to Close SLA on the ticket.
Time to Close SLA Ticket Status	String	True		True	Current status of the ticket with respect to the Time to Close SLA.
Time to First Response SLA Due Date	Datetime	True		True	Deadline for the first response according to the Time to First Response SLA.
Time to First Response SLA Status	String	True		True	Current SLA status for the time to first response on the ticket.
Unique creation key	String	True		True	Unique value used to ensure idempotent creation of ticket records.
Updated by user ID	Decimal	True		True	ID of the user who last updated the ticket, automatically set by HubSpot.
User IDs of all notification followers	String	True		True	IDs of users who are following the ticket for notification updates.
User IDs of all notification unfollowers	String	True		True	IDs of owners who have unfollowed the ticket notifications.
User IDs of all owners	String	True		True	IDs of all users who own or co-own the ticket.
Owner assigned date	Datetime	True		True	Timestamp when an owner was most recently assigned to the ticket.
Date of last engagement	Datetime	True		True	Timestamp of the most recent reply or internal note added to the ticket.
Last customer reply date	Datetime	True		True	Timestamp of the most recent customer response on the ticket.
NPS follow up	String	False		True	Response provided to the follow-up question in the NPS survey linked to the ticket.
NPS follow up question	Decimal	False		True	ID representing the specific version of the NPS follow-up question asked.
Conversation NPS score	String	False		True	Net Promoter Score (NPS) rating submitted after ticket resolution.
Reference to email thread	String	False		True	The ID of the email thread that includes the conversation linked to the ticket.
Time to close	Decimal	True		True	Elapsed time between ticket creation and ticket closure, measured in seconds.
Time to first agent email reply	Decimal	True		True	Elapsed time from ticket creation to the first agent email reply, measured in seconds.
Ticket name	String	False		True	Short descriptive title assigned to the ticket.
Ticket description	String	False		True	Detailed description of the issue or request associated with the ticket.
Source	String	False		True	The original channel where the ticket was submitted, such as chat, form, or email.
Reference to sourceSpecific object	String	False		True	ID of the source-specific object that is connected to the ticket, if any.
Tags	String	False		True	Custom tags assigned to the ticket for categorization or segmentation.
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email associated with this ticket received a reply.
Ticket owner	String	False		True	Owner assigned to manage the ticket. Additional owners can be assigned through custom properties.
Last Contacted _Ticket Note_	Datetime	True		True	Timestamp of the most recent logged call, email, or meeting associated with the ticket.
Last Activity Date _Ticket Note_	Datetime	True		True	Timestamp of the most recent note, call, email, meeting, or task logged for the ticket.
Next Activity Date _Ticket Note_	Datetime	True		True	Planned date for the next activity or follow-up related to the ticket.
Number of times contacted _Ticket Note_	Decimal	True		True	Total number of logged sales or service contacts recorded for the ticket.
Number of Sales Activities	Decimal	True		True	Total number of sales activities logged against the ticket.
HubSpot team	String	True		True	Primary HubSpot team associated with the ticket owner.
All owner ids	String	True		True	Comma-separated IDs of all owners associated with the ticket.
All team ids	String	True		True	Comma-separated IDs of all direct teams associated with the ticket owner.
All accessible team ids	String	True		True	Comma-separated IDs of all accessible teams, including those up the team hierarchy, for this ticket.

Workflows

Retrieves and manages workflows in HubSpot used to automate processes across marketing, sales, and service.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier assigned to the workflow.
Name	String	False		False	The name given to the workflow for display and identification.
Description	String	False		False	Brief description outlining the purpose or functionality of the workflow.
Enabled	Boolean	False		False	Indicates whether the workflow is currently active and operational.
CreatedAt	Long	True		False	Timestamp recording when the workflow was initially created.
UpdatedAt	Long	True		False	Timestamp indicating the last time the workflow was updated.
PortalId	Integer	True		False	Identifier for the HubSpot portal where the workflow was created.
Type	String	False		False	Specifies the classification or category of the workflow.
ActiveContacts	Integer	True		False	Current number of contacts actively enrolled in the workflow.
EnrolledContacts	Integer	True		False	Total number of contacts that have been enrolled in the workflow.
ContactListIdsActive	Integer	True		False	ID for the list of active contacts participating in the workflow.
ContactListIdsCompleted	Integer	True		False	ID for the list of contacts who have completed the workflow.
ContactListIdsEnrolled	Integer	True		False	ID for the list of contacts currently enrolled in the workflow.
ContactListIdsSucceeded	Integer	True		False	ID for the list of contacts who have successfully completed the workflow.
CreationSource	String	True		False	Indicates the tool, API, or feature used to create the workflow.
MigrationStatus	String	True		False	Status of any migration process that has affected the workflow.
UpdateSource	String	True		False	Indicates the tool, API, or feature used for the most recent workflow update.
Actions	String	False		False	Array of actions that define what the workflow will do when triggered.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - HubSpot ビュー


Name	Description
AssociationsTypes	Lists all association types available between CRM object pairs in HubSpot, defining relationship mappings.
CompanyPropertiesHistory	Returns the history of changes to company properties, useful for auditing and tracking data evolution.
ContactPropertiesHistory	Returns the history of changes made to contact properties, useful for auditing and understanding contact evolution.
CustomObjectProperties	Retrieves property fields for custom objects, supporting the management of custom data structures.
CustomObjects	Lists all available custom objects in HubSpot, useful for managing non-standard CRM data.
DealPropertiesHistory	Returns the history of changes to deal properties for auditing and historical analysis.
FeedbackSubmissions	Retrieves all feedback submission records in HubSpot, useful for tracking customer feedback.
Files	Searches for files stored in HubSpot's file manager, excluding hidden and archived files.
Folders	Searches for folder structures within HubSpot's file manager, excluding hidden and archived folders.
GoalProperties	Retrieves all available goal property fields associated with companies in HubSpot.
Goals	Lists all goals configured in HubSpot, useful for performance tracking and goal management.
LeadPipelines	Provides pipelines used for managing lead progression through various stages in HubSpot.
LeadPropertiesHistory	Returns the history of changes to lead properties, useful for auditing lead data changes.
OrderPropertiesHistory	Returns the history of changes made to order properties for auditing purposes.
Owners	Returns a list of owners in HubSpot used to assign CRM records to specific users within the organization.
PerformanceWorkflows	Provides performance breakdowns for workflows based on selected time periods, supporting workflow analysis.
Roles	Retrieves details about roles configured within a HubSpot account, supporting user role management.
Teams	Lists details about teams configured in the HubSpot account, aiding team structure management.
ThreadMessages	Retrieves the full message history within a conversation thread, enabling conversation tracking.
TicketPropertiesHistory	Returns the history of changes made to ticket properties, useful for auditing ticket updates.
UserProvisioning	Retrieves details about user accounts in HubSpot, including user permissions and provisioning.
WebAnalytics	Allows developers to filter and retrieve web analytics events associated with CRM objects.

AssociationsTypes

Lists all association types available between CRM object pairs in HubSpot, defining relationship mappings.

View Specific Information

Select

You must specify FromObjectType and ToObjectType. For example:

SELECT * FROM AssociationsTypes WHERE (FromObjectType = 'companies') AND (ToObjectType = 'deals')

Note: You cannot reference custom objects by base name. When querying AssociationsTypes, if FromObjectType or ToObjectType refers to a custom object, the value must now be either the short-hand object type name (p_<object_name>) or the fully qualified object type name.

Columns


Name	Type	References	Filterable	Description
Id [KEY]	String			Unique numeric identifier for the association type, used to differentiate relationship types between HubSpot objects.
Type	String			The descriptive name of the association type, indicating the nature of the relationship between two HubSpot objects.
FromObjectType [KEY]	String		True	Specifies the type of the source HubSpot object (such as contact or company) in the association pair.
ToObjectType [KEY]	String		True	Specifies the type of the target HubSpot object (such as deal or ticket) in the association pair.

CompanyPropertiesHistory

Returns the history of changes to company properties, useful for auditing and tracking data evolution.

Select

The PropertyName filter is required to retrieve data from this view. When querying CompanyPropertiesHistory, filtering can be applied to columns marked as "Filterable." For these columns, the supported server-side operators are = and IN.

SELECT * FROM CompanyPropertiesHistory WHERE PropertyName = 'Create Date'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		True	Name of the company property whose historical value is being recorded.
Value	String		False	Previous value of the property before it was updated.
SourceType	String		False	Indicates the method or source responsible for changing the property value, such as API, user action, or workflow.
SourceId	String		False	Additional identifier related to the source of the change. May be empty depending on the source type.
Timestamp	Datetime		False	Timestamp of when the property value was updated.
CompanyId	Long		False	Unique identifier of the company record associated with the property history.

ContactPropertiesHistory

Returns the history of changes made to contact properties, useful for auditing and understanding contact evolution.

Select

The PropertyName filter is required to retrieve data from this view. When querying ContactPropertiesHistory, filtering can be applied to columns marked as "Filterable." For these columns, the supported server-side operators are = and IN.

SELECT * FROM ContactPropertiesHistory WHERE PropertyName = 'Create Date'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		True	Name of the contact property whose historical value is being recorded.
Value	String		False	Previous value of the property before it was updated.
SourceType	String		False	Indicates the method or source responsible for changing the property value, such as API, user action, or workflow.
SourceId	String		False	Additional identifier related to the source of the change. May be empty depending on the source type.
Timestamp	Datetime		False	Timestamp of when the property value was updated.
ContactId	Long		False	Unique identifier of the contact associated with the property history.
ContactEmail	String		False	Email address of the contact linked to this property change.
ContactPhoneNumber	String		False	Primary phone number of the contact linked to this property change.

CustomObjectProperties

Retrieves property fields for custom objects, supporting the management of custom data structures.

View Specific Information

SELECT

SELECT * FROM CustomObjectProperties;
SELECT * FROM CustomObjectProperties WHERE ObjectId = '24711980';

Columns


Name	Type	References	Filterable	Description
ObjectId	String		False	Unique identifier assigned to the custom object instance, typically including portal ID and object name.
ObjectFullyQualifiedName [KEY]	String		False	Fully qualified name of the object type, combining meta type and unique ID (formatted as _meta_type__uniqueID_).
ObjectName	String		False	Unique name assigned to the schema's custom object type.
ObjectLabelSingular	String		False	Singular label for the custom object type, displayed in the CRM interface.
ObjectLabelPlural	String		False	Plural label for the custom object type, displayed in the CRM interface.
Name [KEY]	String		False	Internal name of the property, used when referencing the property via HubSpot API.
Label	String		False	Human-readable label for the property, displayed in the HubSpot UI.
UpdatedAt	Datetime		False	Timestamp indicating when the custom object property was last updated.
CreatedAt	Datetime		False	Timestamp indicating when the custom object property was initially created.
ArchivedAt	Datetime		False	Timestamp indicating when the custom object property was archived.
Type	String		False	Data type of the property, such as string, number, or date.
FieldType	String		False	Defines how the property appears in the HubSpot UI (such as text field, dropdown, or checkbox).
Description	String		False	Explanation of the property's purpose, shown as help text within HubSpot.
GroupName	String		False	Name of the property group this property belongs to, used for organizational purposes.
Options	String		False	List of valid options for the property, applicable for enumerated (dropdown/select) properties. Empty for other types.
CreatedUserId	String		False	Internal ID of the user who created the property. May be null if created by system processes or external tools.
UpdatedUserId	String		False	Internal ID of the user who last updated the property. May be null if updated externally.
ReferencedObjectType	String		False	If the property references another object type, it is listed here.
DisplayOrder	Int		False	Defines the order in which this property appears relative to others in the HubSpot UI. Lower values appear first.
Calculated	Bool		False	Indicates whether the property is calculated by HubSpot processes. Applicable to default properties.
ExternalOptions	Bool		False	Indicates whether the property options are sourced externally instead of being stored within property settings.
Archived	Bool		False	Indicates whether this property has been archived and is no longer in active use.
HasUniqueValue	Bool		False	Specifies whether the property value must be unique across all records. Once set, it cannot be changed.
Hidden	Bool		False	Indicates whether the property is hidden from standard views in HubSpot.
HubspotDefined	Bool		False	True if the property is a default HubSpot-defined property, false if it is custom.
ShowCurrencySymbol	Bool		False	Indicates whether the currency symbol (as per account settings) should be displayed with the property value.
ModificationMetadata	String		False	Metadata containing details about modifications made to the property.
FormField	Bool		False	Specifies whether the property can be used in HubSpot forms.

CustomObjects

Lists all available custom objects in HubSpot, useful for managing non-standard CRM data.

View Specific Information

In HubSpot, CustomObjects are custom CRM Objects that you create to represent and organize your CRM data based on your business needs.

SELECT

SELECT * FROM CustomObjects;
SELECT * FROM CustomObjects WHERE Id = '24711980';

Columns


Name	Type	References	Filterable	Description
Id	String		False	Unique identifier assigned to the custom object instance, typically including portal ID and object name.
FullyQualifiedName [KEY]	String		False	Fully qualified name of the object type, combining meta type and unique ID (formatted as _meta_type__uniqueID_).
Name	String		False	Unique name assigned to the custom object's schema, used to reference the object type.
LabelSingular	String		False	Singular display label for the custom object, used throughout the CRM interface.
LabelPlural	String		False	Plural display label for the custom object, used throughout the CRM interface.
CreatedAt	Datetime		False	Timestamp marking when the custom object type was initially created.
UpdatedAt	Datetime		False	Timestamp marking the most recent update to the custom object type.
PropertiesAggregate	String		False	Aggregate list of properties defined for this object type. Detailed property information is available in the CustomObjectProperties table.
AssociationsAggregate	String		False	Aggregate list of associations defined for this object type. Detailed association information is available in the CustomObjectAssociations table.
RequiredProperties	String		False	List of property names that must be populated when creating a new object of this type.
SearchableProperties	String		False	List of properties that will be indexed and searchable within HubSpot's product search for this object type.
PrimaryDisplayProperty	String		False	Name of the primary property displayed prominently on the HubSpot record page for this object type.
SecondaryDisplayProperties	String		False	List of secondary properties displayed on the HubSpot record page for this object type.
ObjectTypeId	String		False	Unique identifier assigned to the custom object type.
MetaType	String		False	Meta description providing details about the custom object type.

DealPropertiesHistory

Returns the history of changes to deal properties for auditing and historical analysis.

Select

The PropertyName filter is required to retrieve data from this view. When querying DealPropertiesHistory, filtering can be applied to columns marked as "Filterable." For these columns, the supported server-side operators are = and IN.

SELECT * FROM DealPropertiesHistory WHERE PropertyName = 'Create Date'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		True	Name of the deal property whose historical value is being recorded.
Value	String		False	Previous value of the property before it was updated.
SourceType	String		False	Method or source responsible for changing the property's value, such as API, user action, or workflow.
SourceId	String		False	Additional identifier related to the source of the change. Might be empty depending on the source type.
Timestamp	Datetime		False	Timestamp indicating when the property value was updated.
DealId	Long		False	Unique identifier of the deal associated with this property history entry.

FeedbackSubmissions

Retrieves all feedback submission records in HubSpot, useful for tracking customer feedback.

Table Specific Information

When contacts submit feedback to your surveys, you can use submission data in HubSpot tools to help understand how customers feel about your business.

SELECT

When selecting contacts, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM FeedbackSubmissions WHERE [Survey Name] = 'Customer Support Survey 1' AND [Date] > '2021-08-01'
SELECT * FROM FeedbackSubmissions WHERE [Email] = '[email protected]' OR [Feedback sentiment] = 'PROMOTER'

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM FeedbackSubmissions WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM FeedbackSubmissions WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}
SELECT * FROM FeedbackSubmissions WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM FeedbackSubmissions WHERE ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value}) OR ({Column} >= {Value} AND {Column} <= {Value} AND {Column} = {Value})

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier for the feedback submission object.
Archived	Bool		False	Indicates whether the feedback submission has been archived.
CreatedAt	Datetime		False	The date and time when the feedback submission was initially created.
UpdatedAt	Datetime		False	The most recent date and time when the feedback submission was updated.
Agent email	String		True	Email address of the conversation agent involved in the interaction that led to the feedback.
Agent responsible for the conversation	Decimal		True	User ID of the agent who handled the conversation that triggered the feedback.
Agent name	String		True	Full name of the conversation agent responsible for the interaction.
All accessible team IDs	String		True	All team IDs, including parent teams in the hierarchy, associated with the owners of this object.
Business units	String		True	The business units assigned to this feedback submission record.
All owner ids	String		True	The IDs of all owners associated with this record, including both default and custom owner properties.
All team ids	String		True	All team IDs tied to the owner properties of this record, including default and custom owner associations.
Chatflow ID	Decimal		True	Unique identifier of the chatflow used in the conversation that generated this submission.
Chatflow name	String		True	The name of the chatflow that was active during the conversation resulting in the feedback.
Chatflow object id	Decimal		True	Internal object ID representing the chatflow involved in the submission.
Contact first name	String		True	First name of the contact associated with the feedback submission.
Contact Id	Decimal		True	HubSpot ID of the contact most recently linked to the submission.
Contact last name	String		True	Last name of the contact associated with the feedback submission.
Conversation thread id	Decimal		True	Thread ID of the conversation that triggered this feedback submission.
Created by user ID	Decimal		True	ID of the user who created the feedback submission. Automatically assigned by HubSpot.
Object create date_time	Datetime		True	Timestamp of when this submission object was created. This value is managed by HubSpot.
Object last modified date_time	Datetime		True	The most recent timestamp of any updates made to the submission object, including system-generated changes.
Merged object IDs	String		True	A list of IDs for other feedback submission records merged into this one. Automatically managed by HubSpot.
Record ID	Decimal		True	System-generated unique ID used to identify the record in HubSpot.
Read Only Object	Bool		True	Indicates whether this feedback submission is a read-only object.
Tag IDs	String		True	List of tag identifiers assigned to this feedback submission.
Tags	String		True	Textual labels or categories assigned to the feedback submission for classification purposes.
Ticket id	Decimal		True	ID of the service ticket linked to this feedback submission, if applicable.
Ticket owner avatar uri	String		True	The URI of the avatar image for the owner of the ticket associated with the feedback submission.
Ticket owner	Decimal		True	The user ID of the owner assigned to the ticket related to this feedback.
Ticket name	String		True	The name or subject of the ticket associated with this feedback submission.
Unique creation key	String		True	A unique key used to ensure idempotent creation of the feedback submission object.
Updated by user ID	Decimal		True	The ID of the user who most recently updated the feedback submission. Set automatically by HubSpot.
User IDs of all notification followers	String		True	The user IDs of individuals who opted to follow and receive notifications about this feedback submission.
User IDs of all notification unfollowers	String		True	The user IDs of owners who opted out of receiving notifications for this feedback submission.
User IDs of all owners	String		True	All user IDs associated with ownership of this feedback submission record.
Owner Assigned Date	Datetime		True	The timestamp of when an owner was assigned to the feedback submission.
Owner	String		True	The name or identifier of the current owner of the feedback submission.
HubSpot Team	String		True	The team name of the user assigned as the owner of the feedback submission.
Industry Standard Question Type	String		True	Standardized question type used in the survey, such as NPS, CSAT, or CES.
Sentiment	String		True	The interpreted sentiment of the feedback submission, such as positive, neutral, or negative.
Survey ID	Decimal		True	The unique identifier of the survey linked to this feedback submission.
Survey Type	String		True	The type of survey that was submitted, such as Customer Satisfaction or Net Promoter Score.
Source	String		True	The origin channel of the survey at the time of feedback submission, such as email or chat.
Date	Datetime		True	The date and time when the feedback submission was recorded.
Rating	Decimal		True	The numeric rating value given by the user as part of the feedback submission.
Feedback sentiment	String		True	The overall sentiment classification derived from the submitted feedback content.
Response	String		True	Any additional comments or responses provided by the user alongside the feedback rating.
Ingestion id	String		True	Internal ID used by HubSpot when the feedback submission was first captured.
Knowledge article id	Decimal		True	The ID of the knowledge base article for which this feedback was submitted, if applicable.
Visitor id	Decimal		True	The unique identifier of the anonymous or known visitor who submitted the feedback.
Engagement id	Decimal		True	The ID of the engagement record equivalent to this feedback submission, if applicable.
Submission URL	String		True	The URL of the webpage or chat window from which the feedback submission was made.
Survey Name	String		True	The name of the survey that this feedback submission is associated with.
Form guid	String		True	The globally unique identifier for the form used in the feedback survey.
Email	String		True	Email address of the contact who submitted the feedback.
Submission Name	String		True	The name of the feedback submission, often derived from the respondent's email address.

Files

Searches for files stored in HubSpot's file manager, excluding hidden and archived files.

View Specific Information

SELECT

When selecting Files, they can be filtered by columns marked below as 'Filterable'. For these columns, except for the ParentFolderId column (which also supports the IN operator), the only supported server-side operator is =.

SELECT * FROM Files;
SELECT * FROM Files WHERE Id ='159487201435';

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier of the file.
Name	String		True	The name assigned to the file.
Extension	String		True	The file extension indicating its format, such as 'png' or 'pdf'.
Access	String		False	Specifies the file's access level, such as public or private. 使用できる値は次のとおりです。PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE
CreatedAt	Datetime		False	The date and time when the file was first created in HubSpot.
UpdatedAt	Datetime		False	The timestamp of the most recent update to the file.
Archived	Bool		False	Indicates whether the file has been deleted or archived.
ArchivedAt	Datetime		False	The date and time when the file was archived or deleted.
Type	String		True	The type or category of the file, such as image, document, or video. 使用できる値は次のとおりです。IMG, DOCUMENT, AUDIO, MOVIE, OTHER
IsUsableInContent	Bool		True	Whether this file is available for use when creating content such as emails or website pages.
Encoding	String		True	The file's encoding type, if applicable.
Size	Long		True	The file size measured in bytes.
Height	Int		True	The height of the file content in pixels, applicable to images and videos.
Width	Int		True	The width of the file content in pixels, applicable to images and videos.
Path	String		False	The directory path of the file in HubSpot's file manager.
ParentFolderId	Long		True	The ID of the folder where the file is stored.
Url	String		True	The live URL of the file, reflecting domain settings for the account.
DefaultHostingUrl	String		False	HubSpot's default hosting URL used to serve the file.
AllowsAnonymousAccess	Bool		True	Indicates whether the file is accessible anonymously (public) or requires authentication (private).

Folders

Searches for folder structures within HubSpot's file manager, excluding hidden and archived folders.

View Specific Information

SELECT

When selecting Folders, they can be filtered by columns marked below as 'Filterable'. For those columns, except ParentFolderId column that supports even the IN Operator, the supported server-side operator is =.

SELECT * FROM Folders;
SELECT * FROM Folders WHERE Id = '162408509011';

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier of the folder.
Name	String		True	The name assigned to the folder.
Path	String		False	The full path of the folder in the file manager directory structure.
ParentFolderId	Long		True	The ID of the folder's parent directory, if applicable.
CreatedAt	Datetime		True	The date and time when the folder was created.
UpdatedAt	Datetime		True	The timestamp of the most recent update to the folder.
Archived	Bool		False	Indicates whether the folder has been deleted or archived.
ArchivedAt	Datetime		False	The date and time when the folder was archived or deleted.

GoalProperties

Retrieves all available goal property fields associated with companies in HubSpot.

View Specific Information

SELECT

When selecting GoalProperties, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =, IN.

SELECT * FROM GoalProperties;
SELECT * FROM GoalProperties WHERE Name = 'hs_assignee_type' ;

Columns


Name	Type	References	Filterable	Description
Name [KEY]	String		True	The internal name of the goal property. It must begin with a lowercase alphabetical character and can include only lowercase letters and numbers.
Label	String		False	The human-readable label of the property as it appears in the HubSpot user interface.
FieldType	String		False	Specifies the type of input field that will be used to display the property in the UI, such as text, dropdown, or checkbox.
Type	String		False	The underlying data type used for storing the property value, such as string, number, or boolean.
GroupName	String		False	The name of the property group to which this goal property belongs.
Description	String		False	A short explanation of the purpose or usage of this property within the goal context.
DisplayOrder	Int		False	Indicates the display order of the property relative to others in the same group. Lower numbers are shown first.
ExternalOptions	Bool		False	Indicates whether the property's options are populated externally, typically used for dropdowns or radio buttons.
IsFormField	Bool		False	Specifies whether this property is used as a field in forms.
IsCalculated	Bool		False	True if the value of the property is derived or computed rather than manually entered.
IsHidden	Bool		False	If true, the property is hidden from the user interface.
IsHubspotDefined	Bool		False	True if the property is defined by HubSpot as a default system property.
Archivable	Bool		False	Specifies whether this property can be archived and excluded from views or forms.
ReadOnlyDefinition	Bool		False	Indicates whether the property's definition (such as label or type) is read-only and cannot be modified.
ReadOnlyValue	Bool		False	If true, the value of the property is locked and cannot be changed manually.
OptionsAggregate	String		False	A combined list of available options for this property, applicable to field types such as radio, checkbox, or boolean checkbox.
HasUniqueValue	Bool		False	Boolean indicating whether the value of the property is unique.

Goals

Lists all goals configured in HubSpot, useful for performance tracking and goal management.

View Specific Information

In HubSpot, goals are used to create user-specific quotas for their sales and services teams.

SELECT

When selecting goals, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are: =, !=, <, <=, >, >=, IN

Further filtering is available using AND and OR combinations. A maximum of 3 OR operators are supported server-side, with each of these operators supporting up to 3 AND operators inside of them. For example:

SELECT * FROM Goals;
SELECT * FROM Goals WHERE Id = '385180212151';

In the below server-offloading examples, "{Column}" represents any column you'd like to filter and "{Value}" represents any value you want to filter it on:

SELECT * FROM Goals WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Goals WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Goals WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Goals WHERE ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}) OR ({Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value})

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier for the goal object.
Archived	Bool		False	Indicates whether the goal is archived.
CreatedAt	Datetime		False	The timestamp when the goal object was created.
UpdatedAt	Datetime		False	The timestamp when the goal object was last updated.
MigrationSoftDeleteDeprecated	String		True	Indicates whether the goal can be treated as deleted due to migration.
Ad account asset IDs	String		True	Semicolon-separated list of ad account universally unique identifiers (UUIDs), formatted as {AD_NETWORK}-{ACCOUNT_ID}.
Ad campaign asset ids	String		True	Semicolon-separated list of ad campaign UUIDs, formatted as {NETWORK}-{CAMPAIGN_ID}.
All teams	String		True	IDs of all teams including those up the hierarchy, related to owner referencing properties.
Business units	String		True	Business units that this goal record belongs to.
All owner ids	String		True	List of all owner IDs for this object, both default and custom.
Team ids	String		True	The team ID assigned to the goal; only one should be assigned.
Assignee team ID	Decimal		True	Team ID assigned to the goal, if applicable.
Assignee user ID	Decimal		True	User ID assigned to the goal, if applicable.
Campaign asset ids	String		True	List of marketing campaign asset IDs associated with the goal.
Contact lifecycle stage	String		True	The selected lifecycle stage for the goal, if the key performance indicator (KPI) involves contacts.
Created by user ID	Decimal		True	The ID of the user who created the goal. Set automatically by HubSpot.
Object create date/time	Datetime		True	Date and time when the goal object was created. Automatically assigned by HubSpot.
currency	String		True	DEPRECATED. Currency code used for the goal target.
Currency Exchange Rate	Decimal		True	Exchange rate for converting goal values into the company currency.
Deal pipelines	String		True	Serialized list of deal pipeline IDs used in KPI filtering.
Edit updates notification frequency	String		True	Frequency of notifications about edits to the goal.
End date	Date		True	Last day that the goal's target date range covers (date format).
End datetime	Datetime		True	Last day that the goal's target date range covers (datetime format).
Fiscal year offset	Decimal		True	Offset in months for the fiscal year compared to the calendar year.
Goal name	String		True	The name assigned to the goal.
Goal target currency code	String		True	Currency code used for the goal's target amount.
Goal Target Group ID	Decimal		True	The ID of the associated goal target group.
Goal type	String		True	The type or category of the goal (such as revenue or engagement).
Group correlation UUID	String		True	A unique identifier applied to all goal targets and groups created in a single request.
Is forecastable	String		True	Indicates whether the goal is eligible to appear in forecasting applications.
IsLegacy	String		True	Indicates whether the goal was migrated from a legacy system.
KPI Display Unit	String		True	The display unit for KPI values if duration-based (such as hours or minutes).
KpiFilterGroups	String		True	Serialized filter groups that define how KPI values should be calculated.
KPI is team rollup	Bool		True	Indicates whether KPI values roll up from child teams in addition to the assigned team.
KpiMetricType	String		True	Specifies the metric aggregation method such as sum, average, or count.
KpiObjectType	String		True	The object type (such as deal or contact) on which the KPI calculation is based.
Kpi object type id	String		True	The internal HubSpot ObjectTypeId for the KPI's base object type.
KpiPropertyName	String		True	The name of the property used as the basis for KPI calculation.
KpiSingleObjectCustomGoalTypeName	String		True	Custom goal definition for single-object KPIs (object, metric, property).
KpiTimePeriodProperty	String		True	The date-type property used to filter KPIs by time period.
KpiTrackingMethod	String		True	Defines how progress is tracked (either cumulative or point-in-time).
Kpi unit type	String		True	The unit of measurement for the KPI (such as dollars, count, percent).
KPI value	Decimal		True	The most recently calculated KPI value for the goal.
KPI value calculated at	Decimal		True	The timestamp when the latest KPI value was calculated (epoch format).
KPI value last calculated at	Datetime		True	Datetime of the most recent KPI value calculation.
Object last modified date/time	Datetime		True	Timestamp of the most recent update to any goal property.
LegacyActive	String		True	Indicates whether the goal is considered active in the legacy system.
LegacyCreatedAt	Decimal		True	Timestamp representing when the legacy goal was originally created.
LegacyCreatedBy	Decimal		True	User ID of the creator from the legacy system.
LegacyQuarterlyTargetCompositeId	String		True	Concatenated IDs of the three monthly goals that formed a legacy quarterly goal.
LegacySqlId	Decimal		True	The ID of the goal in the legacy SQL-based system.
LegacyUniqueSqlId	Decimal		True	Unique ID of the goal from the legacy system to prevent duplication.
LegacyUpdatedAt	Decimal		True	Timestamp of the last update to the goal in the legacy system.
LegacyUpdatedBy	Decimal		True	User ID of the person who last updated the legacy goal.
Merged record IDs	String		True	IDs of all records that were merged into this goal. Set by HubSpot automatically.
MigrationSoftDelete	String		True	Indicates whether the goal should be soft-deleted due to migration processes.
Milestone	String		True	The goal milestone period, such as monthly or quarterly.
Record ID	Decimal		True	Unique record ID of the goal, set automatically by HubSpot.
Record Creation Source	String		True	Source label indicating how the record was created (such as import or API).
Record Creation Source ID	String		True	Detailed identifier of the creation source, such as integration ID.
Record Creation Source User ID	Decimal		True	User ID of the person or system that initiated goal creation.
Outcome	String		True	Final status or result of the goal, such as achieved or missed.
Owner ids of all owners	String		True	All owner IDs associated with this goal record, including default and custom owners.
Participant type	String		True	Specifies whether the goal is assigned to a user or a team.
Pipeline ids	String		True	List of pipeline IDs to filter KPI calculations for deals.
Pipelines	String		True	Serialized list of pipeline IDs used for KPI filtering.
Progress updates notification frequency	String		True	Frequency setting for sending progress update notifications for this goal.
Read Only Object	Bool		True	Indicates whether the goal record is read-only and cannot be edited.
Notify on goal achieved	String		True	Indicates whether to notify users when a goal is achieved.
Notify with goal edit updates	String		True	Indicates whether to notify users when goal settings are edited.
Notify on goal exceeded	String		True	Indicates whether to notify users if the KPI exceeds the goal target.
Notify on goal kickoff	String		True	Indicates whether to notify users when the goal period begins.
Notify on goal missed	String		True	Indicates whether to notify users if the goal was missed.
Notify with progress updates	String		True	Indicates whether to send regular progress updates to users.
ShouldRecalculate	String		True	Flag indicating whether the goal's KPI values should be recalculated.
Start datetime	Datetime		True	Start date and time of the goal's active period.
Static KPI Filter Groups	String		True	Serialized filter groups for non-time-based filtering in KPI calculations.
Status	String		True	The current status of the goal, such as Active or Completed.
Status display order	Decimal		True	Determines the order in which statuses are displayed in the UI.
Target amount	Decimal		True	The numeric value representing the target for this goal.
Target amount in company currency	Decimal		True	Target amount converted to the company's primary currency using exchange rate.
Team ID	Decimal		True	ID of the team assigned to the goal (used for team-based goal tracking).
Ticket pipelines	String		True	Serialized list of ticket pipeline IDs used to filter KPIs when tracking support goals.
Unique creation key	String		True	A unique string to ensure idempotent creation of goal records via API.
Updated by user ID	Decimal		True	User ID of the person who last updated this goal.
User ID	Decimal		True	ID of the user assigned to this goal (for user-based goals).
User IDs of all notification followers	String		True	User IDs of those following this goal to receive notifications.
User IDs of all notification unfollowers	String		True	User IDs of owners who opted out of receiving goal notifications.
User IDs of all owners	String		True	User IDs of all current owners of this goal record.
Performed in an import	Bool		True	Indicates whether the goal was created as part of a data import.
Owner Assigned Date	Datetime		True	Timestamp of the most recent assignment of an owner to this goal.
Owner	String		True	Primary owner of the goal, usually a user or team name.
HubSpot Team	String		True	The primary team assigned to the goal's owner. Useful for team-based tracking and reporting.
Start date	Date		True	The calendar date when the goal's target period begins.
Kpi progress percent	Decimal		True	The progress toward the KPI target expressed as a percentage of the total goal.

LeadPipelines

Provides pipelines used for managing lead progression through various stages in HubSpot.

View Specific Information

SELECT

When selecting LeadPipelines, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM HubSpotV3.LeadPipelines;
SELECT * FROM HubSpotV3.LeadPipelines WHERE Id = 'lead-pipeline-id';

Columns


Name	Type	References	Filterable	Description
Id [KEY]	String		True	The unique identifier of the lead pipeline.
Label	String		False	The display name of the pipeline as shown in the HubSpot UI.
Archived	Bool		False	Indicates whether the pipeline has been archived and is no longer active.
CreatedAt	Datetime		False	The date and time when the pipeline was initially created.
UpdatedAt	Datetime		False	The date and time when the pipeline was last modified.
DisplayOrder	Int		False	The position of the pipeline within the list of pipelines, used to determine display order.
StagesAggregate	String		False	A summarized list of the stages associated with this pipeline. Detailed information is available in the LeadPipelineStages table.

LeadPropertiesHistory

Returns the history of changes to lead properties, useful for auditing lead data changes.

View Specific Information

SELECT

When querying LeadPropertiesHistory, filtering can be applied to columns marked as "Filterable." For these columns, the supported server-side operators are = and IN.

SELECT * FROM LeadPropertiesHistory;
SELECT * FROM LeadPropertiesHistory WHERE PropertyName = 'hs_lead_is_new';

Columns


Name	Type	References	Filterable	Description
PropertyName	String		True	The internal name of the lead property that was updated.
Value	String		False	The historical value assigned to the property at the time of the update.
SourceType	String		False	The method or system that initiated the property change, such as user action or an automated process.
SourceId	String		False	Additional metadata or reference ID associated with the source of the property update. This might be null or empty in some cases.
Timestamp	Datetime		False	The date and time when the property was modified.
LeadId	Long		False	The unique identifier of the lead whose property history is being tracked.

OrderPropertiesHistory

Returns the history of changes made to order properties for auditing purposes.

View Specific Information

SELECT

The PropertyName filter is required to retrieve data from this view. When querying OrderPropertiesHistory, filtering can be applied to columns marked as "Filterable." For these columns, the supported server-side operators are = and IN.

SELECT * FROM OrderPropertiesHistory;
SELECT * FROM OrderPropertiesHistory WHERE PropertyName = 'hs_createdate';

Columns


Name	Type	References	Filterable	Description
PropertyName	String		True	Name of the order property that was changed.
Value	String		False	Previous or historical value of the property at the time of the change.
SourceType	String		False	Indicates how the property change occurred, such as via user action, workflow, or API.
SourceId	String		False	Additional metadata about the source of the change. This may be blank depending on the source type.
Timestamp	Datetime		False	Date and time when the property value was updated.
OrderId	Long		False	Unique identifier of the order associated with the property change.

Owners

Returns a list of owners in HubSpot used to assign CRM records to specific users within the organization.

View Specific Information

SELECT

When selecting Owners, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

SELECT * FROM Owners;
SELECT * FROM Owners WHERE Id = 354112170;

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier of the owner record in HubSpot.
FirstName	String		False	First name of the user who owns CRM objects such as contacts, deals, or companies.
LastName	String		False	Last name of the user who owns CRM objects such as contacts, deals, or companies.
UserId	String		False	Internal HubSpot user ID associated with the owner.
Email	String		True	Primary email address of the owner, used for notifications and assignments.
Teams	String		False	Comma-separated list of team names or IDs that the owner is a member of.
CreatedAt	Datetime		False	Timestamp of when the owner record was first created in HubSpot.
UpdatedAt	Datetime		False	Timestamp of the most recent update to the owner record.
Archived	Bool		False	Indicates whether the owner record has been archived (soft-deleted) in HubSpot.

PerformanceWorkflows

Provides performance breakdowns for workflows based on selected time periods, supporting workflow analysis.

View Specific Information

SELECT

The [WorkflowId] filter is required to retrieve data from this view. The view can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators is: =.

    SELECT * FROM PerformanceWorkflows WHERE WorkflowId = '69731775';
    SELECT * FROM PerformanceWorkflows WHERE WorkflowId = '69731772' AND TimePeriod = 'WEEK';

Columns


Name	Type	References	Filterable	Description
WorkflowId	Long	Workflows.Id	True	Unique identifier of the workflow associated with the performance data.
Series	String			Type or category of workflow series being analyzed.
Bucket	Date			Date used as the grouping bucket for the workflow data.
TimePeriod	String		True	Time interval used to group workflow performance data. Must be DAY, WEEK, or MONTH. 使用できる値は次のとおりです。DAY, WEEK, MONTH
Frequency	Integer			Number of times the workflow was executed within the defined time period.
StartDate	Datetime		True	Start date for the workflow performance reporting window.
EndDate	Datetime		True	End date for the workflow performance reporting window.

Roles

Retrieves details about roles configured within a HubSpot account, supporting user role management.

View Specific Information

SELECT

SELECT * FROM Roles;

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		False	Unique identifier assigned to the role.
Name	String		False	Name of the role as it appears in HubSpot.
RequiresBillingWrite	Boolean		False	Indicates whether the role includes a paid seat and requires billing-write permissions to assign or remove from users.

Teams

Lists details about teams configured in the HubSpot account, aiding team structure management.

View Specific Information

SELECT

SELECT * FROM Teams;

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		False	Unique identifier assigned to the team in HubSpot.
Name	String		False	Name of the team as it appears in HubSpot.
UserIds	String		False	Comma-separated list of user IDs for primary members of the team.
SecondaryUserIds	String		False	Comma-separated list of user IDs for secondary members assigned to the team.

ThreadMessages

Retrieves the full message history within a conversation thread, enabling conversation tracking.

View Specific Information

SELECT

When selecting ThreadMessages, they can be filtered by columns marked below as 'Filterable' or by using the pseudo-columns. For those columns, the supported server-side operators is: =.

SELECT * FROM ThreadMessages;
SELECT * FROM ThreadMessages WHERE ThreadId = '8413472578';
SELECT * FROM ThreadMessages WHERE ThreadId = '8413472578' AND Id = '5eb0b534-b4d4-43cd-9137-e3a0f801d9ce' ;

Columns


Name	Type	References	Filterable	Description
Id [KEY]	String		True	Unique identifier of the thread message.
Type	String		False	The category or classification of the message, such as email, chat, or SMS.
CreatedAt	Datetime		False	Timestamp indicating when the message was originally created.
UpdatedAt	Datetime		False	Timestamp indicating the last time the message was updated.
CreatedBy	String		False	ID of the participant or system that created the message.
ClientType	String		False	The type of client application that originated the message.
IntegrationAppId	Integer		False	ID of the integration that sent the message, if applicable.
SendersId	String		False	ID of the sender who transmitted the message.
SendersName	String		False	Name of the sender who transmitted the message.
SendersField	String		False	Custom-defined field representing the sender's role or context.
SendersDeliveryIdentifierType	String		False	Type of identifier used to deliver the message from the sender, such as email or phone number.
SendersDeliveryIdentifierValue	String		False	Value of the sender's delivery identifier, such as the actual email address or phone number.
RecipientsId	String		False	ID of the recipient who received the message.
RecipientsName	String		False	Name of the recipient who received the message.
RecipientsField	String		False	Custom-defined field representing the recipient's role or context.
RecipientsDeliveryIdentifierType	String		False	Type of identifier used to deliver the message to the recipient, such as email or phone number.
RecipientsDeliveryIdentifierValue	String		False	Value of the recipient's delivery identifier, such as the actual email address or phone number.
ChannelId	String		False	ID of the communication channel through which the message was sent.
ChannelAccountId	String		False	Account ID used within the channel for message delivery.
Archived	Bool		False	Indicates whether the message is archived and no longer actively displayed.
AssignedTo	String		False	ID of the user or queue the message is currently assigned to.
AssignedFrom	String		False	ID of the user or queue from which the message was previously assigned.
Text	String		False	Plain text content of the message body.
RichText	String		False	HTML-formatted content of the message body.
AttachmentsFileId	String		False	ID of any file attached to the message.
AttachmentsUrl	String		False	URL pointing to the file attachment associated with the message.
Subject	String		False	Subject line of the message, if applicable.
TruncationStatus	String		False	Indicates whether the message content was truncated.
InReplyToId	String		False	ID of the message this entry is replying to, if part of a conversation thread.
StatusType	String		False	Current status type of the message, such as 'sent', 'delivered', or 'failed'.
Direction	String		False	Direction of the message relative to the user, such as inbound or outbound.
NewStatus	String		False	Most recently updated status value of the message.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ThreadId	String		Identifier of the conversation thread this message belongs to.

TicketPropertiesHistory

Returns the history of changes made to ticket properties, useful for auditing ticket updates.

Select

The PropertyName filter is required to retrieve data from this view. When querying TicketPropertiesHistory, filtering can be applied to columns marked as "Filterable." For these columns, the supported server-side operators are = and IN.

SELECT * FROM TicketPropertiesHistory WHERE PropertyName = 'Create Date'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		True	Name of the ticket property whose value changed.
Value	String		False	The previous or historical value of the property.
SourceType	String		False	Indicates how the change was made, such as by user action, workflow, or integration.
SourceId	String		False	Additional identifier related to the source of the change, if available.
Timestamp	Datetime		False	Date and time when the property value was updated.
TicketId	Long		False	Unique identifier of the ticket associated with this property history entry.

UserProvisioning

Retrieves details about user accounts in HubSpot, including user permissions and provisioning.

View Specific Information

SELECT

When querying UserProvisioning, filtering can be applied to columns marked as "Filterable." For these columns, the supported server-side operator is =.

    SELECT * FROM UserProvisioning ;
    SELECT * FROM UserProvisioning WHERE Id = '1165089';

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier for the user.
FirstName	String		False	First name of the user.
LastName	String		False	Last name of the user.
Email	String		True	Email address associated with the user account.
RoleId	Long	Roles.Id	False	Identifier for the role assigned to the user.
PrimaryTeamId	Long	Teams.Id	False	Identifier for the user's primary team.
SecondaryTeamIds	String		False	Comma-separated list of IDs for secondary teams the user belongs to.
IsSuperAdmin	Boolean		False	Indicates whether the user has super admin privileges.

WebAnalytics

Allows developers to filter and retrieve web analytics events associated with CRM objects.

View Specific Information

SELECT

EventType, or ObjectType and either ObjectId or ObjectProperty must be specified.
When selecting WebAnalytics, they can only be filtered by the EventType, ObjectType, ObjectId, ObjectProperty, OccurredAfter, OccurredBefore and Sort. For example:

SELECT * FROM WebAnalytics WHERE ObjectId = '74924128' AND ObjectType = 'contact'
SELECT * FROM WebAnalytics WHERE ObjectId = '101' AND ObjectType = 'contact' AND OccurredAfter = '07/02/2020 09:45:50.829'
SELECT * FROM WebAnalytics WHERE ObjectId = '101' AND ObjectType = 'contact' AND OccurredBefore = '07/02/2020 09:45:50.829'
SELECT * FROM WebAnalytics WHERE ObjectId = '101' AND ObjectType = 'contact' AND  Sort = 'occurredAt'

Columns


Name	Type	References	Filterable	Description
Id [KEY]	String		False	Unique identifier for the event.
ObjectId	String		False	Unique identifier of the associated object.
ObjectType	String		False	Type of the associated object, such as contact, company, or deal.
EventType	String		False	Type of event that occurred, such as page view or form submission.
OccurredAt	Datetime		False	Timestamp indicating when the event occurred.
Properties	String		False	Additional event-related properties or metadata.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ObjectProperty	String		Required if ObjectId is not provided. Specifies a property and its value to match an object, formatted as 'propertyName_propertyValue'.
OccurredAfter	Datetime		Start time for filtering events, provided as an ISO 8601 timestamp.
OccurredBefore	Datetime		End time for filtering events, provided as an ISO 8601 timestamp.
Sort	String		Field used to sort results. Defaults to ascending by 'occurredAt'; prefix with '_' for descending order.

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、HubSpot の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにHubSpot から関連するレスポンスデータを返します。

CData Cloud - HubSpot ストアドプロシージャ


Name	Description
CreateCustomObject	Creates a custom object in HubSpot. Requires private-app token authentication if OAuth scopes are insufficient.
CreateCustomProperty	Adds a custom property to a HubSpot object, enhancing CRM data flexibility.
DeleteCustomObject	Deletes an existing custom object from HubSpot. private-app token authentication is recommended for insufficient OAuth scopes.
DeleteCustomProperty	Removes a custom property from a HubSpot object, streamlining data fields.
DeleteFile	Permanently deletes a file and all related metadata and thumbnails from HubSpot's file manager.
UpdateCustomObject	Updates an existing custom object in HubSpot. May require private-app token authentication due to OAuth scope limitations.
UpdateCustomProperty	Modifies an existing custom property for a HubSpot object, supporting data customization.

CreateCustomObject

Creates a custom object in HubSpot. Requires private-app token authentication if OAuth scopes are insufficient.

Execute

When you need to create a custom object you also need to define its schema (properties).

There are two ways to do that. The first way is to feed the whole json aggregate (for the properties) to the Properties input, as shown below:

EXECUTE CreateCustomObject
ObjectName = 'DevObject',
ObjectLabelSingular = 'Dev',
ObjectLabelPlural = 'Devs',
RequiredProperties = 'TestDev',
SearchableProperties = 'TestDev,TestNumber',
PrimaryDisplayProperty = 'TestDev',
SecondaryDisplayProperties = 'TestNumber',
AssociatedObjects = 'Contacts',
Properties = '[
        {
            \"name\": \"nameinternal\",
            \"label\": \"Name\",
            \"groupName\": \"group1\",
            \"description\": \"The Name of the Machine.\",
            \"displayOrder\": \"1\",
            \"hidden\": \"false\",
            \"type\": \"string\",
            \"fieldType\": \"textarea\"
        },
        {
            \"name\": \"modelinternal\",
            \"label\": \"Model\",
            \"groupName\": \"group1\",
            \"description\": \"The model of the Machine.\",
            \"displayOrder\": \"2\",
            \"hasUniqueValue\": \"true\",
            \"type\": \"enumeration\",
            \"fieldType\": \"radio\",
            \"options\": [
                {
                    \"label\": \"Model-GT\",
                    \"value\": \"GT\",
                    \"description\": \"GT Model\",
                    \"displayOrder\": \"1\",
                    \"hidden\": \"true\"
                },
                {
                    \"label\": \"Model-AF\",
                    \"value\": \"AF\",
                    \"description\": \"AF Model\",
                    \"displayOrder\": \"2\",
                    \"hidden\": \"true\"
                },
                {
                    \"label\": \"Model-Z\",
                    \"value\": \"Z\",
                    \"description\": \"Z Model\",
                    \"displayOrder\": \"3\",
                    \"hidden\": \"true\"
                },
                {
                    \"label\": \"Model-0\",
                    \"value\": \"0\",
                    \"description\": \"0 Model\",
                    \"displayOrder\": \"4\",
                    \"hidden\": \"false\"
                }
            ]
        },
        {
            \"name\": \"orderdateinternal\",
            \"label\": \"OrderDate\",
            \"groupName\": \"group1\",
            \"description\": \"The order date of the Machine.\",
            \"displayOrder\": \"3\",
            \"hasUniqueValue\": \"false\",
            \"type\": \"date\",
            \"fieldType\": \"date\"
        },
        {
            \"name\": \"stockinternal\",
            \"label\": \"Stock\",
            \"groupName\": \"group1\",
            \"description\": \"The number of machines in stock.\",
            \"displayOrder\": \"-1\",
            \"hasUniqueValue\": \"false\",
            \"type\": \"number\",
            \"fieldType\": \"number\"
        }
    ]'

The second way is to make use of the Driver #TEMP tables for the aggregate value.

To do that, you need to execute the following:

    INSERT INTO Properties#Temp (PropertyName, PropertyLabel, PropertyGroupName, PropertyType, PropertyFieldType) VALUES ('TestNumber', 'Dev Number', 'group1', 'number', 'number')
    INSERT INTO Properties#Temp (PropertyName, PropertyLabel, PropertyGroupName, PropertyType, PropertyFieldType) VALUES ('TestDev', 'Test Dev', 'group1', 'string', 'text')

After creating the temporary table with the properties, we can execute the stored procedure as shown below:

EXECUTE CreateCustomObject
ObjectName = 'DevObject',
ObjectLabelSingular = 'Dev',
ObjectLabelPlural = 'Devs',
RequiredProperties = 'TestDev',
SearchableProperties = 'TestDev,TestNumber',
PrimaryDisplayProperty = 'TestDev',
SecondaryDisplayProperties = 'TestNumber',
AssociatedObjects = 'Contacts',
Properties = 'Properties#Temp'

If one of the initial properties is of the type enumeration, you first need to create a temporary table with property options, as shown below:

INSERT INTO PropertyOptions#Temp (OptionLabel, OptionValue, OptionDescription, OptionDisplayOrder, OptionHidden) VALUES ('TRUE', 'true', 'Yes', 1, false)
INSERT INTO PropertyOptions#Temp (OptionLabel, OptionValue, OptionDescription, OptionDisplayOrder, OptionHidden) VALUES ('False', 'false', 'No', 2, false)

After creating the temporary table with the property options, you need to create the temporary table with the properties. First, set the property options temporary table name (created above) as the value of the Options column. Then, create a record, which is the type enumeration. This temporary table is shown below:

    INSERT INTO Properties#Temp (PropertyName, PropertyLabel, PropertyGroupName, PropertyType, PropertyFieldType, Options) VALUES ('TestEnumeration', 'Dev Enumeration', 'group1', 'enumeration', 'radio', 'PropertyOptions#Temp')
    INSERT INTO Properties#Temp (PropertyName, PropertyLabel, PropertyGroupName, PropertyType, PropertyFieldType) VALUES ('TestDev', 'Test Dev', 'group1', 'string', 'text')

After creating the temporary table with the properties, we can execute the stored procedure as shown below:

    EXECUTE CreateCustomObject
    ObjectName = 'DevObject',
    ObjectLabelSingular = 'Dev',
    ObjectLabelPlural = 'Devs',
    RequiredProperties = 'TestDev',
    SearchableProperties = 'TestDev',
    PrimaryDisplayProperty = 'TestDev',
    SecondaryDisplayProperties = 'TestEnumeration',
    AssociatedObjects = 'Contacts',
    Properties = 'Properties#Temp'

PropertyOptions temporary table schema info:


Column Name	Type	Required	Description
OptionLabel	string	true	Human-readable label for an enumerated option. Required if PropertyFieldType is set to an option-based input like select or radio.
OptionValue	string	true	Internal value corresponding to the enumerated label. This value is used when setting the property through the API.
OptionDescription	string	false	Optional description for the enumerated option. Appears as help text to clarify the option's meaning or use.
OptionDisplayOrder	integer	false	Order in which this option appears in the UI. Lower positive integers appear first; -1 causes the option to appear last.
OptionHidden	boolean	false	Specifies whether the option should be hidden from the HubSpot interface. Hidden options can still be used via API.

Properties temporary table schema info:


Column Name	Type	Required	Description
PropertyName	string	true	The internal name of the property. This is used in API requests and must remain consistent for integrations and automation.
PropertyLabel	string	true	The display label for the property as shown in HubSpot's UI. It should be easily understandable to end users.
PropertyGroupName	string	false	Optional grouping label for organizing related properties in the HubSpot UI under a shared section.
PropertyDescription	string	false	Optional help text that appears in the HubSpot UI to guide users on how to fill out the property.
PropertyDisplayOrder	integer	false	Defines the order in which this property appears in the UI relative to others. Lower numbers appear first; -1 positions the property after all others.
PropertyHasUniqueValue	boolean	false	Specifies whether the property value must be unique across all object records. Once enabled, this setting cannot be changed.
PropertyHidden	boolean	false	Specifies whether the property is hidden from the HubSpot user interface, preventing users from seeing or editing it directly.
PropertyType	string	true	Defines the data type of the property. Accepted types include string, number, date, enumeration, and datetime.
PropertyFieldType	string	true	Determines how the property is rendered in the HubSpot interface, such as text input, date picker, dropdown, or checkbox. Must be compatible with the specified PropertyType.
Options	string	false	Required only if PropertyType is set to enumeration. The input values should be a temporary table (#TEMP).

Input


Name	Type	Description
ObjectName	String	Unique identifier for the custom object type within the schema. This name must be unique and is used when referencing the object in the API.
ObjectLabelSingular	String	The singular form of the custom object's label, shown in the CRM interface to represent a single instance of the object.
ObjectLabelPlural	String	The plural form of the custom object's label, shown in the CRM interface to represent multiple instances of the object.
RequiredProperties	String	A comma-separated list of properties that must be populated when creating an instance of this custom object.
SearchableProperties	String	A comma-separated list of properties that is indexed by HubSpot and included in CRM-wide search functionality.
PrimaryDisplayProperty	String	Name of the main property shown as the object's primary identifier in HubSpot records.
SecondaryDisplayProperties	String	A comma-separated list of names of additional properties displayed as secondary information under the primary property on the object record page.
AssociatedObjects	String	A comma-separated list of Hubspot object names. Defines which other standard or custom objects can be associated with this custom object type.
Properties	String	The Properties for the object to be created. The input value must be a temporary table (#TEMP).

Result Set Columns


Name	Type	Description
Success	Boolean	Specifies whether the custom object was successfully created through the procedure.
ObjectName	String	Name of the custom object that was created, used for API and internal reference.
ObjectLabel	String	Plural label of the created custom object, used for display in the HubSpot interface.
ErrorCode	String	Numeric or symbolic code indicating the reason the procedure failed, if applicable.
ErrorMessage	String	Detailed message describing the error that occurred during the creation of the custom object.

CreateCustomProperty

Adds a custom property to a HubSpot object, enhancing CRM data flexibility.

Execute

When you need to create a new Property of type Enumeration you need to define its options (required).

There are two ways to do this. The first way is to feed all the json aggregate of the options directly to the options input, as shown below:

EXECUTE CreateCustomProperty
        TableName = 'DevObject',
        PropertyName = 'TestEnumeration',
        PropertyLabel = 'Test Enumeration',
        PropertyGroupName = 'group1',
        PropertyType = 'enumeration',
        PropertyFieldType = 'radio',
        Options = '[
                {
                    \"label\": \"Model-GT\",
                    \"value\": \"GT\",
                    \"description\": \"GT Model\",
                    \"displayOrder\": \"1\",
                    \"hidden\": \"true\"
                },
                {
                    \"label\": \"Model-AF\",
                    \"value\": \"AF\",
                    \"description\": \"AF Model\",
                    \"displayOrder\": \"2\",
                    \"hidden\": \"true\"
                },
                {
                    \"label\": \"Model-Z\",
                    \"value\": \"Z\",
                    \"description\": \"Z Model\",
                    \"displayOrder\": \"3\",
                    \"hidden\": \"true\"
                },
                {
                    \"label\": \"Model-0\",
                    \"value\": \"0\",
                    \"description\": \"0 Model\",
                    \"displayOrder\": \"4\",
                    \"hidden\": \"false\"
                }
            ]'

The second way is to make use of the Driver #TEMP tables for the aggregate value. To do that you need to execute the following:

INSERT INTO PropertyOptions#Temp (OptionLabel, OptionValue, OptionDescription, OptionDisplayOrder, OptionHidden) VALUES ('TRUE', 'true', 'Yes', 1, false)

INSERT INTO PropertyOptions#Temp (OptionLabel, OptionValue, OptionDescription, OptionDisplayOrder, OptionHidden) VALUES ('False', 'false', 'No', 2, false)

After creating the temporary table with the options, we can execute the stored procedure as shown below:

EXECUTE CreateCustomProperty
        TableName = 'Contacts',
        PropertyName = 'TestEnumeration',
        PropertyLabel = 'Test Enumeration',
        PropertyGroupName = 'contactinfomation',
        PropertyType = 'enumeration',
        PropertyFieldType = 'radio',
        Options = 'PropertyOptions#Temp'

PropertyOptions temporary table schema info:


Column Name	Type	Required	Description
OptionLabel	string	true	Human-readable label for an enumerated option. Required if PropertyFieldType is set to an option-based input like select or radio.
OptionValue	string	true	Internal value corresponding to the enumerated label. This value is used when setting the property through the API.
OptionDescription	string	false	Optional description for the enumerated option. Appears as help text to clarify the option's meaning or use.
OptionDisplayOrder	integer	false	Order in which this option appears in the UI. Lower positive integers appear first; -1 causes the option to appear last.
OptionHidden	boolean	false	Specifies whether the option should be hidden from the HubSpot interface. Hidden options can still be used via API.

Input


Name	Type	Description
ObjectFullyQualifiedName	String	Fully qualified name of the object where the custom property will be created. Required if TableName is not provided.
TableName	String	Exposed table name of the object where the property should be added. Required if ObjectFullyQualifiedName is not provided.
PropertyName	String	Internal name of the custom property. This value is used in API requests and must be unique within the object.
PropertyLabel	String	User-friendly label for the property, shown in the HubSpot interface wherever this property appears.
PropertyGroupName	String	Label for the group where this property will be organized in the HubSpot UI. Helps categorize properties logically.
PropertyType	String	Data type of the property, such as string, number, date, datetime, or enumeration. Determines how values are stored and validated.
PropertyFieldType	String	Defines how the property is rendered in the HubSpot UI. Supported field types include text, date picker, select dropdown, radio buttons, and checkboxes.
PropertyDescription	String	Optional help text shown to users when interacting with the property in the UI. Provides context or instructions.
PropertyDisplayOrder	Integer	Controls the position of the property within its group in the UI. Lower values are shown first; -1 places the property after all others.
PropertyHasUniqueValue	Boolean	Indicates whether the value of this property must be unique across all records of the object. Cannot be changed once enabled.
PropertyHidden	Boolean	Indicates whether the property is hidden from users in the HubSpot interface, but still available for automation or API usage.
FormField	Boolean	Indicates whether this property is available for inclusion in HubSpot forms, enabling data collection through public forms.
ObjectType	String	Optional classification of the object type this property belongs to, such as contact, company, or deal.
Options	String	Required only if PropertyType is set to enumeration. The input values should be an temporary table (#TEMP).

Result Set Columns


Name	Type	Description
Success	Boolean	Specifies whether the property was created successfully through the stored procedure.
PropertyName	String	Internal name of the custom property that was created.
PropertyLabel	String	User-facing label of the newly created property, displayed in the UI.
ErrorCode	String	Code representing the type of error that occurred, if the procedure did not complete successfully.
ErrorMessage	String	Detailed message describing the issue encountered during the creation of the custom property.

DeleteCustomObject

Deletes an existing custom object from HubSpot. private-app token authentication is recommended for insufficient OAuth scopes.

Input


Name	Type	Description
FullyQualifiedName	String	Fully qualified name of the custom object to delete, typically used when the object name includes the namespace. Required if TableName is not provided.
TableName	String	Exposed table name of the custom object to be deleted. Required if FullyQualifiedName is not provided.

Result Set Columns


Name	Type	Description
Success	Boolean	Returns True if the custom object is successfully deleted through the procedure.
ErrorCode	String	Code that identifies the type of error encountered during the deletion process, if the operation fails.
ErrorMessage	String	Detailed description of the error that occurred if the custom object could not be deleted.

DeleteCustomProperty

Removes a custom property from a HubSpot object, streamlining data fields.

Input


Name	Type	Description
ObjectFullyQualifiedName	String	Fully qualified name of the object that contains the property to be deleted. Required if TableName is not provided.
TableName	String	Exposed table name of the object from which the property should be deleted. Required if ObjectFullyQualifiedName is not provided.
PropertyName	String	Internal name of the custom property to be deleted. Required if ColumnName is not provided.
ColumnName	String	Exposed column name of the custom property to be deleted. Required if PropertyName is not provided.

Result Set Columns


Name	Type	Description
Success	Boolean	Returns True if the custom property was successfully deleted through the procedure.
ErrorCode	String	Code representing the specific error encountered during the deletion process, if applicable.
ErrorMessage	String	Descriptive message explaining why the property could not be deleted, returned if the procedure fails.

DeleteFile

Permanently deletes a file and all related metadata and thumbnails from HubSpot's file manager.

Input


Name	Type	Description
FileId	String	Unique identifier of the file to be deleted from the HubSpot file manager.

Result Set Columns


Name	Type	Description
Success	Boolean	Indicates whether the file deletion was successful. Returns True if the file was deleted.
ErrorCode	Integer	If the procedure fails, this field displays the corresponding error code. Useful for debugging and troubleshooting.
ErrorMessage	String	If the procedure fails, this field provides a detailed error message explaining the failure.

UpdateCustomObject

Updates an existing custom object in HubSpot. May require private-app token authentication due to OAuth scope limitations.

Input


Name	Type	Description
FullyQualifiedName	String	Fully qualified name of the custom object to update, including namespace if applicable. Required if TableName is not provided.
TableName	String	Exposed table name of the custom object to update. Required if FullyQualifiedName is not provided.
ObjectLabelSingular	String	Updated singular label for the custom object. This label appears in the CRM interface when displaying a single record of this object.
ObjectLabelPlural	String	Updated plural label for the custom object. This label is used in list views and when referring to multiple records in the CRM.
RequiredProperties	String	A comma-separated list of properties that must be set when creating records of this object type. These fields enforce data requirements in HubSpot forms and automation.
SearchableProperties	String	A comma-separated list of properties to be indexed by HubSpot's global search. These fields help users locate records based on specific property values.
PrimaryDisplayProperty	String	Property that serves as the primary identifier for records of this object type in the CRM. Displayed prominently on the record page.
SecondaryDisplayProperties	String	A comma-separated list of properties. Additional properties shown below the primary property in the record summary view. Helps provide quick insights at a glance.
Restorable	Boolean	Indicates whether deleted records of this object type can be recovered. Set to True to allow restoration from the recycle bin.

Result Set Columns


Name	Type	Description
Success	Boolean	Returns True if the update to the custom object is completed successfully.
ObjectName	String	Internal name of the updated object, used for reference in APIs and schema definitions.
ObjectLabel	String	Updated plural label for the object, used in CRM views and object listings.
ErrorCode	String	Code representing the type of error that occurred during the update, if applicable.
ErrorMessage	String	Descriptive message detailing the reason for failure, provided when the update operation is unsuccessful.

UpdateCustomProperty

Modifies an existing custom property for a HubSpot object, supporting data customization.

Execute

When you need to update a Property to type Enumeration, you need to define its options (required).

There are two ways to do this. The first way is to feed all the json aggregate of the options directly to the options input, as shown below:

EXECUTE UpdateCustomProperty
TableName = 'DevObject',
PropertyName = 'TestEnumeration',
PropertyLabel = 'Test Enumeration',
PropertyGroupName = 'contactinfomation',
PropertyType = 'enumeration',
PropertyFieldType = 'radio',
Options = '[
                {
                    \"label\": \"Model-GT\",
                    \"value\": \"GT\",
                    \"description\": \"GT Model\",
                    \"displayOrder\": \"1\",
                    \"hidden\": \"true\"
                },
                {
                    \"label\": \"Model-AF\",
                    \"value\": \"AF\",
                    \"description\": \"AF Model\",
                    \"displayOrder\": \"2\",
                    \"hidden\": \"true\"
                },
                {
                    \"label\": \"Model-Z\",
                    \"value\": \"Z\",
                    \"description\": \"Z Model\",
                    \"displayOrder\": \"3\",
                    \"hidden\": \"true\"
                },
                {
                    \"label\": \"Model-0\",
                    \"value\": \"0\",
                    \"description\": \"0 Model\",
                    \"displayOrder\": \"4\",
                    \"hidden\": \"false\"
                }
            ]'

The second way is to make use of the Driver #TEMP tables for the aggregate value. To do that, you need to execute the following:

INSERT INTO PropertyOptions#Temp (OptionLabel, OptionValue, OptionDescription, OptionDisplayOrder, OptionHidden) VALUES ('TRUE', 'true', 'Yes', 1, false)
INSERT INTO PropertyOptions#Temp (OptionLabel, OptionValue, OptionDescription, OptionDisplayOrder, OptionHidden) VALUES ('False', 'false', 'No', 2, false)

After creating the temporary table with the options, we can execute the stored procedure as shown below:

EXECUTE UpdateCustomProperty
TableName = 'Contacts',
PropertyName = 'TestEnumeration',
PropertyLabel = 'Test Enumeration',
PropertyGroupName = 'contactinfomation',
PropertyType = 'enumeration',
PropertyFieldType = 'radio',
Options = 'PropertyOptions#Temp'

PropertyOptions temporary table schema info:


Column Name	Type	Required	Description
OptionLabel	string	true	Human-readable label for an enumerated option. Required if PropertyFieldType is set to an option-based input like select or radio.
OptionValue	string	true	Internal value corresponding to the enumerated label. This value is used when setting the property through the API.
OptionDescription	string	false	Optional description for the enumerated option. Appears as help text to clarify the option's meaning or use.
OptionDisplayOrder	integer	false	Order in which this option appears in the UI. Lower positive integers appear first; -1 causes the option to appear last.
OptionHidden	boolean	false	Specifies whether the option should be hidden from the HubSpot interface. Hidden options can still be used via API.

Input


Name	Type	Description
ObjectFullyQualifiedName	String	Fully qualified name of the object containing the custom property to be updated. Required if TableName is not specified.
TableName	String	Exposed table name of the object containing the custom property to be updated. Required if ObjectFullyQualifiedName is not specified.
PropertyName	String	Internal name of the custom property to update. Required if ColumnName is not specified and used for API interactions.
ColumnName	String	Exposed column name of the property to update. Required if PropertyName is not specified and used in the SQL schema.
PropertyLabel	String	Updated human-readable label for the property, shown in the HubSpot UI wherever the property is displayed.
PropertyGroupName	String	Updated group name for organizing the property within the HubSpot interface. Helps users locate properties more easily.
PropertyDescription	String	Updated help text for the property that appears in the HubSpot UI to guide users when entering values.
PropertyDisplayOrder	Integer	Controls the visual ordering of the property relative to others in the UI. Lower values are shown first; -1 places it after all others.
PropertyHidden	Boolean	Determines whether the property is visible in the HubSpot UI. Hidden properties are available for API use and automation only.
PropertyType	String	Data type of the property, such as string, number, date, enumeration, or datetime. Determines how the property stores data.
PropertyFieldType	String	Controls how the property is rendered in the HubSpot interface. Must be compatible with the specified PropertyType.
FormField	Boolean	Indicates whether this property can be used in HubSpot forms to collect information from users.
Options	String	Required only if PropertyType is set to enumeration. The input values should be a temporary table (#TEMP).

Result Set Columns


Name	Type	Description
Success	Boolean	Specifies whether the property was successfully updated using the stored procedure.
PropertyName	String	Internal name of the updated property. Returned for confirmation and reference purposes.
PropertyLabel	String	Updated display label of the property, shown in the HubSpot CRM and related interfaces.
ErrorCode	String	Code indicating the type of error encountered if the property update fails.
ErrorMessage	String	Detailed message explaining why the property update failed, returned if the operation is unsuccessful.

HubSpot V4 データモデル

The CData Cloud models HubSpot CRM API v4 data as an easy-to-use SQL database. There are three parts to the data model: tables, views, and stored procedures.

Tables

The テーブル section, which details standard SQL tables, and the ビュー section, which lists read-only SQL tables, contain samples of what you might have access to in your HubSpot account.

Common tables include:


Table	Description
Contacts	Lists all contacts in HubSpot, supporting both OAuth and private-app token authentication methods.
Companies	Lists all company records in HubSpot, supporting both OAuth and private-app token authentication methods.
Deals	Lists all deal records in HubSpot, supporting both OAuth and private-app token authentication methods.
Leads	Lists all lead records available in HubSpot, supporting lead management workflows.
Tickets	Lists all ticket records in HubSpot, supporting both OAuth and private-app token authentication methods.
EngagementsCalls	Retrieves all call engagement records in HubSpot, used for tracking customer communication.
EngagementsEmails	Retrieves all email engagement records in HubSpot for analyzing customer email interactions.
EngagementsMeetings	Lists all meeting engagement records in HubSpot, useful for scheduling and meeting tracking.
EngagementsNotes	Retrieves note engagement records in HubSpot, used for logging internal or customer notes.
EngagementsTasks	Lists all task engagement records in HubSpot for managing customer relationship management (CRM) related tasks.
Lineitems	Lists all line item records in HubSpot, supporting both OAuth and private-app token authentications.
Products	Lists all product records configured in HubSpot, supporting both OAuth and private-app token authentications.
Quotes	Lists all quote records in HubSpot, useful for sales proposal management.
Orders	Lists all order records in HubSpot for managing order workflows.
Goals	Retrieves all goal records configured in HubSpot, supporting goal tracking and performance management.
ContactsToDealsAssociations	Returns deal IDs associated with specific contacts, useful for tracking contact-to-deal relationships.
ContactAssociations	Returns object IDs associated with specific contacts, enabling management of contact relationships to deals and other objects.
CompanyAssociations	Returns object IDs associated with specific companies, useful for managing associations to deals and other CRM objects.
TicketAssociations	Returns object IDs associated with specific tickets, supporting customer support case associations.
DealAssociations	Lists object IDs associated with specific deals, supporting deal-to-object relationships management.

The Cloud uses the HubSpot API to process supported filters. The Cloud processes other filters client-side within the Cloud.

Stored Procedures

ストアドプロシージャ are actions that are invoked via SQL queries. They perform tasks beyond standard create, read, update, delete (CRUD) operations, including managing OAuth tokens.

テーブル

Cloud はHubSpot のデータを、標準のSQL ステートメントを使用してクエリできるリレーショナルデータベースのテーブルのリストとしてモデル化します。

CData Cloud - HubSpot テーブル


Name	Description
AppointmentAssociations	Retrieve the IDs of all the objects associated to specific Appointments objects in HubSpot.
Appointments	Retrieve the available Appointments in HubSpot.
Companies	Lists all company records in HubSpot, supporting both OAuth and private-app token authentication methods.
CompanyAssociations	Returns object IDs associated with specific companies, useful for managing associations to deals and other CRM objects.
ContactAssociations	Returns object IDs associated with specific contacts, enabling management of contact relationships to deals and other objects.
Contacts	Lists all contacts in HubSpot, supporting both OAuth and private-app token authentication methods.
ContactsToDealsAssociations	Returns deal IDs associated with specific contacts, useful for tracking contact-to-deal relationships.
CourseAssociations	Retrieve the IDs of all the objects associated to specific Courses objects in HubSpot.
Courses	Retrieve the available Courses in HubSpot.
DealAssociations	Lists object IDs associated with specific deals, supporting deal-to-object relationships management.
Deals	Lists all deal records in HubSpot, supporting both OAuth and private-app token authentication methods.
EngagementsCalls	Retrieves all call engagement records in HubSpot, used for tracking customer communication.
EngagementsEmails	Retrieves all email engagement records in HubSpot for analyzing customer email interactions.
EngagementsMeetings	Lists all meeting engagement records in HubSpot, useful for scheduling and meeting tracking.
EngagementsNotes	Retrieves note engagement records in HubSpot, used for logging internal or customer notes.
EngagementsTasks	Lists all task engagement records in HubSpot for managing CRM-related tasks.
FeedbackSubmissionAssociations	Returns object IDs associated with specific feedback submissions, useful for feedback association tracking.
InvoiceAssociations	Retrieve the IDs of all the objects associated to specific Invoices objects in HubSpot.
Invoices	Retrieve the available Invoices in HubSpot.
LeadAssociations	Returns object IDs associated with specific leads, enabling management of lead associations.
Leads	Lists all lead records available in HubSpot, supporting lead management workflows.
LineitemAssociations	Returns object IDs associated with specific line items in HubSpot, supporting deal line item relationships.
Lineitems	Lists all line item records in HubSpot, supporting both OAuth and private-app token authentications.
ListingAssociations	Retrieve the IDs of all the objects associated to specific Listings objects in HubSpot.
Listings	Retrieve the available Listings in HubSpot.
OrderAssociations	Returns object IDs associated with specific order records, enabling order association tracking.
Orders	Lists all order records in HubSpot for managing order workflows.
Products	Lists all product records configured in HubSpot, supporting both OAuth and private-app token authentications.
QuoteAssociations	Returns object IDs associated with specific quotes in HubSpot for managing quote associations.
Quotes	Lists all quote records in HubSpot, useful for sales proposal management.
ServiceAssociations	Retrieve the IDs of all the objects associated to specific Services objects in HubSpot.
Services	Retrieve the available Services in HubSpot.
TicketAssociations	Returns object IDs associated with specific tickets, supporting customer support case associations.
Tickets	Lists all ticket records in HubSpot, supporting both OAuth and private-app token authentication methods.

AppointmentAssociations

Retrieve the IDs of all the objects associated to specific Appointments objects in HubSpot.

Table Specific Information

The AppointmentAssociations table provides access to the relationship data between appointment records and other HubSpot objects such as contacts, companies, deals, and tickets.

SELECT

When selecting appointment associations, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM AppointmentAssociations WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'
SELECT * FROM AppointmentAssociations WHERE Type = 'contacts'

INSERT

INSERT INTO AppointmentAssociations (ID, AssociationId, Type) VALUES ('25151', '12345', 'contacts')

DELETE

DELETE FROM AppointmentAssociations WHERE ID = '25151' AND AssociationId = '12345'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Appointments.Id	False	Appointments ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Appointments object is associated with.
Type [KEY]	String	False		False	Type of the associated object, which can be a contact, deal etc.
TypeId [KEY]	String	False		False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False		False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.
TypeLabel	String	True		False	The label assigned to the association type between objects.

Appointments

Retrieve the available Appointments in HubSpot.

Table Specific Information

In HubSpot, appointments represent scheduled meetings, consultations, or other time-based interactions with contacts or prospects. Appointment records help users track and manage scheduled activities through pipeline stages.

SELECT

When selecting appointments, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Appointments WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'

INSERT

INSERT INTO Appointments ([Appointment Name]) VALUES ('Client Consultation')

UPDATE

UPDATE Appointments SET [Appointment Name] = 'Updated Consultation' WHERE ID = '25151'

DELETE

DELETE FROM Appointments WHERE ID = '25151'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Appointment End	Datetime	False		True	Date and time when the appointment ends.
Appointment Name	String	False		True	Name or title of the appointment.
Appointment Start	Datetime	False		True	Date and time when the appointment begins.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Date entered 'In Progress (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'In Progress' stage, 'Appointment Pipeline' pipeline.
Date entered 'Canceled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Canceled' stage, 'Appointment Pipeline' pipeline.
Date entered 'Scheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Scheduled' stage, 'Appointment Pipeline' pipeline.
Date entered 'Rescheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Rescheduled' stage, 'Appointment Pipeline' pipeline.
Date entered 'Completed (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment entered the 'Completed' stage, 'Appointment Pipeline' pipeline.
Date exited 'In Progress (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'In Progress' stage, 'Appointment Pipeline' pipeline.
Date exited 'Canceled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Canceled' stage, 'Appointment Pipeline' pipeline.
Date exited 'Scheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Scheduled' stage, 'Appointment Pipeline' pipeline.
Date exited 'Rescheduled (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Rescheduled' stage, 'Appointment Pipeline' pipeline.
Date exited 'Completed (Appointment Pipeline)'	Datetime	True		True	The date and time when the Appointment exited the 'Completed' stage, 'Appointment Pipeline' pipeline.
Duration	Decimal	True		True	Total length of the appointment.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Owning Teams	String	False		False	The teams that are attributed to this record.
Pipeline	String	False		False	The pipeline that contains this appointment.
Pipeline Stage	String	False		False	The pipeline stage that contains this appointment.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	False		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	False		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Time in 'In Progress (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'In Progress' stage, 'Appointment Pipeline' pipeline.
Time in 'Canceled (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Canceled' stage, 'Appointment Pipeline' pipeline.
Time in 'Scheduled (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Scheduled' stage, 'Appointment Pipeline' pipeline.
Time in 'Rescheduled (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Rescheduled' stage, 'Appointment Pipeline' pipeline.
Time in 'Completed (Appointment Pipeline)'	Decimal	True		True	The total time in seconds spent by the Appointment in the 'Completed' stage, 'Appointment Pipeline' pipeline.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	Object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.
Test Label	String	False		True	This column is a custom field.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

Companies

Lists all company records in HubSpot, supporting both OAuth and private-app token authentication methods.

Table Specific Information

In HubSpot, company records store information about a business or organization.

SELECT

When selecting companies, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Companies WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM Companies WHERE Archived = TRUE;

INSERT

INSERT INTO Companies ([About Us]) VALUES ('description')

UPDATE

UPDATE Companies SET [About Us] = 'new description' WHERE ID = '3917882265'

DELETE

DELETE FROM Companies WHERE ID = '3917882265'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique numeric identifier for the company record.
Archived	Bool	True		True	Indicates whether the company record is archived and no longer actively managed.
CreatedAt	Datetime	True		False	Timestamp marking when the company record was first created in HubSpot.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update made to the company record.
ItemURL	String	True		False	Direct URL linking to the company's record within HubSpot for quick access.
About Us	String	False		False	Short description or mission statement summarizing the company's purpose.
ClosedateTimestampEarliestValue	Datetime	True		False	Earliest closed deal date across all contacts associated with the company, calculated via rollup.
Facebook Fans	Decimal	False		False	Total number of Facebook followers or fans associated with the company's official page.
FirstContactCreatedateTimestampEarliestValue	Datetime	True		False	Timestamp of the earliest contact creation date linked to this company, calculated via rollup.
First Conversion Date	Datetime	True		False	Date of the first conversion event (such as a form submission) across any contact associated with the company.
FirstConversionDateTimestampEarliestValue	Datetime	True		False	Timestamp showing the earliest recorded conversion date across contacts associated with the company.
First Conversion	String	True		False	The first form or event that a contact associated with the company converted on.
FirstConversionEventNameTimestampEarliestValue	Datetime	True		False	Timestamp of the earliest recorded first conversion event name for contacts associated with this company.
First Deal Created Date	Datetime	True		False	Date when the first deal was created and linked to the company.
Year Founded	String	False		False	Year when the company was founded, sourced automatically by HubSpot Insights.
Additional Domains	String	False		False	List of additional domains owned by the company, if applicable.
Business units	String	False		False	Business units assigned to the company for segmentation and reporting.
Time First Seen	Datetime	True		False	Timestamp of the first recorded activity by any contact associated with the company.
HsAnalyticsFirstTimestampTimestampEarliestValue	Datetime	True		False	Earliest timestamp for a recorded activity across contacts associated with the company, based on rollup.
First Touch Converting Campaign	String	True		False	Marketing campaign responsible for the first touch conversion of the first associated contact.
HsAnalyticsFirstTouchConvertingCampaignTimestampEarliestValue	Datetime	True		False	Timestamp showing the earliest first-touch converting campaign across associated contacts.
Time of First Session	Datetime	True		False	Timestamp of the first session logged by any contact linked to the company.
HsAnalyticsFirstVisitTimestampTimestampEarliestValue	Datetime	True		False	Earliest recorded timestamp for the first session involving any associated contact.
Time Last Seen	Datetime	True		False	Timestamp of the most recent activity recorded by any contact associated with the company.
HsAnalyticsLastTimestampTimestampLatestValue	Datetime	True		False	Latest recorded activity timestamp across associated contacts, aggregated through rollup.
Last Touch Converting Campaign	String	True		False	Marketing campaign responsible for the last-touch conversion of the first associated contact.
HsAnalyticsLastTouchConvertingCampaignTimestampLatestValue	Datetime	True		False	Timestamp of the most recent last-touch converting campaign across associated contacts.
Time of Last Session	Datetime	True		False	Timestamp of the most recent session logged by any contact associated with the company.
HsAnalyticsLastVisitTimestampTimestampLatestValue	Datetime	True		False	Timestamp providing the latest session recorded across all associated contacts.
Latest Source	String	True		False	Source of the most recent session recorded by contacts linked to the company, such as Direct Traffic or Paid Social.
Latest Source Data 1	String	True		False	Additional details about the source of the most recent session for associated contacts.
Latest Source Data 2	String	True		False	Further descriptive details regarding the latest session source for contacts linked to the company.
Latest Source Timestamp	Datetime	True		False	Timestamp showing when the most recent source interaction occurred across associated contacts.
Number of Pageviews	Decimal	True		False	Total number of website pageviews recorded across contacts associated with the company.
HsAnalyticsNumPageViewsCardinalitySum	Decimal	True		False	Aggregated total pageviews for all associated contacts, calculated by summing rollups.
Number of Sessions	Decimal	True		False	Total number of website sessions recorded across contacts linked to the company.
HsAnalyticsNumVisitsCardinalitySum	Decimal	True		False	Aggregated number of sessions across all associated contacts, based on a rollup calculation.
Original Source Type	String	False		False	Original source category for the earliest recorded activity by a contact associated with the company, such as Organic Search or Direct Traffic.
Original Source Data 1	String	True		False	Additional descriptive information related to the original source for the earliest recorded activity.
HsAnalyticsSourceData1TimestampEarliestValue	Datetime	True		False	Timestamp for the earliest occurrence of original source data 1 across associated contacts.
Original Source Data 2	String	True		False	Supplementary descriptive information providing more context about the original source of the earliest contact activity.
HsAnalyticsSourceData2TimestampEarliestValue	Datetime	True		False	Timestamp for the earliest occurrence of original source data 2 across associated contacts.
HsAnalyticsSourceTimestampEarliestValue	Datetime	True		False	Earliest timestamp indicating when the original source type was recorded for any associated contact.
Avatar FileManager key	String	True		False	Path to the company's avatar image stored in HubSpot's FileManager CDN. Set automatically.
Created by user ID	Decimal	True		False	ID of the user who originally created the company record. Automatically assigned by HubSpot.
Object create date_time	Datetime	True		False	Timestamp of the company's creation. Automatically populated and not manually editable.
Date entered Customer (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company entered the 'Customer' stage of the Lifecycle Stage Pipeline.
Date entered Evangelist (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company entered the 'Evangelist' stage of the Lifecycle Stage Pipeline.
Date entered Lead (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company entered the 'Lead' stage of the Lifecycle Stage Pipeline.
Date entered Marketing Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company entered the 'Marketing Qualified Lead' stage of the Lifecycle Stage Pipeline.
Date entered Opportunity (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company entered the 'Opportunity' stage of the Lifecycle Stage Pipeline.
Date entered Other (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company entered the 'Other' stage of the Lifecycle Stage Pipeline.
Date entered Sales Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company entered the 'Sales Qualified Lead' stage of the Lifecycle Stage Pipeline.
Date entered Subscriber (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company entered the 'Subscriber' stage of the Lifecycle Stage Pipeline.
Date exited Customer (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company exited the 'Customer' stage of the Lifecycle Stage Pipeline.
Date exited Evangelist (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company exited the 'Evangelist' stage of the Lifecycle Stage Pipeline.
Date exited Lead (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company exited the 'Lead' stage of the Lifecycle Stage Pipeline.
Date exited Marketing Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company exited the 'Marketing Qualified Lead' stage of the Lifecycle Stage Pipeline.
Date exited Opportunity (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company exited the 'Opportunity' stage of the Lifecycle Stage Pipeline.
Date exited Other (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company exited the 'Other' stage of the Lifecycle Stage Pipeline.
Date exited Sales Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company exited the 'Sales Qualified Lead' stage of the Lifecycle Stage Pipeline.
Date exited Subscriber (Lifecycle Stage Pipeline)	Datetime	True		False	Date and time when the company exited the 'Subscriber' stage of the Lifecycle Stage Pipeline.
Ideal Customer Profile Tier	String	False		False	Classification of how closely the company matches your Ideal Customer Profile, typically Tier 1, Tier 2, or Tier 3.
Target Account	Bool	False		False	Indicates whether the company is designated as a target account for account-based marketing efforts.
Last Booked Meeting Date	Datetime	True		False	Date when the most recent meeting was booked with any contact associated with the company.
Last Logged Call Date	Datetime	True		False	Date when the most recent call was logged for any contact linked to the company.
Last Open Task Date	Datetime	True		False	Due date of the most recently opened task assigned to the company or associated contacts.
last sales activity date old	Datetime	True		False	Timestamp in seconds of the most recent sales activity involving the company. Used in legacy tracking.
Last Engagement Date	Datetime	True		False	Timestamp of the most recent engagement action, such as a form submission or meeting, excluding marketing emails.
Last Engagement Type	String	True		False	Type of the most recent engagement performed by a contact at the company, excluding bulk marketing emails.
Last Modified Date	Datetime	True		False	Timestamp of the latest property update made to the company record, including hidden and visible properties.
Latest create date of active subscriptions	Datetime	True		False	Timestamp when the most recent active subscription linked to this company was created.
Merged object IDs	String	True		False	List of company record IDs that have been merged into this record. Set automatically by HubSpot.
Number of blockers	Decimal	True		False	Total number of associated contacts at this company who are classified as blockers in the sales process.
Number of contacts with a buying role	Decimal	True		False	Total number of contacts associated with this company who have a designated buying role.
Number of decision makers	Decimal	True		False	Total number of contacts linked to this company who are marked as decision makers.
Number of open deals	Decimal	True		False	Total number of open deals currently associated with this company.
Record ID	Decimal	True		False	Unique ID assigned automatically to the company record in HubSpot.
Pinned Engagement ID	Decimal	True		False	ID of the engagement pinned at the top of the company's timeline for easy reference. Set automatically.
Pipeline	String	False		False	Pipeline associated with the company, often used for account-based sales processes.
Likelihood to close	Decimal	True		False	Calculated probability that a contact linked to this company will convert to a customer within the next 90 days.
HsPredictivecontactscoreV2NextMaxMax	Decimal	True		False	Maximum predictive lead score aggregated from all contacts associated with this company.
Read Only Object	Bool	True		False	Indicates whether this company record is read-only and cannot be manually edited.
Target Account2	String	False		False	Secondary field indicating target account status based on different account-based marketing programs.
Target Account Probability	Decimal	True		False	Probability score indicating how likely the company is to qualify as a target account.
Target Account Recommendation Snooze Time	Datetime	False		False	Timestamp recording when a recommendation to target this company was snoozed.
Target Account Recommendation State	String	False		False	Current recommendation status for targeting the company, such as Active or Snoozed.
Time in Customer (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the company spent in the 'Customer' stage of the Lifecycle Stage Pipeline.
Time in Evangelist (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the company spent in the 'Evangelist' stage of the Lifecycle Stage Pipeline.
Time in Lead (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the company spent in the 'Lead' stage of the Lifecycle Stage Pipeline.
Time in Marketing Qualified Lead (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the company spent in the 'Marketing Qualified Lead' stage of the Lifecycle Stage Pipeline.
Time in Opportunity (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the company spent in the 'Opportunity' stage of the Lifecycle Stage Pipeline.
Time in Other (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the company spent in the 'Other' stage of the Lifecycle Stage Pipeline.
Time in Sales Qualified Lead (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the company spent in the 'Sales Qualified Lead' stage of the Lifecycle Stage Pipeline.
Time in Subscriber (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the company spent in the 'Subscriber' stage of the Lifecycle Stage Pipeline.
Total open deal value	Decimal	True		False	Sum of the values of all open deals linked to the company, calculated in the company's default currency.
Unique creation key	String	True		False	Property used to uniquely identify the company during import or integration processes to avoid duplicates.
Updated by user ID	Decimal	True		False	User ID of the last user who updated the company record. Set automatically by HubSpot.
User IDs of all notification followers	String	True		False	List of user IDs who opted to receive notifications about updates to this company.
User IDs of all notification unfollowers	String	True		False	List of user IDs who opted out of receiving notifications about updates to this company.
User IDs of all owners	String	True		False	List of all owner user IDs assigned to this company.
Owner Assigned Date	Datetime	True		False	Timestamp of the most recent assignment of an owner to this company record.
Is Public	Bool	False		False	Indicates whether the company is publicly traded, as determined by HubSpot Insights or user input.
Number of Associated Contacts	Decimal	True		False	Total number of contact records currently linked to this company.
Number of Associated Deals	Decimal	True		False	Total number of deal records currently associated with this company.
Number of Form Submissions	Decimal	True		False	Total number of form submissions completed by contacts associated with this company.
NumConversionEventsCardinalitySum	Decimal	True		False	Aggregated sum of all conversion events across contacts linked to this company, calculated via rollup.
Recent Conversion Date	Datetime	True		False	Most recent date a conversion event, such as a form submission, was completed by a contact associated with the company.
RecentConversionDateTimestampLatestValue	Datetime	True		False	Timestamp of the most recent conversion event aggregated across all associated contacts.
Recent Conversion	String	True		False	Name of the most recent form or event submitted by a contact associated with this company.
RecentConversionEventNameTimestampLatestValue	Datetime	True		False	Timestamp of the latest recorded event name for a recent conversion associated with this company.
Recent Deal Amount	Decimal	True		False	Monetary amount of the most recently closed deal associated with the company.
Recent Deal Close Date	Datetime	True		False	Date when the most recent deal associated with this company was marked as closed-won.
Time Zone	String	False		False	Time zone associated with the company's primary address, populated via HubSpot Insights if available.
Total Money Raised	String	False		False	Total amount of capital raised by the company, based on external data sources such as HubSpot Insights.
Total Revenue	Decimal	True		False	Sum of all revenue from closed-won deals associated with the company.
Company name	String	False		False	Official name of the company as stored in HubSpot.
HubSpot Owner Email	String	False		False	Email address of the HubSpot user assigned as the primary owner of the company.
Twitter Handle	String	False		False	Primary Twitter username or handle associated with the company.
HubSpot Owner Name	String	False		False	Full name of the HubSpot user assigned as the company's owner.
Phone Number	String	False		False	Primary phone number for the company, typically populated from HubSpot Insights or manually entered.
Twitter Bio	String	False		False	Biography text pulled from the company's Twitter profile.
Twitter Followers	Decimal	False		False	Total number of followers on the company's official Twitter account.
Street Address	String	False		False	Street address of the company, including building, suite, or unit number if applicable.
Street Address 2	String	False		False	Additional address information for the company such as a second line for building or floor information.
Facebook Company Page	String	False		False	URL link to the company's official Facebook page.
City	String	False		False	City where the company's headquarters or main office is located.
LinkedIn Company Page	String	False		False	URL link to the company's LinkedIn page.
LinkedIn Bio	String	False		False	Company description as displayed on its LinkedIn profile.
State_Region	String	False		False	State, province, or region where the company is located.
Google Plus Page	String	False		False	URL link to the company's Google Plus page (historical, for older records).
Date of last meeting booked in meetings tool	Datetime	True		False	Date of the last meeting scheduled by an associated contact via HubSpot's meetings tool.
Campaign of last booking in meetings tool	String	True		False	UTM campaign parameter representing the marketing campaign that led to the last meeting booked.
Medium of last booking in meetings tool	String	True		False	UTM medium parameter indicating the marketing channel, such as email or social media, responsible for the last meeting booking.
Source of last booking in meetings tool	String	True		False	UTM source parameter indicating the site or platform, such as LinkedIn or Twitter, that referred the contact for their most recent meeting.
Latest meeting activity	Datetime	True		False	Timestamp of the most recent meeting—past or upcoming—logged, booked, or scheduled with any contact at the company.
Recent Sales Email Replied Date	Datetime	True		False	Date when the most recent reply to a tracked sales email was received from the company.
Company owner	String	False		False	Name of the HubSpot user assigned as the owner of the company record.
Last Contacted	Datetime	True		False	Timestamp when the last call, one-to-one email, or meeting was logged for this company.
Last Activity Date	Datetime	True		False	Timestamp when the most recent note, call, email, meeting, or task was logged for the company.
Next Activity Date	Datetime	True		False	Scheduled date for the next sales activity associated with this company, such as a call or meeting.
Number of times contacted	Decimal	True		False	Total number of communication attempts, such as calls, emails, or meetings, logged for the company.
Number of Sales Activities	Decimal	True		False	Total number of sales-related activities recorded for the company, including calls and meetings.
Postal Code	String	False		False	Postal or ZIP code associated with the company's primary business address.
Country_Region	String	False		False	Country or region where the company's main office is located.
HubSpot Team	String	True		False	Name of the HubSpot team assigned to the company's primary owner.
All owner ids	String	True		False	List of owner property IDs, including default and custom, assigned to the company.
Website URL	String	False		False	Official website URL of the company, used for engagement and deduplication purposes.
Company Domain Name	String	False		False	Primary domain name associated with the company, used to link records and deduplicate companies.
All team ids	String	True		False	List of team IDs associated with ownership of the company, including default and custom teams.
All accessible team ids	String	True		False	List of team IDs, including inherited teams, that can access the company's ownership properties.
Number of Employees	Decimal	False		False	Total number of employees working at the company, based on HubSpot Insights or user entry.
Industry	String	False		False	Industry sector in which the company operates, based on predefined categories or custom entries.
Annual Revenue	Decimal	False		False	Annual revenue generated by the company, either provided manually or sourced from HubSpot Insights.
Lifecycle Stage	String	False		False	Stage representing the company's current sales or marketing qualification, such as Lead, Customer, or Evangelist.
Lead Status	String	False		False	Sales status assigned to the company, typically used during prospecting and qualification processes.
Parent Company	Decimal	True		False	Record ID of the parent company associated with this company if part of a corporate hierarchy.
Type	String	False		False	Optional classification indicating the type of company, such as Partner, Prospect, Customer, or Reseller.
Description	String	False		False	Brief narrative or summary describing the company's business or background.
Number of child companies	Decimal	True		False	Number of child company records linked to this parent company record.
HubSpot Score	Decimal	True		False	Score representing the company's sales-readiness, calculated based on engagement and profile attributes.
Create Date	Datetime	True		False	Timestamp marking when the company was created in HubSpot.
Close Date	Datetime	False		False	Date when the company was marked as a customer within HubSpot.
First Contact Create Date	Datetime	True		False	Date when the first contact associated with this company was created.
Days to Close	Decimal	True		False	Number of days elapsed between when the company record was created and when it was marked as a customer.
Web Technologies	String	False		False	List of web technologies detected on the company's website, such as CRM platforms, marketing tools, or analytics services.

CompanyAssociations

Returns object IDs associated with specific companies, useful for managing associations to deals and other CRM objects.

Table-Specific Information

SELECT

The CompanyAssociations table includes a fixed set of columns, but some return NULL unless you filter by Id and Type which allows the Cloud to retrieve full association details.

To return full details for Company associations, filter by both the Company Id and the association Type. The Type identifies the associated object (such as a Deal, Contact, or Ticket).

-- Retrieve all fields for associations between a specific Company and its Deals
SELECT *
FROM CompanyAssociations
WHERE Id = '436648510605'   -- Company Id
  AND Type = 'Deal';        -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each Company.

DELETE

To remove a Company association, include both the Company Id and the association Type:

-- Delete a Company-Deal association
DELETE FROM CompanyAssociations
WHERE Id = '436648510605'   -- Company Id
  AND Type = 'Deal';        -- Associated object type

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Companies.Id	False	Unique identifier of the company object involved in the association.
AssociationId [KEY]	Long	False		False	Unique identifier of the object associated with the company, such as a contact, deal, or ticket.
Type [KEY]	String	False		False	Type of the associated object, such as contact, deal, or ticket.
TypeId [KEY]	String	False	AssociationsLabels.TypeId	False	Numeric ID representing the specific association type between the company and the associated object. Empty for generic association queries.
Category [KEY]	String	False	AssociationsLabels.Category	False	Category describing the association relationship between the company and the associated object. Empty for generic association queries.
TypeLabel	String	True	AssociationsLabels.Label	False	Label name representing the association relationship between the company and the associated object.

ContactAssociations

Returns object IDs associated with specific contacts, enabling management of contact relationships to deals and other objects.

Table-Specific Information

SELECT

The ContactAssociations table always includes the same set of columns, but some return NULL unless you filter by Id and Type, which allows the Cloud to retrieve full association details.

To return full details for Contact associations, filter by both the Contact Id and the association Type. The Type identifies the associated object (such as a Deal, Company, or Ticket).

For example:

-- Retrieve all fields for associations between a specific Contact and its Deals
SELECT *
FROM ContactAssociations
WHERE Id = '3432'      -- Contact Id
  AND Type = 'Deal';   -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each Contact.

INSERT

To add a new association between a Contact and another record, provide the Contact Id, the associated object's Id, and the associated object Type. For custom association types, also include TypeId and Category.

-- Insert a new Contact-Deal association
INSERT INTO ContactAssociations (Id, AssociationId, Type)
VALUES ('3432', '34654', 'Deal');

-- Insert a custom Contact-Deal association
INSERT INTO ContactAssociations (Id, AssociationId, Type, TypeId, Category)
VALUES ('3432', '34654', 'Deal', '1', 'USER_DEFINED');

DELETE

To remove a Contact association, include the Contact Id, the associated object Id, and the association Type. For custom objects, you must specify the object's FullyQualifiedName as the Type. For custom association types, also include TypeId and Category.

-- Delete a Contact-Deal association
DELETE FROM ContactAssociations
WHERE Id = '3432'             -- Contact Id
  AND AssociationId = '34654' -- Deal Id
  AND Type = 'Deal';

-- Delete a Contact-custom object association
DELETE FROM ContactAssociations
WHERE Id = '3432'
  AND AssociationId = '9999'
  AND Type = 'customobject_myobject';  -- FullyQualifiedName

-- Delete a custom Contact-Deal association
DELETE FROM ContactAssociations
WHERE Id = '3432'
  AND AssociationId = '34654'
  AND Type = 'Deal'
  AND TypeId = '1'
  AND Category = 'USER_DEFINED';

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Contacts.Id	False	Unique identifier for the contact.
AssociationId [KEY]	Long	False		False	Identifier of the object that this contact is associated with, such as a deal or company.
Type [KEY]	String	False		False	The type of the associated object, such as contact, deal, company, or ticket.
TypeId [KEY]	String	False	AssociationsLabels.TypeId	False	The numeric ID representing the association type. This field is blank for general associations queries.
Category [KEY]	String	False	AssociationsLabels.Category	False	The category of the association type for the specified object pair. This field is blank for general associations queries.
TypeLabel	String	True	AssociationsLabels.Label	False	The label that describes the relationship between the contact and the associated object.

Contacts

Lists all contacts in HubSpot, supporting both OAuth and private-app token authentication methods.

Table Specific Information

In HubSpot, contacts store information about an individual. From marketing automation to smart content, the lead-specific data found in contact records helps users leverage much of HubSpot's functionality.

SELECT

When selecting contacts, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Contacts WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM Contacts WHERE Archived = TRUE;

INSERT

INSERT INTO Contacts ([Field of study]) VALUES ('uni')

UPDATE

UPDATE Contacts SET [Field of study] = 'new uni' WHERE ID = '25151'

DELETE

DELETE FROM Contacts WHERE ID = '25151'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier for the contact record.
Archived	Bool	True		True	Indicates whether the contact record is archived and no longer actively used.
CreatedAt	Datetime	True		False	Timestamp marking when the contact record was created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the contact record.
ItemURL	String	True		False	Direct URL linking to the contact's record within HubSpot.
Company size	String	False		False	Size classification of the contact's company, required for Facebook Ads Integration and synced automatically from Lead Ads.
Date of birth	String	False		False	Date of birth of the contact, required for Facebook Ads Integration and synced automatically from Lead Ads.
Days To Close	Decimal	True		False	Number of days from contact creation until the contact was closed as a customer, set automatically.
Degree	String	False		False	Academic degree of the contact, required for Facebook Ads Integration and synced automatically from Lead Ads.
Field of study	String	False		False	Academic field of study of the contact, required for Facebook Ads Integration and synced automatically from Lead Ads.
First Conversion Date	Datetime	True		False	Date when the contact first submitted a form or performed a conversion action.
First Conversion	String	True		False	First form or conversion event submitted by the contact.
First Deal Created Date	Datetime	True		False	Date when the first deal was created and associated with the contact.
Gender	String	False		False	Gender of the contact, required for Facebook Ads Integration and synced automatically from Lead Ads.
Graduation date	String	False		False	Graduation date of the contact, required for Facebook Ads Integration and synced automatically from Lead Ads.
Additional email addresses	String	True		False	List of additional email addresses associated with the contact.
Business units	String	False		False	Business units to which this contact record is assigned.
All vids for a contact	String	True		False	Set of all visitor IDs (VIDs), including canonical and merged VIDs, linked to the contact.
First Touch Converting Campaign	String	True		False	Marketing campaign responsible for the first-touch creation of this contact.
Last Touch Converting Campaign	String	True		False	Marketing campaign responsible for the last-touch creation of this contact.
Avatar FileManager key	String	True		False	File path in HubSpot's FileManager CDN for the contact's avatar override image, managed automatically.
Buying Role	String	False		False	Role the contact plays in the sales process. Contacts can have multiple or shared roles.
All form submissions for a contact	String	True		False	List of all form submissions made by the contact.
Merged vids with timestamps of a contact	String	True		False	Merged visitor IDs (VIDs) along with their merge timestamps for the contact.
Calculated Mobile Number in International Format	String	True		False	Mobile phone number of the contact formatted in international dialing format.
Calculated Phone Number in International Format	String	True		False	Primary phone number of the contact formatted in international dialing format.
Calculated Phone Number Area Code	String	True		False	Area code extracted from the contact's primary phone number.
Calculated Phone Number Country Code	String	True		False	Country code extracted from the contact's primary phone number.
Calculated Phone Number Region	String	True		False	ISO2 country code derived from the contact's phone number region.
Clicked on a LinkedIn Ad	String	False		False	Indicates whether the contact has clicked on a LinkedIn ad.
Email Confirmed	Bool	True		False	Indicates whether the contact's email address has been confirmed for content membership.
Registration Follow Up Email Enqueued At	Datetime	False		False	Timestamp of when the first registration follow-up email for content membership was queued.
Membership Notes	String	False		False	Notes related to the contact's content membership.
Registered At	Datetime	True		False	Datetime when the contact was registered for content membership.
Domain to which registration email was sent	String	True		False	Email domain to which the content membership registration invitation was sent.
Time registration email was sent	Datetime	True		False	Datetime when the content membership registration invitation email was sent.
Status	String	False		False	Status of the contact's content membership.
Conversations visitor email	String	True		False	Email address provided by the visitor during a Conversations session.
Count of unengaged contacts	Decimal	True		False	Set to 1 if the contact is assigned but not engaged; set to 0 if assigned and engaged.
Count of engaged contacts	Decimal	True		False	Set to 1 if the contact is assigned and engaged; set to 0 if assigned but unengaged.
Created By Conversations	Bool	True		False	Indicates whether the contact was created via the Conversations API.
Created by user ID	Decimal	True		False	User ID of the individual who created the contact. Automatically assigned by HubSpot.
Object create date_time	Datetime	True		False	Timestamp when the contact record was created. Set automatically and not modifiable.
Date entered Customer (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact entered the 'Customer' stage of the 'Lifecycle Stage Pipeline'.
Date entered Evangelist (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact entered the 'Evangelist' stage of the 'Lifecycle Stage Pipeline'.
Date entered Lead (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact entered the 'Lead' stage of the 'Lifecycle Stage Pipeline'.
Date entered Marketing Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact entered the 'Marketing Qualified Lead' stage of the 'Lifecycle Stage Pipeline'.
Date entered Opportunity (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact entered the 'Opportunity' stage of the 'Lifecycle Stage Pipeline'.
Date entered Other (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact entered the 'Other' stage of the 'Lifecycle Stage Pipeline'.
Date entered Sales Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact entered the 'Sales Qualified Lead' stage of the 'Lifecycle Stage Pipeline'.
Date entered Subscriber (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact entered the 'Subscriber' stage of the 'Lifecycle Stage Pipeline'.
Date exited Customer (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact exited the 'Customer' stage of the 'Lifecycle Stage Pipeline'.
Date exited Evangelist (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact exited the 'Evangelist' stage of the 'Lifecycle Stage Pipeline'.
Date exited Lead (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact exited the 'Lead' stage of the 'Lifecycle Stage Pipeline'.
Date exited Marketing Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact exited the 'Marketing Qualified Lead' stage of the 'Lifecycle Stage Pipeline'.
Date exited Opportunity (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact exited the 'Opportunity' stage of the 'Lifecycle Stage Pipeline'.
Date exited Other (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact exited the 'Other' stage of the 'Lifecycle Stage Pipeline'.
Date exited Sales Qualified Lead (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact exited the 'Sales Qualified Lead' stage of the 'Lifecycle Stage Pipeline'.
Date exited Subscriber (Lifecycle Stage Pipeline)	Datetime	True		False	The date and time when the contact exited the 'Subscriber' stage of the 'Lifecycle Stage Pipeline'.
Recent Document Revisit Date	Datetime	True		False	Timestamp of the last time the contact accessed a shared document or presentation.
Invalid email address	Bool	True		False	Indicates whether the email address associated with the contact is invalid.
Email address quarantine reason	String	False		False	Reason why the contact's email address has been quarantined, typically due to anti-abuse policies.
Email Domain	String	True		False	Domain portion of the contact's primary email address.
Email hard bounce reason	String	True		False	Reason the email address caused a hard bounce during an email send attempt.
Email hard bounce reason2	String	True		False	Additional detail about the hard bounce event for the contact's email address.
Email Address Quarantined	Bool	True		False	Indicates whether the contact's email address has been quarantined for compliance reasons, blocking marketing emails.
Email address automated quarantine reason	String	True		False	System-generated reason explaining why the email address was quarantined automatically.
Email Address Recipient Fatigue Next Available Sending Time	Datetime	True		False	Timestamp when the contact will be eligible to receive emails after reaching recipient fatigue limits.
Sends Since Last Engagement	Decimal	True		False	Number of marketing emails sent to the contact since their last engagement, such as an open or click.
Marketing email confirmation status	String	True		False	Indicates the contact's eligibility to receive marketing emails, managed automatically by HubSpot.
Clicked Facebook ad	Bool	False		False	Indicates whether the contact clicked on a Facebook ad.
Facebook click id	String	False		False	Unique identifier associated with the contact's click on a Facebook ad.
Facebook ID	String	False		False	Unique Facebook ID assigned to the contact.
Last NPS survey comment	String	True		False	Comment provided by the contact during their most recent Net Promoter Score (NPS) survey response.
Last NPS survey rating	String	True		False	Numeric rating submitted by the contact in their most recent NPS survey.
Last NPS survey date	Datetime	True		False	Timestamp when the contact last submitted a Net Promoter Score (NPS) survey response. Set automatically by HubSpot.
Should be shown an NPS web survey	Bool	False		False	Indicates whether the contact is eligible to be shown a Net Promoter Score (NPS) web survey.
ID of first engagement	Decimal	True		False	Object ID of the first engagement (such as call, meeting, or email) between the contact and their current owner. Used in Sales Analytics.
First subscription create date	Datetime	True		False	Timestamp of the first subscription created by the contact.
Google ad click id	String	False		False	Unique identifier associated with a click on a Google ad by the contact.
googleplus ID	String	False		False	Unique Google Plus ID associated with the contact.
Contact has an active subscription	Decimal	True		False	Value is 1 if the contact has an active subscription, 0 otherwise. Set automatically by HubSpot.
IP Timezone	String	True		False	Timezone derived from the contact's IP address. Automatically set by HubSpot for segmentation and reporting.
Is a contact	Bool	True		False	Indicates whether the record is an active contact (not deleted and not a visitor).
Contact unworked	Bool	True		False	Indicates whether the contact has not been assigned or engaged since the last owner assignment or reassignment.
last sales activity date old	Datetime	True		False	Date of the last sales activity with the contact. Set automatically by HubSpot for contacts with owners.
Last Engagement Date	Datetime	True		False	Date when the contact last engaged with your site, forms, documents, meeting links, or tracked emails. Excludes marketing emails.
Last Engagement Type	String	True		False	Type of the last engagement action performed by the contact, excluding bulk marketing emails.
Object last modified date_time	Datetime	True		False	Timestamp of the most recent update to any property on the contact. Includes visible and hidden properties.
Last sequence ended date	Datetime	True		False	Date when the contact exited their most recent sales sequence.
Last sequence enrolled	Decimal	True		False	ID of the last sequence the contact was enrolled in.
Last sequence enrolled date	Datetime	True		False	Date when the contact was last enrolled in a sales sequence.
Last sequence finished date	Datetime	True		False	Date when the contact finished their last enrolled sales sequence.
Last sequence unenrolled date	Datetime	True		False	Date when the contact was unenrolled from a sales sequence.
Latest Source Date	Date	False		False	Date of the latest session associated with the contact.
Latest subscription create date	Datetime	True		False	Timestamp when the contact's most recent subscription was created.
Lead Status	String	False		False	Current sales, prospecting, or outreach status assigned to the contact.
Legal basis for processing contact's data	String	False		False	The legal basis for processing the contact's data. 'Not applicable' exempts the contact from GDPR protections.
Clicked LinkedIn Ad	String	False		False	Indicates whether the contact clicked on a LinkedIn ad.
Linkedin ID	String	False		False	Unique LinkedIn ID assigned to the contact.
Marketing contact status source name	String	True		False	Identifier for the activity or workflow that designated the contact as a marketing contact.
Marketing contact status source type	String	True		False	Type of activity (such as workflow or API call) that set the contact as a marketing contact.
Marketing contact status	String	True		False	The marketing contact status, affecting eligibility for marketing emails.
Marketing contact until next update	String	True		False	Indicates whether the contact will be set to non-marketing at the next update cycle.
Merged object IDs	String	True		False	List of record IDs that have been merged into this contact record. Managed automatically by HubSpot.
Record ID	Decimal	True		False	Unique identifier assigned to this contact record. Set automatically by HubSpot.
Pinned engagement ID	Decimal	True		False	Object ID of the pinned engagement currently highlighted on the contact timeline.
Pipeline	String	False		False	Sales pipeline the contact is currently associated with, if applicable.
Likelihood to close	Decimal	True		False	Probability score predicting the likelihood that the contact will become a customer within the next 90 days.
Contact priority	String	True		False	Priority tier assigned to the contact, with tier one being the highest priority for conversion.
Read Only Object	Bool	True		False	Indicates whether the contact record is read-only and cannot be edited by users.
Date of first engagement	Datetime	True		False	Date of the first recorded engagement between the contact and their current owner. Used in Sales Analytics.
Description of first engagement	String	True		False	Description of the first engagement event between the contact and their current owner. Used in Sales Analytics.
Type of first engagement	String	True		False	Object type (such as call, email, or meeting) of the first engagement between the contact and their current owner. Used in Sales Analytics.
Recent Sales Email Clicked Date	Datetime	True		False	Date when the contact last clicked a link in a tracked sales email.
Recent Sales Email Opened Date	Datetime	True		False	Date when the contact last opened a tracked sales email. Does not update for bulk emails sent to multiple recipients.
Calculated Mobile Number with country code	String	True		False	Contact's mobile number formatted with a country code.
Calculated Phone Number with country code	String	True		False	Contact's primary phone number formatted with a country code.
Calculated Mobile Number without country code	String	True		False	Contact's mobile number formatted without a country code.
Calculated Phone Number without country code	String	True		False	Contact's primary phone number formatted without a country code.
Number of sequences actively enrolled	Decimal	True		False	Number of active sales sequences the contact is currently enrolled in.
Number of sequences enrolled	Decimal	True		False	Total number of sales sequences the contact has ever been enrolled in.
Currently in Sequence	Bool	True		False	Indicates whether the contact is currently enrolled in any active sales sequence.
testpurge	String	True		False	Placeholder field used for testing purge functionality.
testrollback	String	True		False	Placeholder field used for testing rollback functionality.
Time between contact creation and deal close	Decimal	False		False	Elapsed time in milliseconds between the contact's creation and the closing of an associated deal.
Time between contact creation and deal creation	Decimal	False		False	Elapsed time in milliseconds between the contact's creation and the creation of an associated deal.
Time in Customer (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the contact spent in the 'Customer' stage within the Lifecycle Stage Pipeline.
Time in Evangelist (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the contact spent in the 'Evangelist' stage within the Lifecycle Stage Pipeline.
Time in Lead (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the contact spent in the 'Lead' stage within the Lifecycle Stage Pipeline.
Time in Marketing Qualified Lead (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the contact spent in the 'Marketing Qualified Lead' stage within the Lifecycle Stage Pipeline.
Time in Opportunity (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the contact spent in the 'Opportunity' stage within the Lifecycle Stage Pipeline.
Time in Other (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the contact spent in the 'Other' stage within the Lifecycle Stage Pipeline.
Time in Sales Qualified Lead (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the contact spent in the 'Sales Qualified Lead' stage within the Lifecycle Stage Pipeline.
Time in Subscriber (Lifecycle Stage Pipeline)	Decimal	True		False	Total time in seconds the contact spent in the 'Subscriber' stage within the Lifecycle Stage Pipeline.
Lead response time	Decimal	True		False	Time in milliseconds it took for the current owner to perform the first qualifying engagement with the contact. Used in Sales Analytics.
Time to move from lead to customer	Decimal	False		False	Time it took for the contact to move from 'Lead' stage to 'Customer' stage.
Time to move from marketing qualified lead to customer	Decimal	False		False	Time it took for the contact to move from 'Marketing Qualified Lead' stage to 'Customer' stage.
Time to move from opportunity to customer	Decimal	False		False	Time it took for the contact to move from 'Opportunity' stage to 'Customer' stage.
Time to move from sales qualified lead to customer	Decimal	False		False	Time it took for the contact to move from 'Sales Qualified Lead' stage to 'Customer' stage.
Time to move from subscriber to customer	Decimal	False		False	Time it took for the contact to move from 'Subscriber' stage to 'Customer' stage.
Time Zone	String	False		False	Time zone associated with the contact. Can be automatically derived from other properties or manually assigned.
Twitter ID	String	False		False	Unique identifier for the contact's Twitter account.
Unique creation key	String	True		False	Unique key used to ensure idempotent creation of the contact and prevent duplicates.
Updated by user ID	Decimal	True		False	ID of the user who last updated the contact record. Set automatically by HubSpot.
User IDs of all notification followers	String	True		False	List of user IDs who have opted in to follow update notifications for this contact.
User IDs of all notification unfollowers	String	True		False	List of user IDs who have opted out of receiving update notifications for this contact.
User IDs of all owners	String	True		False	List of user IDs assigned as owners of this contact record.
WhatsApp Phone Number	String	False		False	Phone number associated with the contact's WhatsApp account.
Owner Assigned Date	Datetime	True		False	Date and time when the contact was assigned to its most recent owner. Automatically set by HubSpot.
IP City	String	True		False	City reported by the contact's IP address. Used for segmentation and reporting.
IP Country	String	True		False	Country reported by the contact's IP address. Used for segmentation and reporting.
IP Country Code	String	True		False	Country code reported by the contact's IP address. Used for segmentation and reporting.
IP Latitude _ Longitude	String	True		False	Latitude and longitude coordinates reported by the contact's IP address.
IP State_Region	String	True		False	State or region reported by the contact's IP address. Used for segmentation and reporting.
IP State Code_Region Code	String	True		False	State code or region code reported by the contact's IP address. Used for segmentation and reporting.
IP Zipcode	String	True		False	Postal or ZIP code reported by the contact's IP address. Used for segmentation and reporting.
Job function	String	False		False	Contact's job function. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Last Modified Date	Datetime	True		False	Timestamp when any property of the contact was last modified.
Marital Status	String	False		False	Contact's marital status. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Military status	String	False		False	Contact's military status. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Number of Associated Deals	Decimal	True		False	Total number of deals associated with the contact. Automatically set by HubSpot.
Number of Form Submissions	Decimal	True		False	Total number of forms submitted by the contact. Automatically tracked by HubSpot.
Number of Unique Forms Submitted	Decimal	True		False	Total number of distinct forms submitted by the contact.
Recent Conversion Date	Datetime	True		False	Date when the contact most recently submitted a form.
Recent Conversion	String	True		False	The name of the most recent form submitted by the contact.
Recent Deal Amount	Decimal	True		False	Amount of the most recent closed-won deal associated with the contact. Automatically set.
Recent Deal Close Date	Datetime	True		False	Date when the most recent deal associated with the contact was closed-won. Automatically set.
Relationship Status	String	False		False	Contact's relationship status. Required for Facebook Ads Integration; synced automatically from Lead Ads.
School	String	False		False	Contact's school or educational institution. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Seniority	String	False		False	Contact's seniority level within their organization. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Start date	String	False		False	Contact's job start date. Required for Facebook Ads Integration; synced automatically from Lead Ads.
Total Revenue	Decimal	True		False	Sum of revenue from all closed-won deals associated with the contact. Automatically maintained by HubSpot.
Work email	String	False		False	Work email address of the contact. Required for Facebook Ads Integration; synced automatically from Lead Ads.
First Name	String	False		False	Contact's first name.
First Page Seen	String	True		False	First webpage visited by the contact on your website. Automatically captured by HubSpot.
Marketing emails delivered	Decimal	True		False	Number of marketing emails delivered to the contact. Automatically tracked by HubSpot.
Opted out of emailCustomer Service Communication	String	True		False	Indicates whether the contact has opted out of customer service communications.
Opted out of emailOne to One	String	True		False	Indicates whether the contact has opted out of receiving one-to-one emails.
Twitter Username	String	False		False	Contact's Twitter username or handle.
Currently in workflow	String	True		False	Indicates if the contact is currently enrolled in a HubSpot workflow.
Follower Count	Decimal	False		False	Number of Twitter followers associated with the contact's Twitter account.
Last Page Seen	String	True		False	Last webpage visited by the contact on your website. Automatically captured by HubSpot.
Marketing emails opened	Decimal	True		False	Number of marketing emails opened by the contact. Automatically tracked by HubSpot.
Last Name	String	False		False	Contact's last name.
Number of Pageviews	Decimal	True		False	Total number of pageviews by the contact on your website. Automatically set by HubSpot.
Marketing emails clicked	Decimal	True		False	Number of marketing emails where the contact clicked a link. Automatically tracked by HubSpot.
Salutation	String	False		False	Title used to address the contact, such as Mr., Ms., or Dr.
Twitter Profile Photo	String	False		False	URL of the contact's Twitter profile photo. Set automatically based on the contact's email address.
Email	String	False		False	Primary email address of the contact.
Number of Sessions	Decimal	True		False	Total number of sessions (website visits) by the contact. Automatically set by HubSpot.
Marketing emails bounced	Decimal	True		False	Number of marketing emails that bounced when sent to the contact. Automatically set by HubSpot.
Persona	String	False		False	Persona classification assigned to the contact, useful for segmentation.
Most Recent Social Click	Datetime	True		False	Timestamp of the contact's most recent click on a published social media message.
Number of event completions	Decimal	True		False	Total number of event completions recorded for the contact. Automatically set by HubSpot.
Unsubscribed from all email	Bool	True		False	Indicates if the contact has unsubscribed from all email communications.
Twitter Clicks	Decimal	True		False	Number of times the contact clicked links you shared on Twitter through HubSpot. Automatically tracked.
Mobile Phone Number	String	False		False	Mobile phone number associated with the contact.
Phone Number	String	False		False	Primary phone number associated with the contact.
Fax Number	String	False		False	Fax number associated with the contact, if available.
Time First Seen	Datetime	True		False	Timestamp when the contact was first recorded visiting your website. Automatically set by HubSpot.
Last marketing email name	String	True		False	Name of the last marketing email sent to the contact. Automatically recorded by HubSpot.
Last marketing email send date	Datetime	True		False	Date when the most recent marketing email was sent to the contact.
Facebook Clicks	Decimal	True		False	Number of clicks the contact made on links shared on Facebook.
Street Address	String	False		False	Street address for the contact, including apartment or unit number.
Date of last meeting booked in meetings tool	Datetime	True		False	Date when the last meeting was booked by the contact using HubSpot's meetings tool.
Campaign of last booking in meetings tool	String	True		False	UTM campaign parameter associated with the most recent meeting booking by the contact.
Medium of last booking in meetings tool	String	True		False	UTM medium parameter indicating the channel responsible for the most recent meeting booking.
Source of last booking in meetings tool	String	True		False	UTM source parameter identifying the website that referred the contact's last meeting booking.
Time of First Session	Datetime	True		False	Timestamp when the contact had their first session on your website.
Last marketing email open date	Datetime	True		False	Timestamp when the contact last opened a marketing email.
Latest meeting activity	Datetime	True		False	Date of the most recent meeting (past or upcoming) related to the contact.
Recent Sales Email Replied Date	Datetime	True		False	Date when the contact most recently replied to a tracked sales email.
LinkedIn Clicks	Decimal	True		False	Number of times the contact clicked links shared on LinkedIn.
Contact owner	String	False		False	User assigned as the owner of the contact in HubSpot.
Last Contacted	Datetime	True		False	Timestamp of the most recent call, email, or meeting logged for the contact.
Last Activity Date	Datetime	True		False	Date and time of the most recent activity (such as a call, meeting, or note) logged for the contact.
Next Activity Date	Datetime	True		False	Scheduled date of the next planned activity (such as a call or meeting) for the contact.
Number of times contacted	Decimal	True		False	Total number of calls, emails, and meetings logged for this contact. Automatically tracked by HubSpot.
Number of Sales Activities	Decimal	True		False	Total number of sales activities (calls, meetings, emails) logged for the contact.
HubSpot Owner Email _legacy_	String	False		False	Legacy property recording the email address of the contact's owner. No longer actively used.
HubSpot Owner Name _legacy_	String	False		False	Legacy property recording the name of the contact's owner. No longer actively used.
SurveyMonkey Event Last Updated	Decimal	True		False	Internal field used for triggering list updates when SurveyMonkey information is refreshed.
Webinar Event Last Updated	Decimal	True		False	Internal field used for triggering list updates when webinar information is refreshed.
City	String	False		False	City of residence for the contact. Can be populated through imports, forms, or integrations.
Time Last Seen	Datetime	True		False	Timestamp of the most recent webpage view by the contact.
Last marketing email click date	Datetime	True		False	Date when the contact last clicked a link in a marketing email.
Google Plus Clicks	Decimal	True		False	Number of clicks made by the contact on links shared through Google Plus.
HubSpot Team	String	True		False	Name of the HubSpot team associated with the contact's owner.
LinkedIn Bio	String	False		False	Biography or description from the contact's LinkedIn profile.
Twitter Bio	String	False		False	Biography from the contact's Twitter profile, populated based on their email address.
All owner ids	String	True		False	List of all owner property IDs associated with the contact, including default and custom owners.
Time of Last Session	Datetime	True		False	Timestamp marking the beginning of the contact's most recent session on your website.
First marketing email send date	Datetime	True		False	Date when the first marketing email was delivered to this contact.
Broadcast Clicks	Decimal	True		False	Total number of clicks made by the contact on published social messages.
State_Region	String	False		False	State or region where the contact resides. Can be set through forms, imports, or integrations.
All team ids	String	True		False	IDs of all teams assigned to the contact, either directly or through ownership properties.
Original Source	String	False		False	Original source through which the contact discovered your business. Set automatically by HubSpot.
First marketing email open date	Datetime	True		False	Date when the contact first opened a marketing email.
Latest Source	String	False		False	Source associated with the contact's most recent website session.
Postal Code	String	False		False	Postal or ZIP code associated with the contact's address.
Country_Region	String	False		False	Country or region where the contact resides.
All accessible team ids	String	True		False	IDs of all teams, including inherited teams, associated with the contact's owner properties.
Original Source DrillDown 1	String	True		False	Additional contextual details about how the contact originally found your site.
First marketing email click date	Datetime	True		False	Date when the contact first clicked a link in a marketing email.
Latest Source DrillDown 1	String	True		False	Additional detail about the latest session source for the contact.
LinkedIn Connections	Decimal	False		False	Number of LinkedIn connections linked to the contact's LinkedIn profile.
Original Source DrillDown 2	String	True		False	Further breakdown of the contact's original source of discovery.
Is globally ineligible	Bool	True		False	Indicates if the contact is globally ineligible to receive email communications.
Preferred language	String	False		False	Preferred language for communication with the contact.
Latest Source DrillDown 2	String	True		False	Further detail about the contact's latest session source.
Klout Score	Decimal	False		False	Deprecated social media influence score for the contact, retained for legacy use.
First Referring Site	String	True		False	URL of the website that initially referred the contact to your website.
First marketing email reply date	Datetime	True		False	Date when the contact first replied to a marketing email.
Job Title	String	False		False	Job title of the contact as recorded in their profile.
Photo	String	False		False	Social media profile photo linked to the contact.
Last Referring Site	String	True		False	URL of the last referring website that brought the contact to your site.
Last marketing email reply date	Datetime	True		False	Date when the contact last replied to a marketing email.
Message	String	False		False	Field used to capture custom messages or comments submitted by the contact via forms.
Close Date	Datetime	False		False	Date when the contact officially became a customer. Automatically set when a related deal is closed-won or can be set manually.
Average Pageviews	Decimal	True		False	Average number of page views per session by the contact.
Marketing emails replied	Decimal	True		False	Total number of marketing emails the contact has replied to.
Event Revenue	Decimal	True		False	Revenue value attributed to the contact through Enterprise Events tracking.
Became a Lead Date	Datetime	True		False	Date when the contact's lifecycle stage was updated to Lead.
Became a Marketing Qualified Lead Date	Datetime	True		False	Date when the contact's lifecycle stage was updated to Marketing Qualified Lead (MQL).
Became an Opportunity Date	Datetime	True		False	Date when the contact's lifecycle stage was updated to Opportunity.
Lifecycle Stage	String	False		False	Current sales readiness stage of the contact such as Subscriber, Lead, Opportunity, or Customer.
Became a Sales Qualified Lead Date	Datetime	True		False	Date when the contact's lifecycle stage was updated to Sales Qualified Lead (SQL).
Create Date	Datetime	True		False	Date when the contact record was first created in HubSpot.
Became an Evangelist Date	Datetime	True		False	Date when the contact's lifecycle stage was updated to Evangelist.
Became a Customer Date	Datetime	True		False	Date when the contact's lifecycle stage was updated to Customer.
HubSpot Score	Decimal	True		False	Lead scoring metric showing the contact's sales readiness based on set criteria.
Company Name	String	False		False	Name of the company associated with the contact.
Became a Subscriber Date	Datetime	True		False	Date when the contact's lifecycle stage was updated to Subscriber.
Became an Other Lifecycle Date	Datetime	True		False	Date when the contact's lifecycle stage was updated to 'Other' lifecycle classification.
Website URL	String	False		False	Website URL of the contact's associated company or personal website.
Number of Employees	String	False		False	Total number of employees at the contact's associated company.
Annual Revenue	String	False		False	Annual revenue of the contact's associated company.
Industry	String	False		False	Industry in which the contact's associated company operates.
Primary Associated Company ID	Decimal	False		False	Unique HubSpot ID of the primary associated company linked to the contact.
Associated Company Last Updated	Decimal	True		False	Internal field used to trigger updates when the associated company's information changes.
Lead Rating	String	True		False	Rating given to the contact based on predictive lead scoring models.
Predictive Lead Score	Decimal	True		False	HubSpot-calculated score indicating how likely the contact is to become a customer.

ContactsToDealsAssociations

Returns deal IDs associated with specific contacts, useful for tracking contact-to-deal relationships.

Table-Specific Information

This table is available when ExpandAssociations is set to True.

SELECT

The ContactsToDealsAssociations table always includes the same set of columns, but some return NULL unless you filter by ContactsId, which allows the Cloud to retrieve full association details.

When a query is filtered by ContactsId, filters are resolved server-side. Other filters are resolved client-side.

-- Retrieve all fields for associations between a specific Contact and its Deals
SELECT *
FROM ContactsToDealsAssociations
WHERE ContactsId = '7255738537';  -- Contact Id

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each Contact.

INSERT

To add a new association between a Contact and a Deal, provide the Contact ContactsId and the Deal DealsId. For custom association types, also include TypeId and Category.

-- Insert a default Contact-Deal association
INSERT INTO ContactsToDealsAssociations (ContactsId, DealsId)
VALUES ('3432', '34654');

-- Insert a custom Contact-Deal association
INSERT INTO ContactsToDealsAssociations (ContactsId, DealsId, TypeId, Category)
VALUES ('3432', '34654', '1', 'USER_DEFINED');

DELETE

To remove an existing Contact-Deal association, specify the Contact ContactsId and the Deal DealsId. For custom association types, also include TypeId and Category.

-- Delete a default Contact-Deal association
DELETE FROM ContactsToDealsAssociations
WHERE ContactsId = '3432'     -- Contact Id
  AND DealsId = '34654';      -- Deal Id

-- Delete a custom Contact-Deal association
DELETE FROM ContactsToDealsAssociations
WHERE ContactsId = '3432'     -- Contact Id
  AND DealsId = '34654'       -- Deal Id
  AND TypeId = '1'
  AND Category = 'USER_DEFINED';

Columns


Name	Type	ReadOnly	References	Filterable	Description
ContactsId [KEY]	Long	False	Contacts.Id	False	The unique identifier of the contact involved in the association.
DealsId [KEY]	Long	False	Deals.Id	False	The unique identifier of the deal associated with the contact.
TypeId [KEY]	String	False	AssociationsLabels.TypeId	False	The numeric ID representing the specific type of association between the contact and deal, if available.
Category [KEY]	String	False	AssociationsLabels.Category	False	The classification of the association type for this contact-deal pair, if applicable.
TypeLabel	String	True	AssociationsLabels.Label	False	The descriptive label assigned to this type of contact-to-deal association.

CourseAssociations

Retrieve the IDs of all the objects associated to specific Courses objects in HubSpot.

Table Specific Information

The CourseAssociations table provides access to the relationship data between course records and other HubSpot objects such as contacts, companies, deals, and tickets.

SELECT

When selecting course associations, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM CourseAssociations WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'
SELECT * FROM CourseAssociations WHERE Type = 'contacts'

INSERT

INSERT INTO CourseAssociations (ID, AssociationId, Type) VALUES ('25151', '12345', 'contacts')

DELETE

DELETE FROM CourseAssociations WHERE ID = '25151' AND AssociationId = '12345'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Courses.Id	False	Courses ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Courses object is associated with.
Type [KEY]	String	False		False	Type of the associated object, which can be a contact, deal etc.
TypeId [KEY]	String	False		False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False		False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.
TypeLabel	String	True		False	The label assigned to the association type between objects.

Courses

Retrieve the available Courses in HubSpot.

Table Specific Information

In HubSpot, courses represent educational or training programs offered to contacts or customers. Course records help users track enrollment, progress, and completion through pipeline stages.

SELECT

When selecting courses, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Courses WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'

INSERT

INSERT INTO Courses ([Course Name]) VALUES ('Advanced Marketing')

UPDATE

UPDATE Courses SET [Course Name] = 'Updated Course Title' WHERE ID = '25151'

DELETE

DELETE FROM Courses WHERE ID = '25151'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Course Description	String	False		True	Brief explanation of what the course covers.
Course ID	String	False		True	Unique ID for the course record.
Course Name	String	False		True	Title or name of the course.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Date entered 'Closed Stage (Course Pipeline)'	Datetime	True		True	The date and time when the Course entered the 'Closed Stage' stage, 'Course Pipeline' pipeline.
Date entered 'Open Stage (Course Pipeline)'	Datetime	True		True	The date and time when the Course entered the 'Open Stage' stage, 'Course Pipeline' pipeline.
Date exited 'Closed Stage (Course Pipeline)'	Datetime	True		True	The date and time when the Course exited the 'Closed Stage' stage, 'Course Pipeline' pipeline.
Date exited 'Open Stage (Course Pipeline)'	Datetime	True		True	The date and time when the Course exited the 'Open Stage' stage, 'Course Pipeline' pipeline.
Enrollment Capacity	Decimal	False		True	Maximum number of participants allowed.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Owning Teams	String	False		False	The teams that are attributed to this record.
Pipeline	String	False		False	The pipeline that contains this course.
Pipeline Stage	String	False		False	The pipeline stage that contains this course.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	False		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	False		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Time in 'Closed Stage (Course Pipeline)'	Decimal	True		True	The total time in seconds spent by the Course in the 'Closed Stage' stage, 'Course Pipeline' pipeline.
Time in 'Open Stage (Course Pipeline)'	Decimal	True		True	The total time in seconds spent by the Course in the 'Open Stage' stage, 'Course Pipeline' pipeline.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	Object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

DealAssociations

Lists object IDs associated with specific deals, supporting deal-to-object relationships management.

Table-Specific Information

SELECT

The DealAssociations table always includes the same set of columns, but some return NULL unless you filter by Id and Type, which allows the Cloud to retrieve full association details.

To return full details for Deal associations, filter by both the Deal Id and the association Type. The Type identifies the associated object (such as a Company, Contact, or Ticket).

-- Retrieve all fields for associations between a specific Deal and its Companies
SELECT *
FROM DealAssociations
WHERE Id = '436648510605'   -- Deal Id
  AND Type = 'Company';     -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each Deal.

DELETE

To remove a Deal association, include both the Deal Id and the association Type:

-- Delete a Deal-Company association
DELETE FROM DealAssociations
WHERE Id = '436648510605'   -- Deal Id
  AND Type = 'Company';     -- Associated object type

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Deals.Id	False	The unique identifier of the deal involved in the association.
AssociationId [KEY]	Long	False		False	The unique identifier of the object associated with the deal.
Type [KEY]	String	False		False	The type of object associated with the deal, such as contact, company, or ticket.
TypeId [KEY]	String	False	AssociationsLabels.TypeId	False	The numeric identifier representing the specific association type, if available.
Category [KEY]	String	False	AssociationsLabels.Category	False	The classification of the association type for this object pair, if applicable.
TypeLabel	String	True	AssociationsLabels.Label	False	The descriptive label assigned to the type of association between the deal and the related object.

Deals

Lists all deal records in HubSpot, supporting both OAuth and private-app token authentication methods.

Table Specific Information

A deal represents an ongoing transaction that a sales team is pursuing with a contact or company. It is tracked through pipeline stages until won or lost.

SELECT

When selecting deals, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Deals WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM Deals WHERE Archived = TRUE;

INSERT

INSERT INTO Deals (Currency) VALUES ('USD')

UPDATE

UPDATE Deals SET Currency = 'EUR' WHERE ID = '471395623'

DELETE

DELETE FROM Deals WHERE ID = '471395623'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier assigned to each deal record in HubSpot.
Archived	Bool	True		True	Indicates whether the deal has been archived and is no longer active.
CreatedAt	Datetime	True		False	Timestamp when the deal record was initially created.
UpdatedAt	Datetime	True		False	Timestamp when the deal record was most recently updated.
ItemURL	String	True		False	URL linking directly to the HubSpot deal record.
Amount in company currency	Decimal	True		False	Deal amount converted into your company's currency using the applicable exchange rate.
Days to close	Decimal	True		False	Number of days between the deal's creation and close date.
Currency	String	False		False	Currency code used for the deal amount, such as USD or EUR.
Annual contract value	Decimal	True		False	Annual contract value (ACV) representing the yearly revenue from the deal.
Business units	String	False		False	Business units assigned to this deal for organizational tracking and reporting.
Deal Collaborator	String	True		False	User IDs of individuals involved in closing the deal.
Deal Split Users	String	True		False	User IDs of associated deal splits, set automatically by HubSpot.
Latest Source	String	True		False	Source of the last session activity from a directly or indirectly associated contact.
Latest Source Company	String	True		False	Source of the last session activity from a company associated with the deal.
Latest Source Contact	String	True		False	Source of the last session activity from the directly associated contact.
Latest Source Data 1	String	True		False	First additional detail about the latest session's source from associated contacts.
Latest Source Data 1 Company	String	True		False	First additional detail about the latest session's source from companies associated indirectly with the deal.
Latest Source Data 1 Contact	String	True		False	First additional detail about the latest session's source from directly associated contacts.
Latest Source Data 2	String	True		False	Second additional detail about the latest session's source from associated contacts.
Latest Source Data 2 Company	String	True		False	Second additional detail about the latest session's source from companies associated indirectly with the deal.
Latest Source Data 2 Contact	String	True		False	Second additional detail about the latest session's source from directly associated contacts.
Latest Source Timestamp	Datetime	True		False	Timestamp when the most recent session source activity occurred for a directly or indirectly associated contact.
Latest Source Timestamp Company	Datetime	True		False	Timestamp when the most recent session source activity occurred for an indirectly associated company.
Latest Source Timestamp Contact	Datetime	True		False	Timestamp when the most recent session source activity occurred for a directly associated contact.
Original Source Type	String	False		False	Original source that first captured the contact associated with this deal.
Original Source Data 1	String	True		False	First level of additional detail about the original source for the associated contact or company.
Original Source Data 2	String	True		False	Second level of additional detail about the original source for the associated contact or company.
Annual recurring revenue	Decimal	True		False	Annual recurring revenue (ARR) generated by this deal, typically for subscription-based sales.
HubSpot Campaign	String	False		False	Marketing campaign associated with this deal for attribution and tracking.
Closed Deal Amount	Decimal	True		False	Deal amount if the deal is closed; otherwise, returns 0.
Closed Deal Amount In Home Currency	Decimal	True		False	Deal amount in the company's home currency if the deal is closed; otherwise, returns 0.
Created by user ID	Decimal	True		False	HubSpot user ID of the individual who originally created this deal. This is set automatically.
Date entered Appointment Scheduled (Sales Pipeline)	Datetime	True		False	Date and time when the deal entered the 'Appointment Scheduled' stage of the 'Sales Pipeline'.
Date entered Closed Lost (Sales Pipeline)	Datetime	True		False	Date and time when the deal entered the 'Closed Lost' stage of the 'Sales Pipeline'.
Date entered Closed Won (Sales Pipeline)	Datetime	True		False	Date and time when the deal entered the 'Closed Won' stage of the 'Sales Pipeline'.
Date entered Contract Sent (Sales Pipeline)	Datetime	True		False	Date and time when the deal entered the 'Contract Sent' stage of the 'Sales Pipeline'.
Date entered Decision Maker BoughtIn (Sales Pipeline)	Datetime	True		False	Date and time when the deal entered the 'Decision Maker Bought-In' stage of the 'Sales Pipeline'.
Date entered Presentation Scheduled (Sales Pipeline)	Datetime	True		False	Date and time when the deal entered the 'Presentation Scheduled' stage of the 'Sales Pipeline'.
Date entered Qualified To Buy (Sales Pipeline)	Datetime	True		False	Date and time when the deal entered the 'Qualified To Buy' stage of the 'Sales Pipeline'.
Date exited Appointment Scheduled (Sales Pipeline)	Datetime	True		False	Date and time when the deal exited the 'Appointment Scheduled' stage of the 'Sales Pipeline'.
Date exited Closed Lost (Sales Pipeline)	Datetime	True		False	Date and time when the deal exited the 'Closed Lost' stage of the 'Sales Pipeline'.
Date exited Closed Won (Sales Pipeline)	Datetime	True		False	Date and time when the deal exited the 'Closed Won' stage of the 'Sales Pipeline'.
Date exited Contract Sent (Sales Pipeline)	Datetime	True		False	Date and time when the deal exited the 'Contract Sent' stage of the 'Sales Pipeline'.
Date exited Decision Maker BoughtIn (Sales Pipeline)	Datetime	True		False	Date and time when the deal exited the 'Decision Maker Bought-In' stage of the 'Sales Pipeline'.
Date exited Presentation Scheduled (Sales Pipeline)	Datetime	True		False	Date and time when the deal exited the 'Presentation Scheduled' stage of the 'Sales Pipeline'.
Date exited Qualified To Buy (Sales Pipeline)	Datetime	True		False	Date and time when the deal exited the 'Qualified To Buy' stage of the 'Sales Pipeline'.
Deal amount calculation preference	String	False		False	Specifies the method for calculating deal amounts from associated line items.
Deal probability	Decimal	False		False	Probability that the deal will close, typically based on the deal stage setting.
Deal stage probability shadow	Decimal	True		False	Fallback probability between 0 and 1 for the deal's stage if no override is applied; defaults to 0 for unknown stages.
Exchange rate	Decimal	True		False	Exchange rate used to convert the deal amount into the company's currency.
Forecast amount	Decimal	True		False	Forecasted deal value calculated by multiplying the forecast probability by the deal amount in company currency.
Forecast probability	Decimal	False		False	Custom probability percentage that predicts the chance of the deal closing.
Is Deal Closed_	Bool	True		False	Indicates whether the deal is marked as closed, either won or lost.
Is Closed Won	Bool	True		False	Indicates whether the deal is marked as 'Closed Won'.
Deal Split Added	Bool	True		False	Indicates whether this deal has an associated deal split among multiple owners.
Last Modified Date	Datetime	True		False	Timestamp of the latest property update to the deal, including internal HubSpot changes.
Likelihood to close by the close date	Decimal	True		False	HubSpot's predicted likelihood, between 0 and 1, that the deal will close by the close date.
Global Term Line Item Discount Percentage	String	False		False	Internal HubSpot value representing the global discount percentage applied to line items.
Global Term Line Item Discount Percentage Enabled	Bool	False		False	Internal HubSpot setting indicating if the global discount percentage is enabled.
Global Term Line Item Recurring Billing Period	String	False		False	Internal HubSpot value representing the global recurring billing duration for products.
Global Term Line Item Recurring Billing Period Enabled	Bool	False		False	Internal HubSpot setting indicating if the recurring billing period is enabled for line items.
Global Term Line Item Recurring Billing Start Date	String	False		False	Internal HubSpot value representing the start date for recurring billing on line items.
Global Term Line Item Recurring Billing Start Date Enabled	Bool	False		False	Internal HubSpot setting indicating if the recurring billing start date is enabled.
Global Term Line Item Recurring Billing Frequency	String	False		False	Internal HubSpot value representing how frequently the line item is billed.
Global Term Line Item Recurring Billing Frequency Enabled	Bool	False		False	Internal HubSpot setting indicating if the billing frequency is enabled for line items.
Forecast category	String	False		False	Manual forecasting category assigned to the deal, indicating its likelihood to close.
Merged object IDs	String	True		False	List of deal record IDs that were merged into this deal. Set automatically by HubSpot.
Monthly recurring revenue	Decimal	True		False	Monthly recurring revenue (MRR) associated with this deal, typically used for subscription sales.
Next step	String	False		False	Brief description of the next planned action or milestone for this deal.
Number of Active Deal Registrations	Decimal	True		False	Number of active deal registrations associated with this deal, tracked automatically by HubSpot.
Number of Deal Registrations	Decimal	True		False	Total number of deal registrations linked to this deal, tracked automatically by HubSpot.
Number of Deal Splits	Decimal	True		False	Total number of deal splits associated with this deal, tracked automatically by HubSpot.
Number of target accounts	Decimal	True		False	Number of target account companies associated with this deal, set automatically by HubSpot.
Record ID	Decimal	True		False	Unique identifier assigned to this deal record by HubSpot.
Pinned Engagement ID	Decimal	True		False	Object ID of the engagement currently pinned to the deal, set automatically by HubSpot.
The predicted deal amount	Decimal	True		False	Predicted deal amount calculated as the deal amount multiplied by the predicted likelihood of closing.
The predicted deal amount in your company's currency	Decimal	True		False	Predicted deal amount in company currency, calculated using the predicted likelihood of closing.
Priority	String	False		False	Priority level assigned to the deal, if configured.
Weighted amount	Decimal	True		False	Deal amount multiplied by the probability of the deal closing.
Weighted amount in company currency	Decimal	True		False	Weighted amount converted into the company's currency, based on the deal's closing probability.
Read Only Object	Bool	True		False	Indicates whether the deal record is read-only and cannot be edited.
Total contract value	Decimal	True		False	Total contract value (TCV) of the deal, representing full revenue over the contract term.
Time in Appointment Scheduled (Sales Pipeline)	Decimal	True		False	Total time in seconds the deal spent in the 'Appointment Scheduled' stage of the 'Sales Pipeline'.
Time in Closed Lost (Sales Pipeline)	Decimal	True		False	Total time in seconds the deal spent in the 'Closed Lost' stage of the 'Sales Pipeline'.
Time in Closed Won (Sales Pipeline)	Decimal	True		False	Total time in seconds the deal spent in the 'Closed Won' stage of the 'Sales Pipeline'.
Time in Contract Sent (Sales Pipeline)	Decimal	True		False	Total time in seconds the deal spent in the 'Contract Sent' stage of the 'Sales Pipeline'.
Time in Decision Maker BoughtIn (Sales Pipeline)	Decimal	True		False	Total time in seconds the deal spent in the 'Decision Maker Bought-In' stage of the 'Sales Pipeline'.
Time in Presentation Scheduled (Sales Pipeline)	Decimal	True		False	Total time in seconds the deal spent in the 'Presentation Scheduled' stage of the 'Sales Pipeline'.
Time in Qualified To Buy (Sales Pipeline)	Decimal	True		False	Total time in seconds the deal spent in the 'Qualified To Buy' stage of the 'Sales Pipeline'.
Unique creation key	String	True		False	Unique key used for idempotent deal creation to prevent duplicate records.
Updated by user ID	Decimal	True		False	User ID of the individual who most recently updated the deal record.
User IDs of all notification followers	String	True		False	List of user IDs who opted to follow this deal for notification updates.
User IDs of all notification unfollowers	String	True		False	List of user IDs who opted out of receiving follow notifications for this deal.
User IDs of all owners	String	True		False	List of all owner user IDs assigned to the deal record.
Owner Assigned Date	Datetime	True		False	Date and time when the most recent owner was assigned to the deal.
Deal Name	String	False		False	Name assigned to the deal for identification and tracking.
Amount	Decimal	False		False	Total monetary value of the deal.
Deal Stage	String	False		False	Current stage of the deal within the associated pipeline.
Pipeline	String	False		False	Sales pipeline to which this deal belongs, determining available deal stages.
Close Date	Datetime	False		False	Date when the deal was closed as either won or lost.
Create Date	Datetime	False		False	Date when the deal record was initially created in HubSpot.
Date of last meeting booked in meetings tool	Datetime	True		False	Date of the most recent meeting booked through the HubSpot meetings tool by an associated contact.
Campaign of last booking in meetings tool	String	True		False	Marketing campaign that referred an associated contact to the meetings tool for their most recent booking, based on UTM parameters.
Medium of last booking in meetings tool	String	True		False	Channel that referred an associated contact to the meetings tool for their most recent booking, based on UTM parameters.
Source of last booking in meetings tool	String	True		False	Website or platform that referred an associated contact to the meetings tool for their most recent booking, based on UTM parameters.
Latest meeting activity	Datetime	True		False	Date of the most recent meeting, either past or upcoming, logged, scheduled, or booked by a contact associated with this deal.
Recent Sales Email Replied Date	Datetime	True		False	Last date a tracked sales email received a reply from an associated contact.
Deal owner	String	False		False	Primary user assigned as the owner of the deal. Additional owners can be assigned via custom properties.
Last Contacted	Datetime	True		False	Most recent time a call, sales email, or meeting was logged for this deal. Automatically updated by HubSpot.
Last Activity Date	Datetime	True		False	Most recent time any sales activity, such as a note, call, email, meeting, or task, was logged for this deal.
Next Activity Date	Datetime	True		False	Next upcoming activity scheduled for the deal, including calls, emails, meetings, or tasks. Automatically updated by HubSpot.
Number of times contacted	Decimal	True		False	Total number of logged sales activities (notes, calls, emails, meetings, tasks) for the deal.
Number of Sales Activities	Decimal	True		False	Total number of tracked sales emails or calls associated with the deal.
HubSpot Create Date	Datetime	True		False	Date the deal was created in HubSpot. Automatically generated.
HubSpot Team	String	True		False	Primary HubSpot team associated with the deal owner.
Deal Type	String	False		False	Classification of the deal, such as New Business or Existing Business.
All owner ids	String	True		False	List of all user IDs linked to ownership properties for this deal, including custom and default owners.
Deal Description	String	False		False	Detailed description of the deal, typically outlining purpose, scope, or background.
All team ids	String	True		False	List of all team IDs corresponding to the ownership properties associated with this deal.
All accessible team ids	String	True		False	List of all team IDs, including hierarchical teams, with access to ownership properties associated with the deal.
Number of Associated Contacts	Decimal	True		False	Total number of contacts associated with the deal. Set automatically by HubSpot.
Closed Lost Reason	String	False		False	Reason provided for why the deal was marked as lost.
Closed Won Reason	String	False		False	Reason provided for why the deal was marked as won.

EngagementsCalls

Retrieves all call engagement records in HubSpot, used for tracking customer communication.

SELECT

When selecting Call Engagements, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM EngagementsCalls WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM EngagementsCalls WHERE Archived = TRUE;

INSERT

INSERT INTO EngagementsCalls ([Call Title], [Call notes], [Call duration], [From Number], [To Number], [Recording URL], [Call status], [Activity date])
VALUES ('CallEngagement Title', 'CallEngagement Body', '60', '123-456-7890', '789-123-4560', 'https://www.cdata.com', 'CALLING_CRM_USER', current_timestamp() )

UPDATE

UPDATE EngagementsCalls SET [Call status] = 'COMPLETED' WHERE ID = '11896247257'

DELETE

DELETE FROM EngagementsCalls WHERE ID = '11896247257'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique ID for the call engagement record.
Archived	Bool	True		True	Indicates whether the engagement is archived.
CreatedAt	Datetime	True		False	Timestamp when the call engagement record was created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the call engagement record.
Call and meeting type	String	False		False	Specifies whether the engagement was a call, meeting, or another activity type.
Business units	String	False		False	Business units this call engagement is associated with.
AtMentioned Owner Ids	String	False		False	User IDs of owners who were mentioned in the call engagement.
Attached file IDs	String	False		False	List of file IDs that were attached to this call engagement.
Call notes preview	String	True		False	Preview snippet of the call notes.
HTML Body Preview	String	True		False	HTML version of the call engagement's body preview.
Body Preview Truncated	Bool	True		False	Indicates whether the body preview was truncated for length.
Integrating App ID	Decimal	False		False	App ID of the integration that created the engagement, if applicable.
Authenticated recording files url provider	String	True		False	URL that serves authenticated access to the call recording.
Call notes	String	False		False	Full notes recorded for the call engagement.
Callee object id	Decimal	False		False	Identifier of the object being called, such as a contact or company.
Callee object type	String	False		False	Type of object being called (such as Contact, Company, or Deal).
Call direction	String	False		False	Specifies whether the call was inbound or outbound.
Call outcome	String	False		False	Result of the call, such as Connected, No Answer, or Left Voicemail.
Call duration	Decimal	False		False	Duration of the call in milliseconds.
External Account ID	String	False		False	External account identifier linked to the call engagement.
External ID	String	False		False	External identifier for this call engagement from a third-party system.
From Number	String	False		False	Phone number that initiated the call.
From Number Name	String	True		False	Name associated with the phone number that initiated the call.
Transcript Available	Bool	False		False	Indicates whether a transcript is available for the call.
Voicemail Available	String	True		False	Indicates if the call has a voicemail recording.
Recording URL	String	False		False	Link to the call audio recording.
Call Source	String	False		False	Source of the call, such as VoIP, phone integration, or conferencing tool.
Call status	String	False		False	Current status of the call, such as Scheduled, Completed, or Cancelled.
Call Title	String	False		False	Title or subject of the call engagement.
To Number	String	False		False	Phone number that received the call.
To Number Name	String	True		False	Name associated with the recipient phone number.
Tracked terms	String	True		False	Keywords or phrases tracked in the call transcript.
Call transcription id	Decimal	False		False	Identifier for the call transcription associated with this engagement.
Video url	String	False		False	Link to the video recording of the call, if available.
Unique Zoom Meeting ID	String	False		False	Unique identifier for the Zoom meeting if the call was conducted through Zoom.
Calls Service Call ID	Decimal	True		False	Unique ID assigned to this call by the HubSpot Calls Service.
Activity created by	Decimal	True		False	User ID of the person who logged or created the call engagement.
Created by user ID	Decimal	True		False	HubSpot user ID that created this record. This value is system-generated and read-only.
Create date	Datetime	True		False	The date the call engagement was created in HubSpot.
Engagement Source	String	False		False	The platform or integration source that created this call engagement.
Engagement Source ID	String	False		False	Specific identifier from the platform or integration that created this call engagement.
Follow up action	String	False		False	Recommended follow-up action associated with the call.
GDPR deleted	Bool	True		False	Indicates whether the engagement's content was deleted due to a GDPR compliance request.
Last modified date	Datetime	True		False	The most recent timestamp when any property of this call engagement was updated.
Merged object IDs	String	True		False	List of object IDs that have been merged into this call engagement record.
Updated by	Decimal	True		False	User ID of the person who last updated the call engagement.
Record ID	Decimal	True		False	Unique ID for the record, automatically assigned by HubSpot.
Product name	String	False		False	Name of the product associated with the call, if applicable.
Queue Memberships	String	False		False	List of queues that this call engagement is a part of.
Read Only Object	Bool	True		False	Indicates whether the call engagement is read-only.
Activity date	Datetime	False		False	Date when the call activity occurred.
Unique creation key	String	True		False	Unique property used for idempotent creation to prevent duplicate call engagements.
Unique ID	String	False		False	Unique identifier of the engagement for internal tracking.
Unknown Visitor Conversation	Bool	False		False	Indicates whether the call involved an unidentified visitor.
Updated by user ID	Decimal	True		False	User ID of the person who last modified the call engagement record.
User IDs of all notification followers	String	True		False	User IDs of individuals who are following this call engagement for updates.
User IDs of all notification unfollowers	String	True		False	User IDs of individuals who have opted out of following this call engagement.
User IDs of all owners	String	True		False	User IDs of all owners assigned to this call engagement.
Owner Assigned Date	Datetime	True		False	Timestamp when ownership of the call engagement was assigned.
Activity assigned to	String	False		False	User or Salesforce user the call activity is assigned to, can be set manually or via workflows.
HubSpot Team	String	True		False	Team associated with the owner of this call engagement.
All owner ids	String	True		False	All owner reference property values associated with this call engagement.
All team ids	String	True		False	Team IDs corresponding to owner properties of this call engagement.
All accessible team ids	String	True		False	Team IDs, including hierarchical teams, that have access to this call engagement.

EngagementsEmails

Retrieves all email engagement records in HubSpot for analyzing customer email interactions.

SELECT

When selecting Email Engagements, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM EngagementsEmails WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM EngagementsEmails WHERE Archived = TRUE;

INSERT

INSERT INTO EngagementsEmails ([Activity date], [Email Direction], [Attached Video Opened], [Attached Video Watched], [Email send status], [Email subject], [Email body], [UpdatedAt])
VALUES (CURRENT_TIMESTAMP(), 'EMAIL', TRUE, TRUE, 'BOUNCED', 'subject', 'text', CURRENT_TIMESTAMP() )

UPDATE

UPDATE EngagementsEmails SET [Email body] = 'Updated email body', [Email send status] = 'FAILED' WHERE ID = '11896047040'

DELETE

DELETE FROM EngagementsEmails WHERE ID = '11896047040'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier for the email engagement record.
Archived	Bool	True		True	Indicates whether the engagement record has been archived.
CreatedAt	Datetime	True		False	The timestamp when the email engagement was originally created.
UpdatedAt	Datetime	True		False	The timestamp when the email engagement was last updated.
Business units	String	False		False	The business units this email record is associated with.
AtMentioned Owner Ids	String	False		False	User IDs of owners who were mentioned within the body of the email engagement.
Attached file IDs	String	False		False	A list of IDs for files attached to the email.
Body preview	String	True		False	A truncated text-only preview of the email body content.
HTML Body Preview	String	True		False	A truncated preview of the email body in HTML format.
Body Preview Truncated	Bool	True		False	Indicates whether the body preview shown has been truncated.
Activity created by	String	True		False	Identifier of the user who created the email engagement.
Created by user ID	Decimal	True		False	User ID of the creator of this email engagement. Automatically set by HubSpot.
Create date	Datetime	True		False	The timestamp representing when the email engagement was created.
Email direction and unique ID	String	True		False	A combined value of the email's direction and its unique message ID.
Attached Video	String	False		False	The ID of a video file attached to the email, if present.
Attached Video Name	String	False		False	The name of the video file attached to the email, if present.
Attached Video Opened	Bool	False		False	Indicates whether the attached video was opened by the recipient.
Attached Video Watched	Bool	False		False	Indicates whether the attached video was watched by the recipient.
Email BCC Address	String	True		False	Comma-separated email addresses of the BCC recipients.
Email BCC First Name	String	True		False	Comma-separated first names of the BCC recipients.
Email BCC Last Name	String	True		False	Comma-separated last names of the BCC recipients.
Email BCC	String	True		False	Raw header string for BCC recipients from the email metadata.
Email Bounce Error Detail Message	String	False		False	Detailed message explaining why the email bounced, if applicable.
Email Bounce Error Detail Status Code	Decimal	False		False	The SMTP status code corresponding to the bounce error.
Email CC Address	String	True		False	Comma-separated email addresses of the CC recipients.
Email CC First Name	String	True		False	Comma-separated first names of the CC recipients.
Email CC Last Name	String	True		False	Comma-separated last names of the CC recipients.
Email CC	String	True		False	Raw header string for CC recipients from the email metadata.
Email Direction	String	False		False	Direction of the email—indicates whether it was incoming or outgoing.
Encoded Email Associations Request	String	True		False	Encoded string representing association requests for the email engagement.
Error Message	String	False		False	Message detailing any error that occurred during email send processing.
Email Send Id	String	True		False	The unique ID of the email send event as tracked by the system.
Email From Address	String	True		False	The email address that the email was sent from.
Email From First Name	String	True		False	First name of the sender of the email.
Email From Last Name	String	True		False	Last name of the sender of the email.
Email From	String	True		False	Raw header value representing the sender in the original email metadata.
Email Headers	String	False		False	Raw metadata containing sender and recipient header information for the email.
Email body	String	False		False	The body content of the email composed and sent from within HubSpot.
Logged From	String	False		False	Indicates where the email was logged from, such as Gmail, Outlook, or directly within HubSpot.
Media Processing Status	String	False		False	Current processing status of email media content, such as attachments and inline images.
Email is member of forwarded subthread	Bool	False		False	Indicates whether the email belongs to a forwarded subthread conversation.
Message ID	String	False		False	The unique message identifier associated with the email, typically from the email provider.
EmailMigratedViaPortalDataMigration	String	False		False	Indicates if the email was migrated from another HubSpot portal using the DataMigration tool.
Email pending inline image file IDs	String	False		False	IDs of inline image files that are pending processing or upload.
PostSend Status	String	False		False	Status information reflecting the result of the email send event, such as sent, bounced, or dropped.
RecipientDrop Reasons	String	False		False	Reasons why certain email recipients were dropped, listed alongside recipient addresses.
Email Send Event Id	String	False		False	Identifier for the email send event that generated this message.
Email Send Event Id Created	Datetime	False		False	Timestamp of when the email send event ID was created.
Email Sender Address	String	True		False	The address from which the email was sent.
Email Sender First Name	String	True		False	First name of the email sender.
Email Sender Last Name	String	True		False	Last name of the email sender.
Email Sender	String	True		False	Raw header value of the email sender, used for metadata tracking.
Sent Via	String	False		False	The platform or method used to send the email, such as HubSpot, Gmail, or connected integration.
Email send status	String	False		False	Status of the email send event, such as delivered, bounced, or failed.
Email subject	String	False		False	Subject line of the email message.
Text	String	False		False	Plain text version of the email body.
Thread ID	String	False		False	Identifier of the email thread that this message belongs to.
Email To Address	String	True		False	Comma-separated list of email addresses the message was sent to.
Email To First Name	String	True		False	Comma-separated list of first names of the email recipients.
Email To Last Name	String	True		False	Comma-separated list of last names of the email recipients.
Email To	String	True		False	Raw header string for email 'To' recipients.
Tracker Key	String	False		False	Internal tracking key used for logging and analytics of the email.
Validation Skipped	String	False		False	Describes any validation checks that were skipped during email logging.
Engagement Source	String	False		False	The system or workflow that initiated the email engagement.
Engagement Source ID	String	False		False	Identifier of the process or integration that triggered the engagement.
Follow up action	String	False		False	Recommended or defined follow-up action related to the email engagement.
GDPR deleted	Bool	True		False	Indicates whether the email body was cleared in response to a GDPR delete request.
Last modified date	Datetime	True		False	Timestamp of the last modification made to the email engagement record.
Merged object IDs	String	True		False	List of engagement IDs that were merged into this record.
Updated by	String	True		False	User who most recently updated the engagement record.
Record ID	Decimal	True		False	HubSpot-generated unique ID for the email engagement record.
Product name	String	False		False	The name of the product associated with the email, if specified.
Queue Memberships	String	False		False	List of queues that include this email engagement for workflow or routing purposes.
Read Only Object	Bool	True		False	Indicates whether the email engagement record is read-only and cannot be modified.
Activity date	Datetime	False		False	The date the email engagement activity occurred, used for sorting and reporting.
Unique creation key	String	True		False	A unique string used to ensure idempotency when creating this email engagement.
Unique ID	String	False		False	The unique identifier for the email engagement, distinct from the record ID.
Updated by user ID	Decimal	True		False	HubSpot user ID of the person who last updated the record. Set automatically by HubSpot.
User IDs of all notification followers	String	True		False	Comma-separated list of user IDs who opted to follow this record for notifications.
User IDs of all notification unfollowers	String	True		False	Comma-separated list of user IDs who opted out of notifications for this record.
User IDs of all owners	String	True		False	List of user IDs assigned as owners of this engagement.
Owner Assigned Date	Datetime	True		False	Timestamp of the most recent owner assignment for this record. Automatically updated by HubSpot.
Activity assigned to	String	False		False	The user assigned to follow up on this engagement. Can be manually or automatically set.
HubSpot Team	String	True		False	The team name associated with the record owner of this engagement.
All owner ids	String	True		False	All owner property values for this engagement, including custom and default owner fields.
All team ids	String	True		False	Team IDs that correspond to the owner fields of this engagement, both default and custom.
All accessible team ids	String	True		False	All team IDs with access to this engagement, including parent teams in the hierarchy.

EngagementsMeetings

Lists all meeting engagement records in HubSpot, useful for scheduling and meeting tracking.

SELECT

When selecting Meeting Engagements, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM EngagementsMeetings WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM EngagementsMeetings WHERE Archived = TRUE;

INSERT

INSERT INTO EngagementsMeetings ([Activity date], [Meeting name], [Meeting description], [Internal Meeting Notes])
VALUES (current_timestamp(), 'Meeting Engagement Title', 'Meeting Engagement Body', 'Internal Note');

UPDATE

UPDATE EngagementsMeetings SET [Meeting start time] = current_timestamp() WHERE ID = '11896378834'

DELETE

DELETE FROM EngagementsMeetings WHERE ID = '11896378834'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier for the meeting engagement record.
Archived	Bool	True		True	Indicates whether the meeting record is archived.
CreatedAt	Datetime	True		False	Timestamp when the meeting engagement was first created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to this meeting engagement.
Call and meeting type	String	False		False	Specifies whether the activity type is a call or meeting.
Business units	String	False		False	Business units this meeting engagement is assigned to.
AtMentioned Owner Ids	String	False		False	Owner IDs of users mentioned in the body of the engagement.
Attached file IDs	String	False		False	IDs of files that were uploaded and attached to this engagement.
HubSpot attendee owner IDs	String	False		False	List of HubSpot owner IDs representing additional attendees of the meeting.
Body preview	String	True		False	A short preview snippet of the meeting notes or description.
HTML Body Preview	String	True		False	The HTML-rendered version of the engagement body preview.
Body Preview Truncated	Bool	True		False	Indicates whether the full engagement body was truncated in the preview.
Activity created by	Decimal	True		False	User ID of the person who initially created this meeting engagement.
Created by user ID	Decimal	True		False	System-assigned ID of the user who created the record.
Create date	Datetime	True		False	The date the meeting engagement was created in the system.
Engagement Source	String	False		False	The source that generated the meeting engagement, such as a calendar integration or API.
Engagement Source ID	String	False		False	The ID identifying the source process or system that created this engagement.
Follow up action	String	False		False	Recommended action to be taken following the meeting.
GDPR deleted	Bool	True		False	Indicates whether engagement content has been erased due to a GDPR request.
iCalUid	String	True		False	Unique identifier used for syncing the meeting via iCalendar.
Internal Meeting Notes	String	False		False	Notes recorded internally by the meeting organizer or participants.
Last modified date	Datetime	True		False	Timestamp of the last update to any property of this engagement.
Meeting description	String	False		False	The full written description of the scheduled meeting.
Meeting calendar event hash	String	False		False	Hash value representing the specific instance of the calendar event.
Meeting change id	String	False		False	Change identifier used to track updates to the meeting event.
Created From Link ID	String	False		False	ID of the meeting scheduling link that was used to create the meeting.
Meeting end time	Datetime	False		False	Scheduled end time for the meeting.
External URL	String	False		False	External calendar or video conferencing link associated with the meeting.
Meeting location	String	False		False	The physical or virtual location where the meeting will take place.
Location type	String	False		False	The type of meeting location, such as 'virtual', 'in-person', or 'unspecified'.
Meeting outcome	String	False		False	The outcome of the meeting, such as 'Completed', 'No-show', or 'Rescheduled'.
Payments session id	String	False		False	Identifier for the payments session if this meeting includes a paid component.
PreMeeting prospect reminders	String	False		False	List of timestamps when reminder notifications were scheduled for the meeting attendees.
Meeting source	String	True		False	Source where the meeting was created, such as HubSpot form or calendar sync.
Source ID	String	False		False	The internal or external identifier associated with the meeting source.
Meeting start time	Datetime	False		False	Scheduled start time for the meeting.
Meeting name	String	False		False	The title or subject line of the meeting.
Web conference meeting ID	String	False		False	Meeting ID assigned by the web conferencing service, such as Zoom or Microsoft Teams.
Merged object IDs	String	True		False	List of object IDs that have been merged into this meeting engagement. Set automatically by HubSpot.
Updated by	Decimal	True		False	ID of the user who most recently updated this meeting engagement.
Record ID	Decimal	True		False	Unique record identifier automatically assigned by HubSpot.
Product name	String	False		False	Name of the product discussed or associated with the meeting, if applicable.
Queue Memberships	String	False		False	Queues to which this engagement belongs, often used for task routing or automation.
Read Only Object	Bool	True		False	Indicates whether the meeting engagement is read-only and cannot be edited by users.
Scheduled tasks	String	True		False	Tasks scheduled as a result of this meeting engagement.
Activity date	Datetime	False		False	The date the meeting took place or is scheduled to occur.
Unique creation key	String	True		False	Key used to ensure idempotent creation of this engagement when using the API.
Unique ID	String	False		False	A unique string identifier for the meeting engagement.
Updated by user ID	Decimal	True		False	ID of the user who last updated this engagement. Automatically tracked by HubSpot.
User IDs of all notification followers	String	True		False	IDs of users who opted in to receive notifications about this meeting.
User IDs of all notification unfollowers	String	True		False	IDs of users who opted out of receiving notifications about this meeting.
User IDs of all owners	String	True		False	IDs of users listed as owners of this engagement.
Owner Assigned Date	Datetime	True		False	Timestamp indicating when ownership of the meeting engagement was assigned.
Activity assigned to	String	False		False	The HubSpot user or Salesforce integration user responsible for this engagement.
HubSpot Team	String	True		False	Name of the HubSpot team associated with the owner of the meeting engagement.
All owner ids	String	True		False	Combined list of all default and custom owner IDs for this engagement.
All team ids	String	True		False	Team IDs of all owners linked to this meeting engagement.
All accessible team ids	String	True		False	Team IDs, including those up the hierarchy, that have visibility into this meeting engagement.

EngagementsNotes

Retrieves note engagement records in HubSpot, used for logging internal or customer notes.

SELECT

When selecting Note Engagements, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM EngagementsNotes WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM EngagementsNotes WHERE Archived = TRUE;

INSERT

INSERT INTO EngagementsNotes ([Note body], [UpdatedAt], [Activity date]) VALUES ('Body of the note.', current_timestamp(), current_timestamp() )

UPDATE

UPDATE EngagementsNotes SET [Note body] = 'Updated body of the note.' WHERE ID = '11896226519'

DELETE

DELETE FROM EngagementsNotes WHERE ID = '11896226519'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier of the note engagement object.
Archived	Bool	True		True	Indicates whether the note has been archived in HubSpot.
CreatedAt	Datetime	True		False	Timestamp representing when the note engagement was created.
UpdatedAt	Datetime	True		False	Timestamp representing when the note engagement was last updated.
Business units	String	False		False	The business units this note is assigned to within HubSpot.
AtMentioned Owner Ids	String	False		False	HubSpot owner IDs of users who were @mentioned in the note.
Attached file IDs	String	False		False	IDs of files attached to the note engagement.
Body preview	String	True		False	A short preview of the note body content.
HTML Body Preview	String	True		False	HTML version of the note body preview for rendering rich text.
Body Preview Truncated	Bool	True		False	Indicates whether the body of the note was truncated in the preview.
Activity created by	Decimal	True		False	ID of the user who created this note activity.
Created by user ID	Decimal	True		False	User ID of the creator. Automatically populated by HubSpot.
Create date	Datetime	True		False	Date the note engagement was originally created.
Engagement Source	String	False		False	System or integration source that created this note.
Engagement Source ID	String	False		False	Specific source ID from the system that created this note.
Follow up action	String	False		False	Suggested follow-up action associated with the note, if applicable.
GDPR deleted	Bool	True		False	Indicates whether the note content was deleted in response to a GDPR request.
HdTicketIds	String	True		True	All Helpdesk ticketIds associated with the Note.
Last modified date	Datetime	True		False	The most recent time any property of the note engagement was updated.
Merged object IDs	String	True		False	List of note object IDs that have been merged into this record. Set automatically by HubSpot.
Updated by	Decimal	True		False	User ID of the last person to update the note engagement.
Note body	String	False		False	The full body content of the note.
Record ID	Decimal	True		False	Unique identifier for this record, automatically generated by HubSpot.
Product name	String	False		False	Name of the product mentioned or associated with this note, if any.
Queue Memberships	String	False		False	The queues this note belongs to for task routing or processing.
Read Only Object	Bool	True		False	Indicates whether the note engagement is read-only and not editable.
Activity date	Datetime	False		False	The date on which the note engagement occurred.
Unique creation key	String	True		False	Unique key to support idempotent creation of the note via API.
Unique ID	String	False		False	Globally unique identifier for the note engagement object.
Updated by user ID	Decimal	True		False	User ID of the individual who last modified this record. Automatically populated by HubSpot.
User IDs of all notification followers	String	True		False	IDs of users following this note engagement for updates or notifications.
User IDs of all notification unfollowers	String	True		False	IDs of users who have unfollowed this note engagement and opted out of notifications.
User IDs of all owners	String	True		False	List of user IDs representing owners of this note engagement.
Owner Assigned Date	Datetime	True		False	Timestamp when the ownership of this note engagement was assigned.
Activity assigned to	String	False		False	The user assigned to this note activity. This can be set manually or via automation.
HubSpot Team	String	True		False	The HubSpot team of the user who owns this note engagement.
All owner ids	String	True		False	All default and custom owner IDs associated with this note.
All team ids	String	True		False	IDs of all teams associated with ownership of this note engagement.
All accessible team ids	String	True		False	Team IDs, including hierarchy, that have visibility into this note engagement.

EngagementsTasks

Lists all task engagement records in HubSpot for managing CRM-related tasks.

SELECT

When selecting Task Engagements, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM EngagementsTasks WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM EngagementsTasks WHERE Archived = TRUE;

INSERT

INSERT INTO EngagementsTasks ([Task title], [Task notes], [Task status], [Task type], [Activity date])
VALUES ('Test Task Title', 'Body of the task', 'IN_PROGRESS', 'LINKED_IN_MESSAGE', current_timestamp())

UPDATE

UPDATE EngagementsTasks SET [Task notes] = 'Updated Task body test', [Task status] = 'COMPLETED' WHERE ID = '11896363224'

DELETE

DELETE FROM EngagementsTasks WHERE ID = '11896363224'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier of the task engagement object.
Archived	Bool	True		True	Indicates whether the task is archived in HubSpot.
CreatedAt	Datetime	True		False	Timestamp when the task was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the task engagement.
Business units	String	False		False	The business units assigned to this task engagement record.
AtMentioned Owner Ids	String	False		False	User IDs of owners who were @mentioned in this task engagement.
Attached file IDs	String	False		False	IDs of any files attached to this task engagement.
Notes _preview_	String	True		False	A plain-text preview of the notes field content in this task.
HTML Body Preview	String	True		False	HTML representation of the task's engagement body preview.
Body Preview Truncated	Bool	True		False	Indicates whether the previewed content was truncated.
Calendar Event ID	String	True		False	The ID of the calendar event associated with this task, if synced.
Created by	Decimal	True		False	The user ID of the individual who created this task engagement.
Created by user ID	Decimal	True		False	The system-generated ID of the user who created the task.
Created at	Datetime	True		False	The creation timestamp of this task engagement.
Source	String	False		False	The system or integration that created the task.
Source ID	String	False		False	A unique identifier from the source system that created the task.
Follow up action	String	False		False	Specifies any follow-up action associated with this task.
GDPR deleted	Bool	True		False	Indicates if the content of this engagement was deleted due to a GDPR request.
Last modified at	Datetime	True		False	The last time any property of this task was modified.
Merged object IDs	String	True		False	Object IDs that were merged into this task engagement. Set by HubSpot automatically.
Last modified by	Decimal	True		False	User ID of the last person to update this task.
MS Teams message ID	String	True		False	Microsoft Teams message ID linked to the creation of this task.
Associated Companies	Decimal	True		False	Count of companies associated with this task.
Associated Contacts	Decimal	True		False	Count of contacts associated with this task.
Associated Deals	Decimal	True		False	Count of deals associated with this task.
Associated Queue Objects	Decimal	True		False	Number of objects in queues that are associated with this task.
Associated Tickets	Decimal	True		False	Count of tickets linked to this task.
Record ID	Decimal	True		False	Unique record ID for this task, automatically set by HubSpot.
Product name	String	False		False	The name of the product linked to this task engagement, if any.
Queue	String	False		False	Name of the task queue this task belongs to.
Read Only Object	Bool	True		False	Indicates whether this task record is read-only.
Task repeat status	String	True		False	Specifies if this task is part of a repeating task series.
Scheduled tasks	String	True		False	Information about scheduled occurrences of the task.
Notes	String	False		False	Full content of the notes field for the task.
Completed at	Datetime	True		False	Timestamp when the task was marked as completed.
Contact Time Zone	String	True		False	Time zone of the contact associated with the task.
For Object Type	String	False		False	Type of object this task is associated with, such as contact or deal.
Task is all day	Bool	False		False	Indicates whether the task spans the entire day without a specific time.
Last contacted	Datetime	True		False	Last contact activity timestamp linked to the task's associated contact.
Last engagement	Datetime	True		False	Timestamp of the last sales activity with the contact associated with this task.
Priority	String	False		False	Priority level assigned to the task, such as High or Low.
Task probability to complete	Decimal	True		False	Estimated likelihood of task completion, expressed as a decimal.
Relative Task Reminders	String	False		False	Reminder dates set relative to the due date of the task.
Reminder	String	False		False	Specific dates on which task reminders will be triggered.
Interval	String	True		False	Frequency interval used if the task is repeating.
Send Default Reminder	Bool	False		False	Whether a default reminder is enabled for this task.
Sequence Enrollment Is Active	Bool	True		False	Indicates whether the sequence enrollment linked to this task is currently active.
Sequence step enrollment Id	String	True		False	ID of the sequence step that generated this task.
Sequence step number	Decimal	True		False	The step number of this task within its sequence enrollment.
Task Status	String	False		False	Current status of the task, such as 'Not Started' or 'Completed'.
Task Title	String	False		False	The subject or title of the task.
Task template id	Decimal	True		False	ID of the task template used to create this task.
Task Type	String	False		False	Type of task, such as 'Call' or 'Follow-up'.
Due date	Datetime	False		False	Scheduled due date and time of the task.
Unique creation key	String	True		False	Unique key used to support idempotent creation via API.
Unique ID	String	False		False	Globally unique identifier for the task engagement.
Updated by user ID	Decimal	True		False	User ID of the individual who last updated the task.
User IDs of all notification followers	String	True		False	IDs of users following this task for notifications.
User IDs of all notification unfollowers	String	True		False	IDs of users who have opted out of notifications for this task.
User IDs of all owners	String	True		False	IDs of all users assigned as owners of this task engagement.
Owner Assigned Date	Datetime	True		False	Timestamp when the ownership of this task was assigned.
Assigned to	String	False		False	User assigned to complete the task, manually or via automation.
HubSpot Team	String	True		False	The team of the task's owner.
All owner ids	String	True		False	All default and custom owner IDs linked to this task.
All team ids	String	True		False	Team IDs linked to the owner properties of this task.
All accessible team ids	String	True		False	Team IDs, including hierarchy, that have access to view or manage this task.

FeedbackSubmissionAssociations

Returns object IDs associated with specific feedback submissions, useful for feedback association tracking.

Table-Specific Information

SELECT

The FeedbackSubmissionAssociations table always includes the same set of columns, but some return NULL unless you filter by Id and Type, which allows the Cloud to retrieve full association details.

To return full details for Feedback Submission associations, filter by both the Feedback Submission Id and the association Type. The Type identifies the associated object (such as a Deal, Company, Contact, or Ticket).

-- Retrieve all fields for associations between a specific Feedback Submission and its related Deals
SELECT *
FROM FeedbackSubmissionAssociations
WHERE Id = '436648510605'   -- FeedbackSubmission Id
  AND Type = 'Deal';        -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each FeedbackSubmission.

DELETE

To remove a Feedback Submission association, include both the Feedback Submission Id and the association Type:

-- Delete a FeedbackSubmission-Deal association
DELETE FROM FeedbackSubmissionAssociations
WHERE Id = '436648510605'   -- FeedbackSubmission Id
  AND Type = 'Deal';        -- Associated object type

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Deals.Id	False	Unique identifier of the feedback submission engagement.
AssociationId [KEY]	Long	False		False	ID of the associated object, such as a contact, company, or deal.
Type [KEY]	String	False		False	Type of the associated object, such as contact or deal.
TypeId [KEY]	String	False	AssociationsLabels.Id	False	The numeric ID representing the type of association. May be blank for general association queries.
Category [KEY]	String	False	AssociationsLabels.Type	False	The classification of the association type for the given object pair. May be blank for generic queries.

InvoiceAssociations

Retrieve the IDs of all the objects associated to specific Invoices objects in HubSpot.

Table-Specific Information

SELECT

The InvoiceAssociations table always includes the same set of columns, but some return NULL unless you filter by Id and Type, which allows the Cloud to retrieve full association details.

To return full details for Invoice associations, filter by both the Invoice Id and the association Type. The Type identifies the associated object (such as a Deal, Company, Contact, or Ticket).

-- Retrieve all fields for associations between a specific Invoice and its related Deals
SELECT *
FROM InvoiceAssociations
WHERE Id = '436648510605'   -- Invoice Id
  AND Type = 'Deal';        -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each Invoice.

DELETE

To remove an Invoice association, include both the Invoice Id and the association Type:

-- Delete an Invoice-Deal association
DELETE FROM InvoiceAssociations
WHERE Id = '436648510605'   -- Invoice Id
  AND Type = 'Deal';        -- Associated object type

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Invoices.Id	False	Invoices ID
AssociationId [KEY]	Long	False		False	ID of the object that this Invoices object is associated with.
Type [KEY]	String	False		False	Type of the associated object, for example, a contact or deal.
TypeId [KEY]	String	False	AssociationsLabels.TypeId	False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False	AssociationsLabels.Category	False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.
TypeLabel	String	True	AssociationsLabels.Label	False	The label assigned to the association type between objects.

Invoices

Retrieve the available Invoices in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Allow partial payments	Bool	False		True	Allow your customer to pay less than the balance due.
Allowed payment methods	String	False		False	The payment methods that can be used to pay the invoice.
Amount billed	Decimal	False		True	The amount billed on the invoice.
Amount billed in company currency	Decimal	True		True	The amount billed on the invoice in the company currency.
Amount billed (preTax)	Decimal	True		True	The amount billed on the invoice before tax.
Amount paid	Decimal	True		True	The total value of non-failed payments associated to the invoice.
Amount paid in company currency	Decimal	True		True	The total value of non-failed payments associated to the invoice in the company currency.
Amount processing	Decimal	True		True	The total value of processing payments associated to the invoice.
Line item names	String	True		True	The line item names associated to this invoice.
Balance due	Decimal	True		True	The balance due for the invoice.
Balance due in company currency	Decimal	True		True	The balance due for the invoice in the company currency.
Billing frequency type	String	True		False	Indicates whether or not the invoice is part of a recurring series (a subscription).
Address types to collect	String	False		False	The types of addresses that are collected while paying the invoice.
Comments	String	False		True	Comments to the invoice recipient.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Create Date	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Currency	String	False		True	The currency of the invoice.
Custom Invoice Fields	String	False		False	The custom fields that have been added to the invoice.
Days paid late	String	True		False	How many days the invoice was paid after the due date.
Discounts total	Decimal	True		True	The sum of all line item level discounts and invoice level discounts applied to the invoice.
Domain	String	False		True	Domain of the hosted rendered invoice.
Due date	Datetime	False		True	The due date for the current invoice.
Automated taxes on	Bool	False		True	Whether or not automated tax is enabled for the invoice.
Exchange rate	Decimal	True		True	This is the exchange rate used to convert the invoice amount into your company currency.
External account id	String	True		True	The 3rd party account Id associated with this invoice.
Invoice external create date/time	Datetime	False		True	The date and time at which the invoice was created in the 3rd party accounting application.
External id	String	True		True	The 3rd party unique Id associated with this invoice.
External recipient	String	False		True	The recipient of the current invoice.
Fees total	Decimal	True		True	The sum of all fees applied to the invoice.
Age category	String	True		False	How many days an invoice has been outstanding.
Invoice billable	Bool	False		True	Whether or not the invoice is billable.
Invoice class	String	False		True	Classification of an invoice, typically synced from third party accounting integrations.
Invoice date	Datetime	False		True	Date of the invoice.
Latest company name	String	True		True	The latest name value among companies associated to this invoice.
Latest contact email	String	True		True	The latest email value among contacts associated to this invoice.
Latest contact first name	String	True		True	The latest first name value among contacts associated to this invoice.
Latest contact last name	String	True		True	The latest last name value among contacts associated to this invoice.
Invoice link	String	True		True	The invoice url link, based on the domain and slug.
Invoice payment collection method	String	False		False	The method used to collect payment for the invoice.
Preset ID	Decimal	False		True	The id of the preset set for this invoice.
Invoice source	String	True		False	Creation source of the invoice.
Invoice status	String	False		False	The status of the invoice. Invoice statuses allow you to categorize and track billing progress.
Invoice status details	String	True		False	Additional invoice status details.
Invoice Tool Source	String	True		False	The tool that was used to create the invoice.
Invoice Tool Source ID	String	True		True	The ID of the tool used to create the invoice.
Language	String	False		True	Language of the invoice.
Last Edit Date	Datetime	True		True	The last time a finalized invoice was edited. This is automatically updated by HubSpot.
Last reminder sent date	Datetime	True		True	The last time an email reminder was sent to the customer. This is automatically updated by HubSpot.
Last sent date	Datetime	True		True	The last time the invoice was sent to the customer. This is updated automatically by HubSpot.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Locale	String	False		True	Locale of the invoice.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
net payment term	Decimal	False		True	Refers to the period, expressed in days (such as Net 30), within which invoice must be paid.
Number	String	False		True	The 3rd party number associated to this invoice.
Number of Subscriptions	Decimal	True		True	Number of subscriptions associated to the invoice.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Order level discounts total	Decimal	True		True	The sum of only invoice level discounts applied to the invoice.
Owning Teams	String	False		False	The teams that are attributed to this record.
Payment date	Datetime	False		True	The date when payment of an invoice has fully completed.
Payment status	String	True		False	The state of payment on an invoice.
PDF download link	String	True		True	The link to download the pdf of this invoice.
PO number	String	False		True	Purchase order number of the invoice.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Received by recipient date (QuickBooks Online)	Datetime	False		True	The date the invoice was received by the recipient.
Recipient company street address	String	False		True	The address of the recipient's company or organization.
Recipient company street address 2	String	False		True	Additional address of the recipient's company or organization.
Recipient company city	String	False		True	The city of the recipient's company or organization.
Recipient company country	String	False		True	The country of the recipient's company or organization.
Recipient company country code	String	False		True	The country code of the recipient's company or organization.
Recipient company state/region	String	False		True	The state or region of the recipient's company or organization.
Recipient company postal code	String	False		True	The postal or zip code of the recipient's company or organization.
Recipient shipping street address	String	False		True	The shipping address of the recipient.
Recipient shipping street address 2	String	False		True	Additional shipping address of the recipient.
Recipient shipping city	String	False		True	The shipping city of the recipient.
Recipient shipping country	String	False		True	The shipping country of the recipient.
Recipient shipping country code	String	False		True	The shipping country of the recipient.
Recipient shipping name	String	False		True	The shipping name of the recipient.
Recipient shipping state/region	String	False		True	The shipping state or region of the recipient.
Recipient shipping postal code	String	False		True	The shipping postal or zip code of the recipient.
Sender company address	String	True		True	The street address of the company sending this invoice.
Sender company address line 2	String	True		True	The second line of the street address of the company sending this invoice.
Sender company city	String	True		True	The city of the company sending this invoice.
Sender company country	String	True		True	The country of the company sending this invoice.
Sender company domain	String	True		True	The domain of the company sending this invoice.
Sender company logo url	String	True		True	The logo url of the company sending this invoice.
Sender company name	String	True		True	The name of the company sending this invoice.
Sender company state	String	True		True	The state of the company sending this invoice.
Sender company zip	String	True		True	The zip code of the company sending this invoice.
Shared teams	String	True		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	True		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Slug	String	False		True	Slug of the hosted rendered invoice.
External Invoice Status	String	True		False	The external status of the current invoice. This value is retrieved from a third party and may not be modified.
Store payment method at checkout	Bool	False		True	Allow customers to store their payment method at checkout.
Subtotal	Decimal	True		True	The sum of all line items of the invoice including line item level taxes.
Tax calculation ID	String	True		True	The id reference to the tax calculation data for the invoice.
Tax ID	String	False		False	The account tax ID listed on this invoice. The tax ID includes a tax ID type and a tax ID number.
Taxes total	Decimal	True		True	The sum of all taxes applied to the invoice.
Test mode	String	False		False	Indicates if the invoice is in test mode
Time zone	String	False		True	The time zone of dates on the invoice.
Title	String	False		True	Title of the invoice.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Unique id	String	True		True	The unique identifier of the invoice. This value is automatically set by HubSpot and may not be modified.
Upcoming reminder dates	String	True		False	The upcoming dates in which email reminders will be sent to the customer. This is updated automatically by HubSpot.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	Object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

LeadAssociations

Returns object IDs associated with specific leads, enabling management of lead associations.

Table-Specific Information

SELECT

The LeadAssociations table always includes the same set of columns, but some return NULL unless you filter by Id and Type, which allows the Cloud to retrieve full association details.

To return full details for Lead associations, filter by both the Lead Id and the association Type. The Type identifies the associated object (such as a Deal, Company, Contact, or Ticket).

-- Retrieve all fields for associations between a specific Lead and its related Deals
SELECT *
FROM LeadAssociations
WHERE Id = '436648510605'   -- Lead Id
  AND Type = 'Deal';        -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each Lead.

DELETE

To remove a Lead association, include both the Lead Id and the association Type:

-- Delete a Lead-Deal association
DELETE FROM LeadAssociations
WHERE Id = '436648510605'   -- Lead Id
  AND Type = 'Deal';        -- Associated object type

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Leads.Id	False	Unique identifier for the lead engagement record.
AssociationId [KEY]	Long	False		False	Identifier of the object associated with this lead, such as a contact, company, or deal.
Type [KEY]	String	False		False	The type of object associated with the lead, such as contact, deal, or ticket.

Leads

Lists all lead records available in HubSpot, supporting lead management workflows.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier assigned to each lead record in HubSpot.
Archived	Bool	True		True	Indicates whether the lead record has been archived and is no longer active.
CreatedAt	Datetime	True		False	Timestamp marking when the lead record was first created.
UpdatedAt	Datetime	True		False	Timestamp marking when the lead record was most recently updated.
All teams	String	True		False	List of all team IDs, including hierarchical teams, associated with the ownership properties for this lead.
Business units	String	False		False	Business units assigned to the lead for organizational categorization and reporting.
All owner ids	String	True		False	List of all owner user IDs associated with the lead, covering both default and custom owner properties.
All team ids	String	True		False	List of team IDs associated with all owner properties of the lead, excluding hierarchy.
Associated Company Domain	String	True		False	Domain name of the company associated with the lead, if available.
Associated Company Name	String	True		False	Company name linked to the lead, if available.
Associated Contact Email	String	True		False	Email address of the primary contact associated with the lead, if available.
Associated Contact First Name	String	True		False	First name of the primary contact associated with the lead, if available.
Associated Contact Last Name	String	True		False	Last name of the primary contact associated with the lead, if available.
Calls Connected Count	Decimal	True		False	Total number of calls made to the lead that resulted in a successful connection.
Primary company analytics source	String	True		False	Most recent analytics source from the primary associated company at the time the company was linked to the lead. This value does not update after creation.
Primary company analytics source first drilldown	String	True		False	First level of analytics source detail for the primary company associated with the lead. This value does not update after creation.
Primary company analytics source second drilldown	String	True		False	Second level of analytics source detail for the primary company associated with the lead. This value does not update after creation.
Company Avatar FileManager key	String	True		False	Path to the custom avatar image of the associated company, stored in HubSpot's FileManager.
Is Target Account	String	True		False	Indicates whether the associated company is flagged as a target account for marketing or sales purposes.
Company Last Activity Date	Datetime	True		False	Most recent activity date recorded for the primary associated company.
Company Last Engagement Date	Datetime	True		False	Most recent tracked engagement by a contact at the associated company. Excludes marketing emails and bulk communications.
Company Last Engagement Type	String	True		False	Type of the last tracked engagement performed by a contact at the associated company. Excludes marketing and mass emails.
Company Time of Last Session	Datetime	True		False	Timestamp for the most recent web session attributed to any contacts associated with the primary company.
Company Next Activity Date	Datetime	True		False	Scheduled date of the next activity associated with the primary company.
Company Next Activity Type	String	True		False	Type of the next scheduled activity related to the primary associated company.
Company Number of Pageviews	Decimal	True		False	Total number of website pageviews from all contacts linked to the primary associated company.
Associated company timezone	String	True		False	Timezone of the primary associated company, if available.
Primary contact analytics source	String	True		False	Most recent analytics source from the primary contact at the time of association with the lead. This value does not update after creation.
Primary contact analytics source first drilldown	String	True		False	First level of analytics source detail from the primary contact associated with the lead. This value does not update after creation.
Primary contact analytics source second drilldown	String	True		False	Second level of analytics source detail from the primary contact associated with the lead. This value does not update after creation.
Contact Avatar FileManager key	String	True		False	Path to the custom avatar image of the associated contact, stored in HubSpot's FileManager.
Contact Buying Role	String	True		False	Role of the associated contact in the buying or decision-making process.
Associated contact job title	String	True		False	Job title of the associated contact, if available.
Contact Last Activity Date	Datetime	True		False	Date of the last recorded activity performed by the associated contact.
Contact Last Engagement Date	Datetime	True		False	Date the contact last engaged with your website or tracked interactions. Excludes marketing emails and bulk communications.
Contact Last Engagement Type	String	True		False	Type of last engagement performed by the contact, excluding marketing and mass emails.
Contact Time of Last Session	Datetime	True		False	Timestamp of the most recent website session initiated by the lead's primary contact.
Contact Next Activity Date	Datetime	True		False	Scheduled date of the next activity planned for the lead's primary contact.
Contact Next Activity Type	String	True		False	Type of the next scheduled activity for the primary contact, such as a call or meeting.
Contact Number of Pageviews	Decimal	True		False	Total number of website pageviews recorded for the lead's primary contact.
Associated contact timezone	String	True		False	Timezone of the primary associated contact, if available.
Created by user ID	Decimal	True		False	HubSpot user ID of the individual who created the lead record. Automatically assigned by HubSpot.
Object create date/time	Datetime	True		False	Date and time when the lead object was created in HubSpot. Automatically generated.
Emails Connected Count	Decimal	True		False	Number of email interactions with the lead that resulted in a successful connection.
Initial Assign Notification State	String	True		False	Status indicating whether an initial assignment notification was sent when the lead was created.
Last Activity Date	Datetime	True		False	Most recent activity date for the lead, defaulting to the associated contact if available, otherwise the associated company.
Last Engagement Date	Datetime	True		False	Most recent engagement date for the lead, based on either the primary contact or associated company.
Last Engagement Type	String	True		False	Type of last engagement for the lead, prioritizing the primary contact, or otherwise the associated company.
Lead Time of Last Session	Datetime	True		False	Timestamp of the last recorded session by the primary associated contact or, if unavailable, the associated company.
Object last modified date/time	Datetime	True		False	Most recent timestamp of any update made to the lead object, including internal property changes.
Associated Deal Pipeline Stage	String	True		False	Sales pipeline stage of the primary associated deal linked to the lead.
Associated deals	Decimal	True		False	Total number of deals associated with the lead.
Call Count	Decimal	True		False	Total number of calls logged against the lead.
Closed won deal amount	Decimal	True		False	Total monetary value of all closed-won deals associated with the lead.
Message Thread Count	Decimal	True		False	Total number of message threads (such as SMS, LinkedIn, or WhatsApp) involving the lead.
Currency	String	True		False	Currency code associated with the most recent deal linked to the lead.
Lead Disqualification Note	String	False		False	Free-text note explaining why the lead was disqualified.
Disqualification Reason	String	False		False	Dropdown field listing the reason for lead disqualification.
Email Count	Decimal	True		False	Total number of emails sent to the lead.
First Outreach Date	Datetime	True		False	Date of the first recorded outreach (such as a call, email, or meeting) initiated toward the lead.
Lead Inferred Pseudostage	String	True		False	Inferred lead pipeline pseudostage based on the lead's activities and interactions.
Is Disqualified	Decimal	True		False	Flag indicating whether the lead is disqualified (1 = yes, 0 = no). Used for internal reporting.
In progress leads	Decimal	True		False	Flag indicating whether the lead is actively being worked on (1 = yes, 0 = no). Used for reporting.
Is New	Decimal	True		False	Flag indicating whether the lead is newly created (1 = yes, 0 = no). Used internally for reporting.
Open leads	Decimal	True		False	Indicates whether the lead is in an open stage, meaning not yet qualified or disqualified.
Is Qualified	Decimal	True		False	Flag indicating whether the lead has been qualified (1 = yes, 0 = no). Used for reporting purposes.
Lead Label	String	False		False	Current sales status label assigned to the lead.
Meeting Count	Decimal	True		False	Total number of meetings booked with the lead.
Lead Name	String	False		False	Full name of the lead, as entered in HubSpot.
Lead name calculated	String	True		False	Automatically calculated full name for the lead based on associated contact properties.
Outreach activity count	Decimal	True		False	Total number of outbound activities (calls, emails, meetings, or other communications) performed toward the lead.
Open deal amount	Decimal	True		False	Combined value of all currently open deals associated with the lead.
Primary Company Owner	String	True		False	Owner ID of the primary associated company linked to the lead.
Primary Contact Owner	String	True		False	Owner ID of the primary associated contact linked to the lead.
Lead Source	String	True		False	Analytics source indicating how the lead was originally acquired, based on associated contact or company.
Initial company lifecycle stage	String	True		False	First recorded lifecycle stage of the primary associated company when linked to the lead. This value does not update.
Initial contact lifecycle stage	String	True		False	First recorded lifecycle stage of the primary associated contact when linked to the lead. This value does not update.
Lead Source DrillDown 1	String	True		False	Second tier of detail about how the lead was sourced.
Lead Source DrillDown 2	String	True		False	Third tier of detail about how the lead was sourced.
Initial source lifecycle stage	String	True		False	Lifecycle stage of the associated contact or company at the time of the lead's creation.
Time to First Touch	Decimal	True		False	Elapsed time between lead creation and first outreach activity logged against the lead.
Lead Title (DEPRECATEDUse hsLeadName)	String	True		False	Deprecated lead title field. Use hsLeadName instead.
Lead Type	String	False		False	Categorization of the lead, such as New Business, Existing Business, or Re-attempting.
Meetings Connected Count	Decimal	True		False	Total number of meetings associated with the lead that were considered connected.
Merged record IDs	String	True		False	List of record IDs that have been merged into this lead record. Automatically generated by HubSpot.
Next Activity Date	Datetime	True		False	Scheduled date of the next activity, prioritized by the primary contact or associated company.
Next Activity Type	String	True		False	Type of the next scheduled activity, based on the primary associated contact or company.
Lead Number of Pageviews	Decimal	True		False	Number of website pageviews recorded for the primary contact or, if unavailable, for the associated company.
Record ID	Decimal	True		False	Unique HubSpot-generated ID assigned to the lead record.
Record Creation Source	String	True		False	Internal metadata field indicating the source system where the lead record originated.
Record Source Detail 1	String	True		False	Primary detail level describing how the lead record was created.
Record Source Detail 2	String	True		False	Secondary detail level describing how the lead record was created.
Record Source Detail 3	String	True		False	Tertiary detail level describing how the lead record was created.
Record Creation Source ID	String	True		False	Internal source ID representing how the lead record was created.
Record Source	String	True		False	Summary of the creation method for the lead record, based on internal metadata.
Record Creation Source User ID	Decimal	True		False	User ID associated with the creation of the lead, if available.
Lead owner calculated	String	True		False	Automatically determined owner of the lead, based on ownership of the primary contact or company.
Lead Pipeline	String	False		False	Pipeline in which the lead is currently categorized.
Lead Pipeline Stage	String	False		False	Current stage of the lead within its assigned pipeline.
Pipeline Stage Category	String	True		False	Category assigned to the lead's current pipeline stage for segmentation purposes.
Pipeline Stage Category Last Updated At	Datetime	True		False	Timestamp marking the most recent update to the lead's pipeline stage category.
Primary Associated Object Name	String	True		False	Name of the primary associated contact or company linked to the lead.
Primary Associated Company Object ID	Decimal	False		False	HubSpot object ID of the primary associated company connected to the lead.
Primary contact enrolled in sequence	Bool	True		False	Indicates whether the lead's primary associated contact is currently enrolled in a HubSpot sequence.
Primary Associated Contact Object ID	Decimal	False		False	HubSpot object ID of the primary associated contact linked to the lead.
Read Only Object	Bool	True		False	Indicates whether the lead record is read-only and cannot be modified.
Shared Team IDs	String	True		False	List of team IDs with shared access to the lead record.
Shared User IDs	String	True		False	List of user IDs with shared access permissions to the lead record.
Lead tags	String	True		False	List of tag IDs automatically assigned to the lead for segmentation or categorization.
Time in Attempting (Lead Pipeline)	Decimal	True		False	Total time in seconds that the lead spent in the 'Attempting' stage of the 'Lead pipeline'.
Time in Connected (Lead Pipeline)	Decimal	True		False	Total time in seconds that the lead spent in the 'Connected' stage of the 'Lead pipeline'.
Time in New (Lead Pipeline)	Decimal	True		False	Total time in seconds that the lead spent in the 'New' stage of the 'Lead pipeline'.
Time in Qualified (Lead Pipeline)	Decimal	True		False	Total time in seconds that the lead spent in the 'Qualified' stage of the 'Lead pipeline'.
Time in Disqualified (Lead Pipeline)	Decimal	True		False	Total time in seconds that the lead spent in the 'Disqualified' stage of the 'Lead pipeline'.
Unique creation key	String	True		False	Unique property used for idempotent creation of lead records to prevent duplication.
Updated by user ID	Decimal	True		False	User ID of the person who most recently updated the lead record. Automatically managed by HubSpot.
User IDs of all notification followers	String	True		False	List of user IDs who chose to follow this lead and receive notifications.
User IDs of all notification unfollowers	String	True		False	List of user IDs who opted out of receiving notifications for this lead.
User IDs of all owners	String	True		False	List of all user IDs assigned as owners of the lead record.
Cumulative time in Attempting (Lead pipeline)	Decimal	True		False	Cumulative total time spent by the lead in the 'Attempting' stage of the 'Lead pipeline'.
Cumulative time in Connected (Lead pipeline)	Decimal	True		False	Cumulative total time spent by the lead in the 'Connected' stage of the 'Lead pipeline'.
Cumulative time in New (Lead pipeline)	Decimal	True		False	Cumulative total time spent by the lead in the 'New' stage of the 'Lead pipeline'.
Cumulative time in Qualified (Lead pipeline)	Decimal	True		False	Cumulative total time spent by the lead in the 'Qualified' stage of the 'Lead pipeline'.
Cumulative time in Disqualified (Lead pipeline)	Decimal	True		False	Cumulative total time spent by the lead in the 'Disqualified' stage of the 'Lead pipeline'.
Date entered Attempting (Lead pipeline)	Datetime	True		False	Date and time when the lead entered the 'Attempting' stage of the 'Lead pipeline'.
Date entered Connected (Lead pipeline)	Datetime	True		False	Date and time when the lead entered the 'Connected' stage of the 'Lead pipeline'.
Date entered New (Lead pipeline)	Datetime	True		False	Date and time when the lead entered the 'New' stage of the 'Lead pipeline'.
Date entered Qualified (Lead pipeline)	Datetime	True		False	Date and time when the lead entered the 'Qualified' stage of the 'Lead pipeline'.
Date entered Disqualified (Lead pipeline)	Datetime	True		False	Date and time when the lead entered the 'Disqualified' stage of the 'Lead pipeline'.
Date exited Attempting (Lead pipeline)	Datetime	True		False	Date and time when the lead exited the 'Attempting' stage of the 'Lead pipeline'.
Date exited Connected (Lead pipeline)	Datetime	True		False	Date and time when the lead exited the 'Connected' stage of the 'Lead pipeline'.
Date exited New (Lead pipeline)	Datetime	True		False	Date and time when the lead exited the 'New' stage of the 'Lead pipeline'.
Date exited Qualified (Lead pipeline)	Datetime	True		False	Date and time when the lead exited the 'Qualified' stage of the 'Lead pipeline'.
Date exited Disqualified (Lead pipeline)	Datetime	True		False	Date and time when the lead exited the 'Disqualified' stage of the 'Lead pipeline'.
Latest time in Attempting (Lead pipeline)	Decimal	True		False	Total time in seconds spent in the 'Attempting' stage since the last time the lead entered it.
Latest time in Connected (Lead pipeline)	Decimal	True		False	Total time in seconds spent in the 'Connected' stage since the last time the lead entered it.
Latest time in New (Lead pipeline)	Decimal	True		False	Total time in seconds spent in the 'New' stage since the last time the lead entered it.
Latest time in Qualified (Lead pipeline)	Decimal	True		False	Total time in seconds spent in the 'Qualified' stage since the last time the lead entered it.
Latest time in Disqualified (Lead pipeline)	Decimal	True		False	Total time in seconds spent in the 'Disqualified' stage since the last time the lead entered it.
Performed in an import	Bool	True		False	Indicates whether the lead record was created as part of a data import process.
Workflow updated lifecycle stage of company	Bool	False		False	Indicates whether a workflow automatically updated the lifecycle stage of the associated company.
Workflow updated lifecycle stage of contact	Bool	False		False	Indicates whether a workflow automatically updated the lifecycle stage of the associated contact.
Owner Assigned Date	Datetime	True		False	Date and time when ownership of the lead was most recently assigned or changed.
Lead Owner	String	False		False	Primary owner assigned to the lead. Defaults to the primary contact's owner or, if not available, the company's owner.
HubSpot Team	String	True		False	Primary HubSpot team associated with the owner of the lead.
lead custom field	String	False		False	Custom field associated with the lead. Purpose varies depending on configuration.

LineitemAssociations

Returns object IDs associated with specific line items in HubSpot, supporting deal line item relationships.

Table-Specific Information

SELECT

The LineitemAssociations table always includes the same set of columns, but some return NULL unless you filter by Id and Type, which allows the Cloud to retrieve full association details.

To return full details for Line Item associations, filter by both the Line Item Id and the association Type. The Type identifies the associated object (such as a Deal, Company, Contact, or Ticket).

-- Retrieve all fields for associations between a specific Line Item and its related Deals
SELECT *
FROM LineItemAssociations
WHERE Id = '436648510605'   -- LineItem Id
  AND Type = 'Deal';        -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each LineItem.

DELETE

To remove a Line Item association, include both the Line Item Id and the association Type:

-- Delete a LineItem-Deal association
DELETE FROM LineItemAssociations
WHERE Id = '436648510605'   -- LineItem Id
  AND Type = 'Deal';        -- Associated object type

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Lineitems.Id	False	Unique identifier of the LineItem record.
AssociationId [KEY]	Long	False		False	Unique identifier of the object associated with this LineItem.
Type [KEY]	String	False		False	The type of the associated object, such as a contact, deal, or ticket.
TypeId [KEY]	String	False	AssociationsLabels.TypeId	False	Numeric ID representing the specific association type. This field is empty for general association queries.
Category [KEY]	String	False	AssociationsLabels.Category	False	The category of the association type for the object pair. This field is empty for general association queries.
TypeLabel	String	True	AssociationsLabels.Label	False	The descriptive label assigned to the association type between objects.

Lineitems

Lists all line item records in HubSpot, supporting both OAuth and private-app token authentications.

Table Specific Information

In HubSpot, line items can be thought of as a subset of products. When a product is attached to a deal, it becomes a line item. You can create line items that are unique to an individual quote, but they will not be added to your product library.

SELECT

When selecting line items, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM LineItems WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM LineItems WHERE Archived = TRUE;

INSERT

INSERT INTO LineItems (Description, [Product ID]) VALUES ('description', '33318601')

UPDATE

UPDATE LineItems SET Description = 'new description' WHERE ID = '168209183'

DELETE

DELETE FROM Deals WHERE ID = '168209183'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier of the line item record.
Archived	Bool	True		True	Indicates whether the line item has been archived.
CreatedAt	Datetime	True		False	Timestamp when the line item was created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the line item.
Net price	Decimal	True		False	The net amount for the line item after discounts, excluding taxes and fees.
Create Date	Datetime	False		False	The original creation date of the line item record.
Description	String	False		False	Detailed description of the product associated with the line item.
Unit discount	Decimal	False		False	Flat discount amount applied to a single unit of the line item.
Annual contract value	Decimal	True		False	The annual contract value (ACV) of the product in the line item.
All accessible team IDs	String	True		False	Team IDs, including hierarchical relationships, that have access to this line item record.
Business units	String	False		False	Business units associated with this line item.
All owner ids	String	True		False	User IDs for all owners assigned to this line item, including default and custom properties.
All team ids	String	True		False	Team IDs corresponding to owner properties for this line item.
Allow buyer selected quantity	String	True		False	Specifies whether the buyer can select the quantity of the line item during checkout.
Annual recurring revenue	Decimal	True		False	The annual recurring revenue (ARR) generated by this product.
Delayed billing start by days	Decimal	False		False	Number of days to delay the billing start date from the deal close date.
Delayed billing start by months	Decimal	False		False	Number of months to delay the billing start date from the deal close date.
Start billing terms	String	True		False	Type of billing delay, such as fixed start date or relative delay in days or months.
Unit cost	Decimal	False		False	Internal cost of the product being sold, used to calculate margin.
Created by user ID	Decimal	True		False	User ID of the creator of the line item. Automatically set by HubSpot.
Object create date_time	Datetime	True		False	Date and time when the line item object was created. Automatically set by HubSpot.
Discount Percentage	Decimal	False		False	Percentage discount applied to the line item.
External LineItem id	Decimal	True		False	External system identifier for the line item.
Image URL	String	False		False	URL of the image representing the product in this line item.
Last Modified Date	Datetime	True		False	Timestamp when any property on the line item was last modified.
Currency	String	False		False	Currency code used for the line item.
Margin	Decimal	True		False	The profit margin calculated from unit price and unit cost.
Annual contract value margin	Decimal	True		False	Profit margin calculated using the annual contract value.
Annual recurring revenue margin	Decimal	True		False	Profit margin calculated using the annual recurring revenue.
Monthly recurring revenue margin	Decimal	True		False	Profit margin calculated using the monthly recurring revenue.
Total contract value margin	Decimal	True		False	Profit margin calculated using the total contract value.
Merged object IDs	String	True		False	List of object IDs that have been merged into this line item record. Automatically set by HubSpot.
Monthly recurring revenue	Decimal	True		False	The monthly recurring revenue (MRR) generated by the product in this line item.
Record ID	Decimal	True		False	Unique identifier for this line item record. Automatically set by HubSpot.
Position on quote	Decimal	False		False	The display order of this line item on the quote document.
Pre Discount Amount	Decimal	True		False	The original amount of the line item before any discounts were applied.
Product ID	Decimal	False		False	Identifier of the product this line item is based on or associated with.
Read Only Object	Bool	True		False	Indicates whether this line item is read-only and cannot be edited by users.
End Date	Date	True		False	The end date for the line item's recurring billing period.
Number of payments	Decimal	True		False	Number of billing cycles for the recurring line item payment schedule.
Term	String	False		False	The billing term or duration associated with the line item, such as monthly or annual.
Billing start date	Date	False		False	Start date for the line item's billing schedule.
Billing terms	String	True		False	Specifies whether the billing is fixed-term or indefinite (until canceled).
SKU	String	False		False	Stock Keeping Unit identifier for the product in this line item.
Sync amount	Decimal	True		False	Amount synced from an external ecommerce platform for this line item.
Total contract value	Decimal	True		False	The total contract value (TCV) for the product, considering price, quantity, and term.
Term in months	Decimal	True		False	The total number of months in the billing term for this line item.
Calculated Total Discount	Decimal	True		False	Combined discount amount calculated from percentage and flat discounts.
Unique creation key	String	True		False	Custom key used to prevent duplicate line item creation during data sync or import.
Updated by user ID	Decimal	True		False	User ID of the person who last updated the line item. Automatically set by HubSpot.
URL	String	False		False	The URL of the product linked to this line item, if available.
User IDs of all notification followers	String	True		False	IDs of users who opted to receive updates about this line item.
User IDs of all notification unfollowers	String	True		False	IDs of users who opted out of receiving updates about this line item.
User IDs of all owners	String	True		False	IDs of all users who are owners of this line item.
Variant id of the product	Decimal	True		False	Shopify variant ID corresponding to this product if applicable.
Owner Assigned Date	Datetime	True		False	Timestamp when ownership of the line item was last assigned. Automatically set by HubSpot.
Owner	String	False		False	User assigned as the current owner of this line item.
HubSpot Team	String	True		False	Primary team associated with the owner of the line item.
Name	String	False		False	The name of the product shown in this line item.
Unit price	Decimal	False		False	Price per unit of the product in this line item.
Quantity	Decimal	False		False	The number of units for this product in the line item.
Billing frequency	String	False		False	How often this line item is billed, such as monthly or annually.
Tax	Decimal	False		False	Tax amount applied to the line item, if applicable.

ListingAssociations

Retrieve the IDs of all the objects associated to specific Listings objects in HubSpot.

Table Specific Information

The ListingAssociations table provides access to the relationship data between listing records and other HubSpot objects such as contacts, companies, deals, and tickets.

SELECT

When selecting listing associations, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM ListingAssociations WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'
SELECT * FROM ListingAssociations WHERE Type = 'contacts'

INSERT

INSERT INTO ListingAssociations (ID, AssociationId, Type) VALUES ('25151', '12345', 'contacts')

DELETE

DELETE FROM ListingAssociations WHERE ID = '25151' AND AssociationId = '12345'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Listings.Id	False	Listings ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Listings object is associated with.
Type [KEY]	String	False		False	Type of the associated object, which can be a contact, deal etc.
TypeId [KEY]	String	False		False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False		False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.
TypeLabel	String	True		False	The label assigned to the association type between objects.

Listings

Retrieve the available Listings in HubSpot.

Table Specific Information

In HubSpot, listings represent real estate properties or other items being offered for sale or rent. Listing records help users track inventory, pricing, and status through pipeline stages.

SELECT

When selecting listings, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Listings WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'

INSERT

INSERT INTO Listings ([Name]) VALUES ('Luxury Downtown Condo')

UPDATE

UPDATE Listings SET [Name] = 'Updated Property Name' WHERE ID = '25151'

DELETE

DELETE FROM Listings WHERE ID = '25151'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
Address 1	String	False		True	Primary street address line.
Address 2	String	False		True	Secondary address info (apartment, suite, unit).
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Bathroom(s)	Decimal	False		True	Number of bathrooms (full/partial) in the property.
Bedroom(s)	Decimal	False		True	Number of bedrooms in the property.
City	String	False		True	City where listing is located.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Date entered 'Closed Stage (Listing Pipeline)'	Datetime	True		True	The date and time when the Listing entered the 'Closed Stage' stage, 'Listing Pipeline' pipeline.
Date entered 'Open Stage (Listing Pipeline)'	Datetime	True		True	The date and time when the Listing entered the 'Open Stage' stage, 'Listing Pipeline' pipeline.
Date exited 'Closed Stage (Listing Pipeline)'	Datetime	True		True	The date and time when the Listing exited the 'Closed Stage' stage, 'Listing Pipeline' pipeline.
Date exited 'Open Stage (Listing Pipeline)'	Datetime	True		True	The date and time when the Listing exited the 'Open Stage' stage, 'Listing Pipeline' pipeline.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Listing Type	String	False		False	Type of listing (for sale / rent / lease).
Lot Size	Decimal	False		True	Size of the land lot (outside area).
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Name	String	False		True	Name/title of the listing, such as '3-bed house on Main Street'.
Neighborhood	String	False		True	Name of the neighborhood or local area.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Owning Teams	String	False		False	The teams that are attributed to this record.
Pipeline	String	False		False	The pipeline that contains this listing.
Pipeline Stage	String	False		False	The pipeline stage that contains this listing.
Price	Decimal	False		True	Listing price (currency).
Price/sqft	Decimal	True		True	Price per square foot (or per unit area).
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	False		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	False		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Square Footage	Decimal	False		True	Size of the interior living space.
State/Province	String	False		True	State or province region of the listing.
Time in 'Closed Stage (Listing Pipeline)'	Decimal	True		True	The total time in seconds spent by the Listing in the 'Closed Stage' stage, 'Listing Pipeline' pipeline.
Time in 'Open Stage (Listing Pipeline)'	Decimal	True		True	The total time in seconds spent by the Listing in the 'Open Stage' stage, 'Listing Pipeline' pipeline.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Performed in an import	Bool	True		True	Object is part of an import.
Year Built	Decimal	False		True	Year when the property was constructed.
Zip	Decimal	False		True	Postal or ZIP code.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

OrderAssociations

Returns object IDs associated with specific order records, enabling order association tracking.

Table-Specific Information

SELECT

The OrderAssociations table always includes the same set of columns, but some return NULL unless you filter by Id and Type, which allows the Cloud to retrieve full association details.

To return full details for Order associations, filter by both the Order Id and the association Type. The Type identifies the associated object (such as a Deal, Company, Contact, or Ticket).

-- Retrieve all fields for associations between a specific Order and its related Deals
SELECT *
FROM OrderAssociations
WHERE Id = '436648510605'   -- Order Id
  AND Type = 'Deal';        -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each Order.

DELETE

To remove an Order association, include both the Order Id and the association Type:

-- Delete an Order-Deal association
DELETE FROM OrderAssociations
WHERE Id = '436648510605'   -- Order Id
  AND Type = 'Deal';        -- Associated object type

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Orders.Id	False	Unique identifier of the order record.
AssociationId [KEY]	Long	False		False	Identifier of the object associated with this order, such as a contact or deal.
Type [KEY]	String	False		False	Type of the associated object, such as contact, deal, or ticket.

Orders

Lists all order records in HubSpot for managing order workflows.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier of the order record.
Archived	Bool	True		True	Indicates whether the order record has been archived.
CreatedAt	Datetime	True		False	Timestamp when the order was initially created.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update to the order.
All teams	String	True		False	IDs of all teams, including those in the hierarchy, associated with ownership properties of this order.
Business units	String	False		False	The business units assigned to this order record.
All owner ids	String	True		False	All owner ID values from default and custom ownership fields on the order.
All team ids	String	True		False	All team ID values from default and custom ownership fields on the order.
Billing City	String	False		False	City listed in the billing address.
Billing Country	String	False		False	Country listed in the billing address.
Billing Email	String	False		False	Email address of the customer as provided in the billing information.
Billing First Name	String	False		False	First name of the customer as provided in the billing information.
Billing Last Name	String	False		False	Last name of the customer as provided in the billing information.
Billing Phone Number	String	False		False	Phone number provided in the billing address.
Billing ZIP/Postal Code	String	False		False	Postal or ZIP code listed in the billing address.
Billing State	String	False		False	State or province listed in the billing address.
Billing Street	String	False		False	Street address from the billing details.
Buyer Accepts Marketing	Bool	False		False	Indicates whether the customer has opted into receiving marketing communications.
Cancellation Reason	String	False		False	Reason provided for the cancellation of the order.
Closed Date	Datetime	True		False	Date when the order was closed. This is set automatically and may be null if the order was not closed.
Created by user ID	Decimal	True		False	ID of the user who created the order. Set automatically by HubSpot and cannot be edited.
Object create date/time	Datetime	True		False	Date and time when the order object was created. This is system-generated and not editable.
Currency Code	String	False		False	Currency code (such as USD or EUR) used for the order total.
Customer Phone	String	False		False	Phone number of the customer who placed the order.
Date entered Stage 1 (Pipeline 1)	Datetime	True		False	Date when the order entered 'Stage 1' of 'Pipeline 1'.
Date exited Stage 1 (Pipeline 1)	Datetime	True		False	Date when the order exited 'Stage 1' of 'Pipeline 1'.
Discount Codes	String	False		False	Any discount codes applied to the order.
Exchange rate	Decimal	False		False	Currency exchange rate used to convert the order amount into company currency.
Canceled Date	Datetime	False		False	Date the order was marked as canceled.
Cart ID	String	False		False	Unique identifier from the external system representing the cart tied to the order.
Checkout ID	String	False		False	Unique identifier from the external system representing the checkout session for this order.
Created Date	Datetime	False		False	Original creation date of the order from the external system.
Modified Date	Datetime	False		False	Last modified date of the order as captured from the source system.
Order ID	String	False		False	External system's unique identifier for the order.
Status	String	False		False	Current status of the order, as defined by the source system (such as open, completed, or canceled).
Order URL	String	False		False	URL linking to the external system's order details page.
Fulfillment Status	String	False		False	Current shipping or delivery status of the order.
Amount in company currency	Decimal	False		False	Total order amount converted to your company's primary currency using the exchange rate.
Landing Site	String	False		False	First page visited on the seller's website before placing the order.
Object last modified date/time	Datetime	True		False	Most recent property update timestamp for this order, including hidden and system fields.
Merged record IDs	String	True		False	IDs of any order records that were merged into this one. Automatically set by HubSpot.
Record ID	Decimal	True		False	HubSpot's internal unique identifier for the order.
Record Creation Source	String	True		False	System value indicating how the record was created, sourced from RequestMeta.
Record Source Detail 1	String	True		False	Primary method or channel through which the order record was created.
Record Source Detail 2	String	True		False	Secondary method or metadata related to how the order record was created.
Record Source Detail 3	String	True		False	Tertiary detail providing additional context for the record's creation source.
Record Creation Source ID	String	True		False	Internal source ID associated with the record creation in the system.
Record Source	String	True		False	Describes the general creation source or channel for the order.
Record Creation Source User ID	Decimal	True		False	User ID of the actor that triggered the order creation, where available.
Discount	Decimal	False		False	Total amount of discount applied to the order.
Name	String	False		False	Human-readable or numeric identifier for the order, typically used in UI display.
Notes	String	False		False	Any additional notes or comments associated with the order.
Payment Processing Method	String	False		False	The payment gateway or processor used for this order.
Payment Status	String	False		False	The current status of payment for the order, such as 'paid' or 'unpaid'.
Pinned engagement ID	Decimal	False		False	ID of the engagement currently pinned to the order, if applicable.
Pipeline	String	False		False	The sales pipeline in which the order is located.
Stage	String	False		False	The specific stage within the order pipeline.
Processed Date	Datetime	False		False	Timestamp when the order data was imported into HubSpot.
Read Only Object	Bool	True		False	Indicates if the order record is read-only.
Referring Site	String	False		False	The external site the customer visited before coming to the seller's site.
Refund Amount	Decimal	False		False	Amount refunded to the customer for this order.
Shared Team IDs	String	True		False	Team IDs with shared access to this order record.
Shared User IDs	String	True		False	User IDs with shared access to this order record.
Shipping City	String	False		False	City listed in the shipping address.
Shipping Country	String	False		False	Country listed in the shipping address.
Shipping Phone Number	String	False		False	Phone number provided in the shipping address.
Shipping ZIP/Postal Code	String	False		False	Postal or ZIP code for the shipping destination.
Shipping State	String	False		False	State or province for the shipping destination.
Shipping Street	String	False		False	Street address for the shipping destination.
Shipping Cost	Decimal	False		False	Shipping charges in the order's transaction currency before discounts.
Shipping Status URL	String	False		False	URL to track the shipping status of the order.
Shipping Tracking Number	String	False		False	Tracking number(s) for shipments associated with the order.
Source ID	Decimal	True		False	HubSpot App ID from which this order was first synced.
Source Store	String	False		False	Identifies the store or system from which the order originated.
Subtotal Price	Decimal	False		False	Total order value before taxes, duties, and discounts.
Tags	String	False		False	Tags or labels associated with this order.
Tax Price	Decimal	False		False	Total amount of tax, including duties, applied to the order.
Time in Stage 1 (Pipeline 1)	Decimal	True		False	Total time in seconds the order remained in 'Stage 1' of 'Pipeline 1'.
Total Price	Decimal	False		False	Final total price of the order including taxes, shipping, and discounts.
Total Weight	String	False		False	Cumulative weight of all items in the order, used for shipping purposes.
Unique creation key	String	True		False	A unique identifier used to ensure the order record is created idempotently.
Updated by user ID	Decimal	True		False	ID of the last user who modified this order record. Automatically tracked by HubSpot.
User IDs of all notification followers	String	True		False	IDs of users who have opted in to receive notifications about this order.
User IDs of all notification unfollowers	String	True		False	IDs of users who have opted out of receiving notifications about this order.
User IDs of all owners	String	True		False	IDs of all users who are listed as owners of this order.
Performed in an import	Bool	True		False	Indicates whether the order was created as part of an import operation.
Owner Assigned Date	Datetime	True		False	Timestamp when the owner was assigned to the order. Automatically managed by HubSpot.
Owner	String	False		False	User assigned as the owner of this order.
HubSpot Team	String	True		False	The primary team of the order owner.

Products

Lists all product records configured in HubSpot, supporting both OAuth and private-app token authentications.

Table Specific Information

In HubSpot, products represent the goods or services you sell. Building a product library allows you to quickly add products to deals, generate quotes, and report on product performance.

SELECT

When selecting products, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Products WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM Products  WHERE Archived = TRUE;

INSERT

INSERT INTO Products ([Product description]) VALUES ('description')

UPDATE

UPDATE Products SET [Product description] = 'new description' WHERE ID = '75229453'

DELETE

DELETE FROM Products WHERE ID = '75229453'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier of the product object.
Archived	Bool	True		True	Indicates whether the product record is archived.
CreatedAt	Datetime	True		False	Timestamp when the product was first created in the system.
UpdatedAt	Datetime	True		False	Timestamp of the most recent update made to the product.
Net price	Decimal	True		False	Placeholder value used to avoid conflicts with similarly named line item fields.
Create Date	Datetime	False		False	Date the product record was created.
Product description	String	False		False	Detailed description of the product's features or purpose.
Unit discount	Decimal	False		False	Flat discount amount applied to the product.
All accessible team IDs	String	True		False	IDs of all teams, including hierarchical teams, associated with ownership of this product.
Business units	String	False		False	Business units that the product is assigned to.
All owner ids	String	True		False	All owner IDs associated with the product through default and custom properties.
All team ids	String	True		False	IDs of teams linked to this product via ownership references.
Avatar FileManager key	String	True		False	File path in the HubSpot FileManager CDN for the product's image. Automatically set by the platform.
Unit cost	Decimal	False		False	Cost incurred by the company for the product sold.
Created by user ID	Decimal	True		False	User ID of the creator of the product. This is set automatically by HubSpot and is read-only.
Object create date_time	Datetime	True		False	Date and time when the product object was created. Automatically populated and not editable.
Discount Percentage	Decimal	False		False	Percentage discount applied to the product price.
Folder Id	Decimal	False		False	Identifier of the folder in which the product is stored.
Image Url	String	False		False	URL to the product image, typically for display in catalogs or listings.
Last Modified Date	Datetime	True		False	Timestamp of the last change made to the product record.
Merged object IDs	String	True		False	List of product IDs that were merged into this one. Managed automatically by HubSpot.
Record ID	Decimal	True		False	Internal HubSpot ID for the product record. This value is system-generated.
Product Type	String	False		False	Category of the product, typically 'Inventory', 'Non_Inventory', or 'Service'.
Read Only Object	Bool	True		False	Indicates if the product record is in a read-only state.
Term	String	False		False	The billing term or contract duration for recurring billing products.
Start Date	Date	False		False	Start date for recurring billing associated with this product.
SKU	String	False		False	Stock Keeping Unit. A unique code used to identify the product.
Unique creation key	String	True		False	Key used to ensure idempotent product creation through integrations.
Updated by user ID	Decimal	True		False	User ID of the person who last updated the product. Automatically maintained by HubSpot.
URL	String	False		False	Web URL pointing to the product's external or internal page.
User IDs of all notification followers	String	True		False	IDs of users who opted in to receive notifications about this product record.
User IDs of all notification unfollowers	String	True		False	IDs of users who opted out of receiving product-related notifications.
User IDs of all owners	String	True		False	All user IDs assigned as owners of this product.
Owner Assigned Date	Datetime	True		False	Timestamp when an owner was most recently assigned to the product. Managed by HubSpot.
Owner	String	False		False	Current owner of the product record.
HubSpot Team	String	True		False	Primary HubSpot team assigned to the product owner.
Name	String	False		False	The name or title of the product.
Unit price	Decimal	False		False	Price per unit of the product.
Quantity	Decimal	True		False	Placeholder used to avoid naming conflict with quantity on line items.
Recurring billing frequency	String	False		False	Frequency of billing for recurring products (for example, monthly or annually). Excludes one-time billing products.
Tax	Decimal	False		False	Amount of tax applied to the product.

QuoteAssociations

Returns object IDs associated with specific quotes in HubSpot for managing quote associations.

Table-Specific Information

SELECT

The QuoteAssociations table always includes the same set of columns, but some return NULL unless you filter by Id and Type, which allows the Cloud to retrieve full association details.

To return full details for Quote associations, filter by both the Quote Id and the association Type. The Type identifies the associated object (such as a Deal, Company, Contact, or Ticket).

-- Retrieve all fields for associations between a specific Quote and its related Deals
SELECT *
FROM QuoteAssociations
WHERE Id = '436648510605'   -- Quote Id
  AND Type = 'Deal';        -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each Quote.

DELETE

To remove a Quote association, include both the Quote Id and the association Type:

-- Delete a Quote-Deal association
DELETE FROM QuoteAssociations
WHERE Id = '436648510605'   -- Quote Id
  AND Type = 'Deal';        -- Associated object type

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Quotes.Id	False	Unique identifier for the quote record.
AssociationId [KEY]	Long	False		False	Identifier of the object that this quote is linked or associated with.
Type [KEY]	String	False		False	Type of the associated object, such as a contact, deal, or ticket.
TypeId [KEY]	String	False	AssociationsLabels.TypeId	False	Numeric identifier for the association type. Typically used in specific or advanced association queries; may be empty for general use.
Category [KEY]	String	False	AssociationsLabels.Category	False	Category describing the nature of the association between the quote and the associated object. This field may be blank for general associations.
TypeLabel	String	True	AssociationsLabels.Label	False	Human-readable label describing the type of relationship between the quote and the associated object.

Quotes

Lists all quote records in HubSpot, useful for sales proposal management.

Table Specific Information

In HubSpot, quotes are used to share pricing information with potential buyers.

SELECT

When selecting quotes, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Quotes WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM Quotes WHERE Archived = TRUE;

INSERT

INSERT INTO Quotes ([Quote Title]) VALUES ('title')

UPDATE

UPDATE Quotes SET [Quote Title] = 'new title' WHERE ID = '75229453'

DELETE

DELETE FROM Quotes WHERE ID = '75229453'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier assigned to each quote record in HubSpot.
Archived	Bool	True		True	Indicates whether the quote is archived and no longer editable.
CreatedAt	Datetime	True		False	Timestamp when the quote was initially created.
UpdatedAt	Datetime	True		False	Timestamp when the quote was most recently updated.
Business units	String	False		False	Business units assigned to this quote for organizational tracking and segmentation.
Allowed Payment Methods	String	False		False	Accepted payment methods for the quote if using HubSpot Payments, such as credit card or ACH.
Quote Approver	String	False		False	User who approved the quote. May be blank if approval is not required.
Collect Billing Address	Bool	False		False	Indicates whether the quote form should require a billing address from the customer.
Created by user ID	Decimal	True		False	HubSpot user ID of the individual who created the quote record. Automatically generated.
Create date	Datetime	True		False	Date the quote record was created in HubSpot.
Quote Domain	String	False		False	Domain URL where the quote is publicly hosted.
ESign Date	Datetime	True		False	Date and time when the quote was electronically signed by all required signers.
Expiration Template Path	String	False		False	Internal HubSpot path for the expiration template associated with the quote.
Quote approval feedback	String	False		False	Feedback or comments provided during the quote approval process.
Language	String	False		False	Language selected for displaying the quote publicly.
Last modified date	Datetime	True		False	Most recent timestamp when any property of the quote was updated.
Global Term Line Item Discount Percentage	String	False		False	Internal HubSpot setting for a globally applied discount percentage across all line items.
Global Term Line Item Discount Percentage Enabled	Bool	False		False	Indicates whether the global discount percentage setting is enabled for the quote.
Global Term Line Item Recurring Billing Period	String	False		False	Internal HubSpot setting specifying the recurring billing period term for products in the quote.
Global Term Line Item Recurring Billing Period Enabled	Bool	False		False	Indicates whether the recurring billing period global setting is enabled for the quote.
Global Term Line Item Recurring Billing Start Date	String	False		False	Internal HubSpot setting specifying the recurring billing start date for line items.
Global Term Line Item Recurring Billing Start Date Enabled	Bool	False		False	Indicates whether the global setting for recurring billing start date is enabled for the quote.
Global Term Line Item Recurring Billing Frequency	String	False		False	Internal HubSpot setting specifying how often products are billed under the quote terms.
Global Term Line Item Recurring Billing Frequency Enabled	Bool	False		False	Indicates whether the global billing frequency setting is enabled for the quote.
Locale	String	False		False	Locale setting used for formatting language, dates, and numbers when the quote is displayed publicly.
Locked	Bool	True		False	Indicates whether the quote is locked, preventing any further edits.
Merged object IDs	String	True		False	List of object IDs that have been merged into this quote record. Automatically managed by HubSpot.
Record ID	Decimal	True		False	Unique HubSpot-assigned ID for the quote record.
Payment date	Datetime	True		False	Date when payment was completed for the quote by the customer.
Payment Status	String	True		False	Current payment status of the quote, such as Paid or Pending.
Payment Type	String	False		False	Payment method used for the quote if payment is enabled, such as credit card or ACH.
Quote PDF download link	String	True		False	Direct link to download a PDF version of the quote.
Proposal Domain	String	True		False	Domain from which the associated proposal is served, if different from the quote domain.
Proposal Slug	String	True		False	URL path segment used to access the associated proposal.
Proposal Template	String	False		False	Template path used to render the proposal associated with the quote.
Public URL key	String	True		False	Key used to construct the public URL for accessing the quote document.
Quote Total Preference	String	False		False	Specifies which line item property is used to calculate the total amount of the quote.
Read Only Object	Bool	True		False	Indicates whether the quote object is read-only and cannot be modified.
Sender image URL	String	False		False	URL to the image used as the sender's avatar on the quote document.
Quote Slug	String	False		False	Path segment used to generate the public URL for accessing this quote.
Template Type	String	False		False	Indicates whether the quote was generated using HubSpot's default templates.
Test mode	Bool	False		False	Indicates whether the quote is in test mode and not intended for real transactions.
Unique creation key	String	True		False	Unique property used for idempotent creation of the quote to prevent duplication.
Updated by user ID	Decimal	True		False	HubSpot user ID of the individual who most recently updated the quote.
User IDs of all notification followers	String	True		False	List of user IDs who chose to follow the quote for notification updates.
User IDs of all notification unfollowers	String	True		False	List of user IDs who opted out of receiving notifications about this quote.
User IDs of all owners	String	True		False	List of user IDs assigned as owners of the quote record.
Owner assigned date	Datetime	True		False	Date and time when an owner was assigned to the quote.
Sender company name	String	False		False	Name of the company sending the quote.
Sender first name	String	False		False	First name of the person sending the quote.
Quote title	String	False		False	Title assigned to the quote document.
Expiration date	Datetime	False		False	Date when the quote will expire and no longer be available.
Sender company domain	String	False		False	Domain name of the company sending the quote.
Sender last name	String	False		False	Last name of the person sending the quote.
Comments to buyer	String	False		False	Comments or messages included for the buyer on the quote document.
Sender company street address	String	False		False	Street address of the company sending the quote.
Sender email	String	False		False	Email address of the sender of the quote.
Sender company street address 2	String	False		False	Second line of the street address for the company sending the quote, if applicable.
Sender phone number	String	False		False	Phone number for contacting the sender of the quote.
Terms	String	False		False	Relevant information about pricing, purchasing terms, and agreements included in the quote.
Logo URL	String	False		False	URL to the company logo displayed on the quote.
Sender company city	String	False		False	City where the company sending the quote is located.
Sender job title	String	False		False	Job title of the individual sending the quote.
Sender company state_region	String	False		False	State or region where the company sending the quote is located.
Space for written signature	Bool	False		False	Indicates whether a designated space for a handwritten signature is included on the quote.
Branding color	String	False		False	Color value used for branding elements on the quote document.
Recent Sales Email Replied Date	Datetime	True		False	Timestamp of the last time a tracked sales email related to this quote received a reply.
Sender company postal code	String	False		False	Postal code for the company's address listed on the quote.
Space for written countersignature	Bool	False		False	Indicates whether a designated space for a handwritten countersignature is included on the quote.
Quote owner	String	False		False	User who is assigned as the owner of the quote.
Last Contacted	Datetime	True		False	Last time a call, email, or meeting was logged related to the quote.
Last Activity Date	Datetime	True		False	Most recent time a note, call, email, meeting, or task was logged regarding the quote.
Next Activity Date	Datetime	True		False	Scheduled date of the next upcoming activity associated with the quote.
Number of times contacted	Decimal	True		False	Number of times a call, email, or meeting was logged in relation to the quote.
Number of Sales Activities	Decimal	True		False	Total number of sales activities, such as emails or calls, associated with the quote.
Currency	String	False		False	Currency code used for the quote amount, such as USD or EUR.
Sender company country	String	False		False	Country where the company sending the quote is located.
HubSpot team	String	True		False	Primary HubSpot team associated with the owner of the quote.
All owner ids	String	True		False	List of all owner referencing IDs, both default and custom, associated with the quote.
Sender company image URL	String	False		False	URL of the image for the sender company's branding used on the quote.
Time zone	String	False		False	Timezone used for displaying date and time fields on the quote document.
All team ids	String	True		False	List of team IDs associated with the ownership properties for the quote.
Payment enabled	Bool	False		False	Indicates whether payment collection is enabled directly through the quote link.
All accessible team ids	String	True		False	List of all accessible team IDs, including inherited hierarchy, related to ownership of the quote.
ESign enabled	Bool	False		False	Indicates whether electronic signature (eSign) functionality is enabled for the quote.
Associated Deals	Decimal	True		False	Number of deals associated with the quote, automatically populated by HubSpot.
ESign number of signers required	Decimal	True		False	Total number of required signers needed to fully complete the eSign process for the quote.
Legacy Quote Template	String	False		False	Path to the legacy template used to render the quote. Legacy templates were sunset as of December 12, 2022.
ESign completed signatures	Decimal	True		False	Number of completed electronic signatures collected for the quote.
Quote amount	Decimal	True		False	Total amount due for the quote, based on associated line items.
Quote approval status	String	False		False	Approval status of the quote, such as Approved or Rejected.
Quote number	String	False		False	Reference number displayed on the quote document for internal or external tracking.
Collect shipping address	Bool	False		False	Indicates whether the quote form should require a shipping address from the customer.

ServiceAssociations

Retrieve the IDs of all the objects associated to specific Services objects in HubSpot.

Table Specific Information

The ServiceAssociations table provides access to the relationship data between service records and other HubSpot objects such as contacts, companies, deals, and tickets.

SELECT

When selecting service associations, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM ServiceAssociations WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'
SELECT * FROM ServiceAssociations WHERE Type = 'contacts'

INSERT

INSERT INTO ServiceAssociations (ID, AssociationId, Type) VALUES ('25151', '12345', 'contacts')

DELETE

DELETE FROM ServiceAssociations WHERE ID = '25151' AND AssociationId = '12345'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Services.Id	False	Services ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Services object is associated with.
Type [KEY]	String	False		False	Type of the associated object, which can be a contact, deal etc.
TypeId [KEY]	String	False		False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False		False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.
TypeLabel	String	True		False	The label assigned to the association type between objects.

Services

Retrieve the available Services in HubSpot.

Table Specific Information

In HubSpot, services represent professional services, support offerings, or other service-based products provided to customers. Service records help users track project status, costs, and completion through pipeline stages.

SELECT

When selecting services, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Services WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42'

INSERT

INSERT INTO Services ([Name]) VALUES ('Consulting Package')

UPDATE

UPDATE Services SET [Name] = 'Updated Service Name' WHERE ID = '25151'

DELETE

DELETE FROM Services WHERE ID = '25151'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	True		True	Unique identifier of the object.
Archived	Bool	True		False	Whether the object is archived or not.
CreatedAt	Datetime	True		False	When the object was created.
UpdatedAt	Datetime	True		False	When the object was last updated.
All teams	String	True		False	The team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business units	String	False		False	The business units this record is assigned to.
All owner IDs	String	True		False	Values of all default and custom owner properties for this record.
All team IDs	String	True		False	The team IDs of all default and custom owner properties for this record.
Amount paid	Decimal	False		True	What the customer has already paid.
Amount remaining	Decimal	False		True	What the customer will pay in the future.
Category	String	False		False	A drop down or multi-select field where customers can differentiate among varied offerings i.e. Marketing hub onboarding vs. full suite onboarding, etc.
Close date	Datetime	False		True	Date the record is closed.
Created by user ID	Decimal	True		True	The user who created this record. This value is set automatically by HubSpot.
Object create date/time	Datetime	True		True	The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Description	String	False		True	An explanation of the offering that is being represented.
Duration	Decimal	True		True	Calculates the time between the start date and close date. If the start date occurs after the close date, the value returned is 0. The create date and target end date will be used as fallbacks for the start date and close date respectively.
Object last modified date/time	Datetime	True		True	Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically.
Merged record IDs	String	True		False	The list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Name	String	False		True	Short-summary of the offering the record represents.
Next activity date	Datetime	True		True	The date of the next upcoming activity for a service. This property is set automatically by HubSpot based on user action. This includes logging a future call, sales email, or meeting using the Log feature, as well as creating a future task or scheduling a future meeting. This is updated automatically by HubSpot.
Record ID	Decimal	True		True	The unique ID for this record. This value is set automatically by HubSpot.
Record creation source	String	True		True	Raw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1	String	True		True	First level of detail on how this record was created.
Record source detail 2	String	True		True	Second level of detail on how this record was created.
Record source detail 3	String	True		True	Third level of detail on how this record was created.
Record creation source ID	String	True		True	Raw internal sourceId present in the RequestMeta when this record was created.
Record source	String	True		False	How this record was created.
Record creation source user ID	Decimal	True		True	Raw internal userId present in the RequestMeta when this record was created.
Owning Teams	String	False		False	The teams that are attributed to this record.
Pipeline	String	False		False	The pipeline that contains this service.
Pipeline Stage	String	False		False	The pipeline stage that contains this service.
Read only object	Bool	True		True	Determines whether a record can be edited by a user.
Shared teams	String	False		False	Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared users	String	False		False	Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Start date	Datetime	False		True	Date the offering starts being worked on by either the customer or the company.
Status	String	False		False	This represents how the project is tracking relative towards expectations.
Service Tags	String	True		False	List of tag ids applicable to a service. This property is set automatically by HubSpot.
Tags	String	False		False	Deal tags associated with your service.
Target duration	Decimal	True		True	Calculates the time between the start date and target date. If the start date occurs after the target date, the value returned is 0.
Target end date	Datetime	False		True	Date the offering is anticipated to be completed.
Time in 'In progress (Service Pipeline)'	Decimal	True		True	The total time in seconds spent by the service in the 'In progress' stage, 'Service Pipeline' pipeline.
Time in 'New (Service Pipeline)'	Decimal	True		True	The total time in seconds spent by the service in the 'New' stage, 'Service Pipeline' pipeline.
Time in 'Closed (Service Pipeline)'	Decimal	True		True	The total time in seconds spent by the service in the 'Closed' stage, 'Service Pipeline' pipeline.
Total cost	Decimal	False		True	The total value in US dollars of the offering.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followers	String	True		False	The user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications.
User IDs of all notification unfollowers	String	True		False	The user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications.
User IDs of all owners	String	True		False	The user IDs of all owners of this record.
Cumulative time in New (test)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'New' stage, 'test' pipeline.
Cumulative time in In progress (test)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'In progress' stage, 'test' pipeline.
Cumulative time in Closed (test)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'Closed' stage, 'test' pipeline.
Cumulative time in In progress (Service Pipeline)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'In progress' stage, 'Service Pipeline' pipeline.
Cumulative time in New (Service Pipeline)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'New' stage, 'Service Pipeline' pipeline.
Cumulative time in Closed (Service Pipeline)	Decimal	True		True	The cumulative time in seconds spent by the service in the 'Closed' stage, 'Service Pipeline' pipeline.
Date entered New (test)	Datetime	True		True	The date and time when the service entered the 'New' stage, 'test' pipeline.
Date entered In progress (test)	Datetime	True		True	The date and time when the service entered the 'In progress' stage, 'test' pipeline.
Date entered Closed (test)	Datetime	True		True	The date and time when the service entered the 'Closed' stage, 'test' pipeline.
Date entered In progress (Service Pipeline)	Datetime	True		True	The date and time when the service entered the 'In progress' stage, 'Service Pipeline' pipeline.
Date entered New (Service Pipeline)	Datetime	True		True	The date and time when the service entered the 'New' stage, 'Service Pipeline' pipeline.
Date entered Closed (Service Pipeline)	Datetime	True		True	The date and time when the service entered the 'Closed' stage, 'Service Pipeline' pipeline.
Date exited New (test)	Datetime	True		True	The date and time when the service exited the 'New' stage, 'test' pipeline.
Date exited In progress (test)	Datetime	True		True	The date and time when the service exited the 'In progress' stage, 'test' pipeline.
Date exited Closed (test)	Datetime	True		True	The date and time when the service exited the 'Closed' stage, 'test' pipeline.
Date exited In progress (Service Pipeline)	Datetime	True		True	The date and time when the service exited the 'In progress' stage, 'Service Pipeline' pipeline.
Date exited New (Service Pipeline)	Datetime	True		True	The date and time when the service exited the 'New' stage, 'Service Pipeline' pipeline.
Date exited Closed (Service Pipeline)	Datetime	True		True	The date and time when the service exited the 'Closed' stage, 'Service Pipeline' pipeline.
Latest time in New (test)	Decimal	True		True	The total time in seconds spent by the service in the 'New' stage, 'test' pipeline since it last entered this stage.
Latest time in In progress (test)	Decimal	True		True	The total time in seconds spent by the service in the 'In progress' stage, 'test' pipeline since it last entered this stage.
Latest time in Closed (test)	Decimal	True		True	The total time in seconds spent by the service in the 'Closed' stage, 'test' pipeline since it last entered this stage.
Latest time in In progress (Service Pipeline)	Decimal	True		True	The total time in seconds spent by the service in the 'In progress' stage, 'Service Pipeline' pipeline since it last entered this stage.
Latest time in New (Service Pipeline)	Decimal	True		True	The total time in seconds spent by the service in the 'New' stage, 'Service Pipeline' pipeline since it last entered this stage.
Latest time in Closed (Service Pipeline)	Decimal	True		True	The total time in seconds spent by the service in the 'Closed' stage, 'Service Pipeline' pipeline since it last entered this stage.
Performed in an import	Bool	True		True	Object is part of an import.
Owner assigned date	Datetime	True		True	The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Owner	String	False		True	The owner of the object.
Owner's main team	String	True		False	The main team of the record owner. This value is set automatically by HubSpot.

Pseudo-Columns

SELECT ステートメントのWHERE 句では、疑似カラムフィールドを使用して、データソースから返されるタプルを詳細に制御することができます。詳細については、WHERE 句のセクションを参照してください。


Name	Type	Description
ExternalIdColumn	String	The name of the column to be used as the unique key in a bulk UPSERT statement.

TicketAssociations

Returns object IDs associated with specific tickets, supporting customer support case associations.

Table-Specific Information

SELECT

The TicketAssociations table always includes the same set of columns, but some return NULL unless you filter by Id and Type, which allows the Cloud to retrieve full association details.

To return full details for Ticket associations, filter by both the Ticket Id and the association Type. The Type identifies the associated object (such as a Deal, Company, or Contact).

-- Retrieve all fields for associations between a specific Ticket and its related Deals
SELECT *
FROM TicketAssociations
WHERE Id = '436648510605'   -- Ticket Id
  AND Type = 'Deal';        -- Associated object type

Note: Fetching all fields can cause a reduction in performance, as it requires the Cloud to make requests for each Ticket.

DELETE

To remove a Ticket association, include both the Ticket Id and the association Type:

-- Delete a Ticket-Deal association
DELETE FROM TicketAssociations
WHERE Id = '436648510605'   -- Ticket Id
  AND Type = 'Deal';        -- Associated object type

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Tickets.Id	False	Unique identifier for the ticket record.
AssociationId [KEY]	Long	False		False	Identifier of the object that this ticket is associated with.
Type [KEY]	String	False		False	Type of the associated object, such as a contact, deal, or company.
TypeId [KEY]	String	False	AssociationsLabels.TypeId	False	Numeric identifier for the association type. May be blank for general association queries.
Category [KEY]	String	False	AssociationsLabels.Category	False	Category that classifies the type of relationship between the ticket and the associated object. Often empty for generic associations.
TypeLabel	String	True	AssociationsLabels.Label	False	Descriptive label that defines the association type between the ticket and the related object.

Tickets

Lists all ticket records in HubSpot, supporting both OAuth and private-app token authentication methods.

Table Specific Information

In HubSpot, a ticket represents a customer request for help or support. The tickets endpoints allow you to manage this data and sync it between HubSpot and other systems.

SELECT

When selecting tickets, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM Tickets WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM Tickets WHERE Archived = TRUE;

INSERT

INSERT INTO Tickets ([Ticket name]) VALUES ('ticket')

UPDATE

UPDATE Tickets SET [Ticket name] = 'new ticket' WHERE ID = '50962544'

DELETE

DELETE FROM Tickets WHERE ID = '50962544'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		True	Unique identifier for the ticket record.
Archived	Bool	True		True	Indicates whether the ticket is archived in HubSpot.
CreatedAt	Datetime	True		False	The timestamp when the ticket was first created.
UpdatedAt	Datetime	True		False	The timestamp of the most recent update to the ticket.
ItemURL	String	True		False	Direct URL to access the ticket within the HubSpot UI.
Close date	Datetime	False		False	Date when the ticket was closed.
Created by	Decimal	False		False	Contact ID (VID) of the person who created the ticket.
Create date	Datetime	False		False	The user-defined date when the ticket was created.
First agent email response date	Datetime	True		False	Timestamp of the first email reply sent by an agent for this ticket.
Business units	String	False		False	Specifies which business units this ticket is associated with.
Assignment Method	String	False		False	Indicates the method used to assign the ticket to an owner.
AutoGenerated from thread id	Decimal	True		False	Thread ID used to automatically generate this ticket based on predefined rules.
Originating Conversations Message Id	String	False		False	ID of the conversation message that initially created the ticket.
Conversations originating thread id	Decimal	False		False	Conversation thread ID from which the ticket originated.
Created by user ID	Decimal	True		False	The ID of the user who created the ticket. Automatically set by HubSpot.
HubSpot create date	Datetime	True		False	System-generated timestamp when the ticket was added to HubSpot.
Custom inbox ID	Decimal	False		False	Custom inbox ID that the ticket is linked to.
Date entered New (Support Pipeline)	Datetime	True		False	Timestamp when the ticket entered the 'New' stage of the 'Support Pipeline'.
Date entered Waiting on contact (Support Pipeline)	Datetime	True		False	Timestamp when the ticket entered the 'Waiting on contact' stage of the 'Support Pipeline'.
Date entered Waiting on us (Support Pipeline)	Datetime	True		False	Timestamp when the ticket entered the 'Waiting on us' stage of the 'Support Pipeline'.
Date entered Closed (Support Pipeline)	Datetime	True		False	Timestamp when the ticket entered the 'Closed' stage of the 'Support Pipeline'.
Date exited New (Support Pipeline)	Datetime	True		False	Timestamp when the ticket exited the 'New' stage of the 'Support Pipeline'.
Date exited Waiting on contact (Support Pipeline)	Datetime	True		False	Timestamp when the ticket exited the 'Waiting on contact' stage of the 'Support Pipeline'.
Date exited Waiting on us (Support Pipeline)	Datetime	True		False	Timestamp when the ticket exited the 'Waiting on us' stage of the 'Support Pipeline'.
Date exited Closed (Support Pipeline)	Datetime	True		False	Timestamp when the ticket exited the 'Closed' stage of the 'Support Pipeline'.
External object ids	String	False		False	IDs linking this ticket to equivalent records in external systems.
Last CES survey comment	String	True		False	Most recent Customer Effort Score (CES) survey comment received for this ticket.
Last CES survey rating	String	True		False	Most recent CES survey rating submitted for this ticket.
Last CES survey date	Datetime	True		False	Timestamp of the most recent CES survey submission linked to this ticket.
File upload	String	False		False	Files uploaded by the contact through a support form.
First agent response date	Datetime	True		False	Date of the first response from an agent in any format (such as email or chat).
In Help Desk	Bool	False		False	Indicates whether the ticket is displayed in the Help Desk view.
Inbox ID	Decimal	True		False	ID of the inbox where the ticket resides.
Last email activity	String	True		False	The type of the most recent email activity related to the ticket.
Last email date	Datetime	True		False	Date of the most recent email sent or received regarding the ticket.
Last message received date	Datetime	True		False	Date of the last message received from the customer.
Last response date	Datetime	True		False	Date of the last response from an agent or automation.
Last activity date	Datetime	True		False	Date of the most recent logged activity (such as a note, call, or task) for the ticket.
Last contacted date	Datetime	True		False	Timestamp of the most recent logged interaction (call, email, chat) with the contact on the ticket.
Last modified date	Datetime	True		False	Timestamp of the most recent property update for the ticket, including internal changes.
Latest message seen by agent ids	String	True		False	List of agent IDs who have seen the latest message in the conversation threads linked to this ticket.
Merged ticket ids	String	True		False	List of ticket IDs that have been merged into this ticket.
Microsoft Teams message ID for this ticket.	String	True		False	ID of the Microsoft Teams message associated with this ticket, if applicable.
Next activity date	Datetime	True		False	Date of the next scheduled activity related to this ticket.
Number of Associated Companies	Decimal	True		False	Count of companies associated with the ticket.
Number of times contacted	Decimal	True		False	Number of calls, emails, or meetings logged for this ticket.
Record ID	Decimal	True		False	Unique identifier for the ticket record. Automatically assigned by HubSpot.
Originating channel account	String	True		False	Channel account used to initiate the conversation that created the ticket.
Originating email engagement id	Decimal	True		False	Engagement ID of the email that originated this ticket.
Originating channel type	String	True		False	Type of channel (such as chat, email, or form) used to submit the ticket.
Pinned Engagement ID	Decimal	True		False	ID of the engagement pinned to this ticket for visibility.
Pipeline	String	False		False	Pipeline that includes this ticket.
Ticket status	String	False		False	Current stage of the ticket within its pipeline.
Read Only Object	Bool	True		False	Indicates if the ticket is in read-only mode.
Resolution	String	False		False	Description of how the ticket was resolved.
Thread IDs To Restore	String	False		False	IDs of threads that can be restored for this ticket after a soft delete.
Category	String	False		False	Primary category or reason for the customer's inquiry.
Ticket ID	Decimal	True		False	System-generated unique ID for the ticket.
Priority	String	False		False	Priority level assigned to the ticket, such as High, Medium, or Low.
Time in New (Support Pipeline)	Decimal	True		False	Total time (in seconds) the ticket spent in the 'New' stage of the 'Support Pipeline'.
Time in Waiting on contact (Support Pipeline)	Decimal	True		False	Total time (in seconds) the ticket spent in the 'Waiting on contact' stage.
Time in Waiting on us (Support Pipeline)	Decimal	True		False	Total time (in seconds) the ticket spent in the 'Waiting on us' stage.
Time in Closed (Support Pipeline)	Decimal	True		False	Total time (in seconds) the ticket spent in the 'Closed' stage.
Time to Close SLA Due Date	Datetime	True		False	Deadline by which the ticket must be closed to meet the Service Level Agreement (SLA).
Time to Close SLA Ticket Status	String	True		False	Current SLA status regarding the ticket's time to closure.
Time to First Response SLA Due Date	Datetime	True		False	Deadline by which an agent must send the first response.
Time to First Response SLA Status	String	True		False	Current SLA status for time to first response.
Unique creation key	String	True		False	Key used to ensure idempotency when creating the ticket via integrations or API.
Updated by user ID	Decimal	True		False	ID of the user who last updated the ticket. Automatically assigned by HubSpot.
User IDs of all notification followers	String	True		False	Users who have opted to receive notifications about changes to the ticket.
User IDs of all notification unfollowers	String	True		False	Users who have opted out of receiving notifications about the ticket.
User IDs of all owners	String	True		False	IDs of all users assigned as owners of the ticket.
Owner assigned date	Datetime	True		False	Timestamp of when ownership of the ticket was assigned.
Date of last engagement	Datetime	True		False	Timestamp of the most recent reply or interaction linked to the ticket.
Last customer reply date	Datetime	True		False	Timestamp of the customer's most recent response.
NPS follow up	String	False		False	Customer's response to the Net Promoter Score (NPS) follow-up question.
NPS follow up question	Decimal	False		False	Identifier for the specific version of the NPS follow-up question asked.
Conversation NPS score	String	False		False	NPS given by the customer after resolution.
Reference to email thread	String	False		False	ID of the email thread linked to the ticket.
Time to close	Decimal	True		False	Total time elapsed between ticket creation and closure.
Time to first agent email reply	Decimal	True		False	Elapsed time between ticket creation and first email reply from an agent.
Ticket name	String	False		False	Brief subject line or title summarizing the ticket.
Ticket description	String	False		False	Detailed description of the issue or request reported in the ticket.
Source	String	False		False	Origin channel where the ticket was initially submitted, such as email or chat.
Reference to sourceSpecific object	String	False		False	ID of the object representing the source of the ticket (such as conversation or workflow).
Tags	String	False		False	Labels or keywords manually or automatically assigned to the ticket for classification.
Recent Sales Email Replied Date	Datetime	True		False	Date of the most recent reply to a tracked sales email related to this ticket.
Ticket owner	String	False		False	User currently assigned to own and manage the ticket.
Last Contacted _Ticket Note_	Datetime	True		False	Last recorded interaction date from calls, emails, or meetings related to this ticket.
Last Activity Date _Ticket Note_	Datetime	True		False	Most recent note, call, meeting, or task logged for the ticket.
Next Activity Date _Ticket Note_	Datetime	True		False	Next upcoming scheduled activity related to the ticket.
Number of times contacted _Ticket Note_	Decimal	True		False	Count of logged interactions for this ticket.
Number of Sales Activities	Decimal	True		False	Total number of sales-related actions linked to the ticket.
HubSpot team	String	True		False	Team assigned to the ticket owner, automatically set by HubSpot.
All owner ids	String	True		False	All owner-related IDs, including custom and default ownership.
All team ids	String	True		False	Team IDs linked to all ownership properties, including hierarchy.
All accessible team ids	String	True		False	Team IDs, including inherited teams, with access to the ticket record.

ビュー

ビューは、データを示すという点でテーブルに似ていますが、ビューは読み取り専用です。

クエリは、ビューに対して通常のテーブルと同様に実行することができます。

CData Cloud - HubSpot ビュー


Name	Description
AssociationsLabels	Retrieves all available association labels and types defining relationships between pairs of CRM objects in HubSpot.
CompanyPropertiesHistory	Retrieves the history of property changes for companies in HubSpot, useful for tracking data updates over time.
ContactPropertiesHistory	Retrieves the history of property changes for contacts in HubSpot for auditing and tracking purposes.
DealPropertiesHistory	Retrieves the history of changes made to deal properties, useful for auditing sales data.
FeedbackSubmissions	Lists all feedback submissions in HubSpot, useful for customer feedback management.
Goals	Retrieves all goal records configured in HubSpot, supporting goal tracking and performance management.
LeadPropertiesHistory	Retrieves the history of changes made to lead properties for auditing lead data updates.
OrderPropertiesHistory	Retrieves the history of changes made to order properties for auditing purposes.
TicketPropertiesHistory	Retrieves the history of ticket property changes, useful for auditing customer support data.

AssociationsLabels

Retrieves all available association labels and types defining relationships between pairs of CRM objects in HubSpot.

View Specific Information

SELECT

You must specify 'FromObjectType' and 'ToObjectType'.

SELECT * FROM AssociationsLabels WHERE FromObjectType = 'Companies' AND ToObjectType = 'Deals'

Columns


Name	Type	References	Filterable	Description
TypeId [KEY]	String			The numeric identifier representing the specific association type.
Category [KEY]	String			The classification category of the association type between the two objects.
Label	String			The name or label assigned to describe the association between the specified objects.
FromObjectType [KEY]	String		True	The type of the originating object in the association relationship.
ToObjectType [KEY]	String		True	The type of the destination object in the association relationship.

CompanyPropertiesHistory

Retrieves the history of property changes for companies in HubSpot, useful for tracking data updates over time.

Select

The PropertyName filter is required to retrieve data from this view:

SELECT * FROM CompanyPropertiesHistory WHERE PropertyName = 'Create Date'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The internal name of the company property that was updated.
Value	String		False	The historical value that the company property was set to after the update.
SourceType	String		False	The method or system that made the change to the company property, such as a user action, workflow, or integration.
SourceId	String		False	Additional information identifying the source of the update, if available.
Timestamp	Datetime		False	The date and time when the property change occurred.
CompanyId	Long		False	Unique identifier of the company whose property history is being tracked.

ContactPropertiesHistory

Retrieves the history of property changes for contacts in HubSpot for auditing and tracking purposes.

Select

The PropertyName filter is required to retrieve data from this view:

SELECT * FROM ContactPropertiesHistory WHERE PropertyName = 'Create Date'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The internal name of the contact property that was updated.
Value	String		False	The historical value of the contact property before the change.
SourceType	String		False	The method through which the property was updated, such as a form submission, import, or API.
SourceId	String		False	Additional identifier related to the source of the change, if available.
Timestamp	Datetime		False	The date and time when the property was updated.
ContactId	Long		False	The unique identifier of the contact whose property history is being tracked.
ContactEmail	String		False	The email address associated with the contact at the time of the property update.
ContactPhoneNumber	String		False	The primary phone number associated with the contact at the time of the property update.

DealPropertiesHistory

Retrieves the history of changes made to deal properties, useful for auditing sales data.

Select

The PropertyName filter is required to retrieve data from this view:

SELECT * FROM DealPropertiesHistory WHERE PropertyName = 'Create Date'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The name of the property whose value changed on the deal.
Value	String		False	The historical value that was assigned to the property.
SourceType	String		False	The method through which the property change occurred, such as user action or API.
SourceId	String		False	Additional context about the source of the update, if available.
Timestamp	Datetime		False	The date and time when the property was updated.
DealId	Long		False	The unique identifier of the deal associated with the property change.

FeedbackSubmissions

Lists all feedback submissions in HubSpot, useful for customer feedback management.

Table Specific Information

When contacts submit feedback to your surveys, you can use submission data in HubSpot tools to gauge customer sentiment.

SELECT

When selecting FeedbackSubmissions, filtering can be applied to columns marked as "Filterable." For these columns, the only supported server-side operator is =.

SELECT * FROM FeedbackSubmissions WHERE ID = '96ec8565-3b73-4ee8-9815-f90566ba9c42';
SELECT * FROM FeedbackSubmissions WHERE Archived = TRUE;

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier of the feedback submission object.
Archived	Bool		True	Indicates whether the feedback submission has been archived.
CreatedAt	Datetime		False	Timestamp when the feedback submission was created.
UpdatedAt	Datetime		False	Timestamp of the most recent update to the feedback submission.
Agent email	String		False	Email address of the agent involved in the conversation that led to the feedback.
Agent responsible for the conversation	Decimal		False	User ID of the agent responsible for the conversation associated with this feedback.
Agent name	String		False	Full name of the agent who handled the conversation.
All accessible team IDs	String		False	Team IDs, including those up the team hierarchy, related to all owner properties of this submission.
Business units	String		False	Business units assigned to this feedback submission record.
All owner ids	String		False	Owner IDs associated with this submission, including default and custom owner properties.
All team ids	String		False	Team IDs corresponding to owner properties on this feedback submission.
Chatflow ID	Decimal		False	Identifier for the chatflow associated with the conversation.
Chatflow name	String		False	Name of the chatflow linked to the feedback submission.
Chatflow object id	Decimal		False	Object ID of the chatflow tied to the associated conversation.
Contact first name	String		False	First name of the contact linked to this submission.
Contact Id	Decimal		False	ID of the contact most recently associated with this feedback submission.
Contact last name	String		False	Last name of the contact linked to this submission.
Conversation thread id	Decimal		False	ID of the conversation thread related to this feedback.
Created by user ID	Decimal		False	User ID of the user who created this object, automatically assigned by HubSpot.
Object create date_time	Datetime		False	Timestamp representing the creation of this object, automatically set by HubSpot.
Object last modified date_time	Datetime		False	Timestamp representing the most recent update to this object, including hidden/internal changes.
Merged object IDs	String		False	List of object IDs merged into this feedback submission, automatically managed by HubSpot.
Record ID	Decimal		False	Unique HubSpot-assigned ID for this feedback submission record.
Read Only Object	Bool		False	Indicates if the submission is read-only and cannot be modified by users.
Tag IDs	String		False	IDs of any tags applied to this submission.
Tags	String		False	Tag labels assigned to this submission for classification or reporting.
Ticket id	Decimal		False	ID of the ticket associated with this feedback submission.
Ticket owner avatar uri	String		False	URI to the avatar image of the user assigned to the ticket linked to this feedback submission.
Ticket owner	Decimal		False	User ID of the owner of the ticket related to this feedback.
Ticket name	String		False	Title or summary of the ticket associated with the feedback submission.
Unique creation key	String		False	Unique key used to prevent duplicate creation of this feedback submission object.
Updated by user ID	Decimal		False	User ID of the person who last updated this record, automatically assigned by HubSpot.
User IDs of all notification followers	String		False	User IDs of individuals who opted in to receive notifications about this feedback submission.
User IDs of all notification unfollowers	String		False	User IDs of individuals who opted out of receiving notifications for this feedback submission.
User IDs of all owners	String		False	IDs of all users who are listed as owners of this feedback submission.
Owner Assigned Date	Datetime		False	Timestamp of the most recent owner assignment to this feedback submission, automatically tracked by HubSpot.
Owner	String		False	The owner of the feedback submission object.
HubSpot Team	String		False	The team associated with the owner of this feedback submission.
Industry Standard Question Type	String		False	Specifies the format of the question used in the feedback survey, following industry-standard types.
Sentiment	String		False	Sentiment classification for the feedback submission, typically positive, neutral, or negative.
Survey ID	Decimal		False	ID of the survey that generated this feedback submission.
Survey Type	String		False	Type of survey used to collect this feedback, such as NPS, CES, or CSAT.
Source	String		False	The channel used to deliver the survey and collect the feedback submission.
Date	Datetime		False	Timestamp indicating when the feedback was submitted.
Rating	Decimal		False	Numeric value assigned as a rating in the feedback submission.
Feedback sentiment	String		False	Qualitative sentiment value derived from the feedback rating and/or comments.
Response	String		False	Text response provided in the follow-up section of the feedback survey.
Ingestion id	String		False	ID used internally to capture and process the feedback submission.
Knowledge article id	Decimal		False	ID of the knowledge base article referenced in the feedback, if applicable.
Visitor id	Decimal		False	ID of the anonymous or known visitor who submitted the feedback.
Engagement id	Decimal		False	ID of the related engagement object within HubSpot.
Submission URL	String		False	URL of the web page where the feedback submission was collected.
Survey Name	String		False	Name of the survey that this feedback submission is associated with.
Form guid	String		False	GUID of the form used in collecting this feedback submission.
Email	String		False	Email address of the contact linked to this feedback submission.
Submission Name	String		False	Display name or label of the submission, typically based on contact information or email.

Goals

Retrieves all goal records configured in HubSpot, supporting goal tracking and performance management.

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier for the goal object.
Archived	Bool		False	Indicates whether the goal record is archived.
CreatedAt	Datetime		False	The date and time the goal was initially created.
UpdatedAt	Datetime		False	The date and time the goal was most recently updated.
MigrationSoftDeleteDeprecated	String		False	Indicates if the goal target is treated as deleted due to legacy migration.
Ad account asset IDs	String		False	Semicolon-separated list of ad account IDs associated with the goal, formatted as {AD_NETWORK}-{ACCOUNT_ID}.
Ad campaign asset ids	String		False	Semicolon-separated list of ad campaign IDs associated with the goal, formatted as {NETWORK}-{CAMPAIGN_ID}.
All teams	String		False	The IDs of all teams, including hierarchical parents, linked to owner properties for this goal.
Business units	String		False	Business units assigned to this goal record.
All owner ids	String		False	List of all owner IDs—default and custom—linked to this goal.
Team ids	String		False	The ID of the team that owns this goal. Only one team should be listed.
Assignee team ID	Decimal		False	The ID of the team assigned to the goal, if applicable.
Assignee user ID	Decimal		False	The ID of the user assigned to the goal, if applicable.
Campaign asset ids	String		False	IDs of marketing campaign assets associated with this goal.
Contact lifecycle stage	String		False	Selected lifecycle stage for contact-based goal targets.
Created by user ID	Decimal		False	The ID of the user who created this goal. Set automatically by HubSpot.
Object create date/time	Datetime		False	Timestamp for when this goal object was created. Set automatically by HubSpot.
currency	String		False	Deprecated currency code; no longer in use.
Currency Exchange Rate	Decimal		False	Exchange rate used to convert KPI values to company currency. Editable only after the goal ends.
Deal pipelines	String		False	Serialized list of deal pipeline IDs used to calculate KPI values for the goal.
Edit updates notification frequency	String		False	Frequency at which notifications are sent for goal edits.
End date	Date		False	The final date included in the goal's target period.
End datetime	Datetime		False	Timestamp marking the end of the goal's target period.
Fiscal year offset	Decimal		False	Number of months the fiscal year deviates from the calendar year (0 = January start).
Goal name	String		False	The name or title given to the goal.
Goal target currency code	String		False	Currency code used to express the goal's target value.
Goal Target Group ID	Decimal		False	Object ID of the group to which this goal target belongs.
Goal type	String		False	The category or classification of the goal.
Group correlation UUID	String		False	Unique identifier grouping related goal targets and groups created together.
Is forecastable	String		False	Indicates whether the goal should be shown in forecasting tools, based on milestone criteria.
IsLegacy	String		False	Indicates whether the goal was created during the legacy system migration.
KPI Display Unit	String		False	Units used to display KPIs (such as dollars, hours, or count).
KpiFilterGroups	String		False	Filter groups used for calculating KPI values for the goal.
KPI is team rollup	Bool		False	Indicates whether KPI contributions from child teams are included in the team's total.
KpiMetricType	String		False	The aggregation metric type (such as sum or count) used for calculating the KPI.
KpiObjectType	String		False	CRM object type on which KPI values are based.
Kpi object type id	String		False	ObjectTypeId of the object associated with KPI calculations.
KpiPropertyName	String		False	The name of the property used on the object type to calculate KPI values.
KpiSingleObjectCustomGoalTypeName	String		False	Custom goal configuration containing the metric type, object type, and property name.
KpiTimePeriodProperty	String		False	The date-based property used to group the KPI calculation by time period.
KpiTrackingMethod	String		False	Specifies how the progress direction is tracked (such as increasing or decreasing target).
Kpi unit type	String		False	Measurement unit used for the KPI calculation (such as count, currency, or time).
KPI value	Decimal		False	The latest value calculated for the KPI defined by this goal.
KPI value calculated at	Decimal		False	Timestamp indicating when the latest KPI value was calculated, in milliseconds.
KPI value last calculated at	Datetime		False	Date and time when the KPI value was most recently calculated.
Object last modified date/time	Datetime		False	The timestamp of the most recent update to any property of this goal object.
LegacyActive	String		False	Legacy flag indicating whether the goal was active or soft-deleted during migration.
LegacyCreatedAt	Decimal		False	Timestamp for when the goal was originally created in the legacy system.
LegacyCreatedBy	Decimal		False	User ID of the original creator from the legacy system.
LegacyQuarterlyTargetCompositeId	String		False	Composite ID from legacy quarterly goal structure, combining three related SQL IDs.
LegacySqlId	Decimal		False	Original ID of the goal target in the legacy system (deprecated in favor of unique ID).
LegacyUniqueSqlId	Decimal		False	Unique identifier for legacy system goal targets to prevent duplicates.
LegacyUpdatedAt	Decimal		False	Timestamp for the most recent update in the legacy system.
LegacyUpdatedBy	Decimal		False	User ID of the person who last updated the goal in the legacy system.
Merged record IDs	String		False	List of record IDs that were merged into this goal object. Set automatically by HubSpot.
MigrationSoftDelete	String		False	Indicates if the goal target was soft-deleted during system migration.
Milestone	String		False	The defined period (such as monthly or quarterly) during which the goal is considered active.
Record ID	Decimal		False	Unique identifier for this goal record, set automatically by HubSpot.
Record Creation Source	String		False	Internal value indicating the source system or method that created this goal.
Record Creation Source ID	String		False	Internal identifier providing further detail on the source that created the goal.
Record Creation Source User ID	Decimal		False	User ID of the person who triggered the goal creation event.
Outcome	String		False	Result of the goal (such as achieved, missed, or exceeded).
Owner ids of all owners	String		False	List of all user IDs assigned as owners of this goal record.
Participant type	String		False	Indicates whether the participant in the goal is a user, team, or pipeline.
Pipeline ids	String		False	List of pipeline IDs that this goal is tied to for KPI filtering purposes.
Pipelines	String		False	Serialized list of pipeline identifiers used in KPI value calculation.
Progress updates notification frequency	String		False	Frequency at which progress updates for this goal are sent.
Read Only Object	Bool		False	Indicates whether the goal is read-only and cannot be edited.
Notify on goal achieved	String		False	Whether notifications are enabled when the goal is achieved.
Notify with goal edit updates	String		False	Whether users receive notifications when the goal is edited.
Notify on goal exceeded	String		False	Whether notifications are enabled when the goal is exceeded.
Notify on goal kickoff	String		False	Whether users are notified when the goal officially starts.
Notify on goal missed	String		False	Whether notifications are enabled when the goal is not met.
Notify with progress updates	String		False	Whether users receive progress update notifications for this goal.
ShouldRecalculate	String		False	Flag indicating whether the goal target requires recalculation due to property changes or corrections.
Start datetime	Datetime		False	Start date and time that defines the beginning of the goal target's active period.
Static KPI Filter Groups	String		False	Filter groups applied to the goal's KPI that exclude time-based criteria.
Status	String		False	Current status of the goal (such as active, completed, missed).
Status display order	Decimal		False	Numerical value used to sort goal statuses in a defined display order.
Target amount	Decimal		False	The target value that the goal aims to reach.
Target amount in company currency	Decimal		False	Target amount converted into the company's base currency using the current exchange rate.
Team ID	Decimal		False	The ID of the team responsible for this goal target.
Ticket pipelines	String		False	Serialized list of ticket pipeline IDs used for KPI filtering related to tickets.
Unique creation key	String		False	Property used to ensure idempotent creation of the goal object in HubSpot.
Updated by user ID	Decimal		False	User ID of the person who last modified this goal. Set automatically by HubSpot.
User ID	Decimal		False	The user ID that this goal target is assigned to.
User IDs of all notification followers	String		False	List of user IDs who have opted in to receive notifications for this goal.
User IDs of all notification unfollowers	String		False	List of owner user IDs who have opted out of receiving notifications for this goal.
User IDs of all owners	String		False	User IDs of all owners assigned to this goal record.
Performed in an import	Bool		False	Boolean flag indicating if this goal was created as part of a data import process.
Owner Assigned Date	Datetime		False	The date an owner was most recently assigned to this goal object. Set automatically by HubSpot.
Owner	String		False	Name of the current owner assigned to this goal.
HubSpot Team	String		False	Primary team of the owner assigned to this goal.
Start date	Date		False	Calendar date representing the start of the goal's time range.
Kpi progress percent	Decimal		False	Progress toward the goal as a percentage, based on the current KPI value versus the target.

LeadPropertiesHistory

Retrieves the history of changes made to lead properties for auditing lead data updates.

Table Specific Information

Select

The Cloud uses the HubSpot API to retrieve the property history for leads.

Note: PropertyName must be included in the WHERE clause to retrieve any data from the LeadPropertiesHistory view. This filter is required by the API and is evaluated server-side.

The following is an example query:

SELECT * FROM LeadPropertiesHistory WHERE PropertyName = 'my_property'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The internal name of the property that was updated.
Value	String		False	The previous value of the property before it was changed.
SourceType	String		False	Indicates how the property change was triggered, such as by user action or integration.
SourceId	String		False	Optional metadata providing additional context about the source of the update.
Timestamp	Datetime		False	The date and time the property change occurred.
LeadId	Long		False	Unique identifier of the lead whose property was updated.

OrderPropertiesHistory

Retrieves the history of changes made to order properties for auditing purposes.

Table Specific Information

Select

The Cloud uses the HubSpot API to retrieve the property history for orders.

Note: PropertyName must be included in the WHERE clause to retrieve any data from the OrderPropertiesHistory view. This filter is required by the API and is evaluated server-side.

The following is an example query:

SELECT * FROM OrderPropertiesHistory WHERE PropertyName = 'my_property'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The internal name of the property whose value changed.
Value	String		False	The previous value of the property before the update.
SourceType	String		False	Indicates how the property was updated, such as manually or via integration.
SourceId	String		False	Additional metadata identifying the source of the change, if available.
Timestamp	Datetime		False	The date and time when the property change occurred.
OrderId	Long		False	The unique identifier of the order associated with this property history record.

TicketPropertiesHistory

Retrieves the history of ticket property changes, useful for auditing customer support data.

Select

The PropertyName filter is required to retrieve data from this view:

SELECT * FROM TicketPropertiesHistory WHERE PropertyName = 'Create Date'

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The internal name of the ticket property that was changed.
Value	String		False	The previous or historical value of the specified property.
SourceType	String		False	The origin of the property change, such as user update, workflow, or integration.
SourceId	String		False	Additional metadata about the source of the change. May be blank depending on the source type.
Timestamp	Datetime		False	The date and time when the property was last updated.
TicketId	Long		False	Unique identifier of the ticket associated with the property change.

ストアドプロシージャ

ストアドプロシージャはファンクションライクなインターフェースで、HubSpot の単純なSELECT/INSERT/UPDATE/DELETE 処理にとどまらずCloud の機能を拡張します。

ストアドプロシージャは、パラメータのリストを受け取り、目的の機能を実行し、プロシージャが成功したか失敗したかを示すとともにHubSpot から関連するレスポンスデータを返します。

CData Cloud - HubSpot ストアドプロシージャ


Name	Description

システムテーブル

このセクションで説明されているシステムテーブルをクエリして、スキーマ情報、データソース機能に関する情報、およびバッチ操作の統計にアクセスできます。

スキーマテーブル

以下のテーブルは、HubSpot のデータベースメタデータを返します。

sys_catalogs：利用可能なデータベースをリスト。
sys_schemas：利用可能なスキーマをリスト。
sys_tables：利用可能なテーブルおよびビューをリスト。
sys_tablecolumns：利用可能なテーブルおよびビューのカラムについて説明。
sys_procedures：利用可能なストアドプロシージャについて説明。
sys_procedureparameters：ストアドプロシージャパラメータについて説明。
sys_keycolumns：主キーおよび外部キーについて説明。
sys_indexes：利用可能なインデックスについて説明。

データソーステーブル

以下のテーブルは、データソースへの接続方法およびクエリ方法についての情報を返します。

sys_connection_props：利用可能な接続プロパティについての情報を返す。
sys_sqlinfo：Cloud がデータソースにオフロードできるSELECT クエリについて説明。

クエリ情報テーブル

次のテーブルは、データ変更クエリ（バッチ処理を含む）のクエリ統計を返します。

sys_identity：バッチ処理または単一の更新に関する情報を返す。

sys_catalogs

利用可能なデータベースをリストします。

次のクエリは、接続文字列で決定されるすべてのデータベースを取得します。

SELECT * FROM sys_catalogs

Columns


Name	Type	Description
CatalogName	String	データベース名。

sys_schemas

利用可能なスキーマをリストします。

次のクエリは、すべての利用可能なスキーマを取得します。

          SELECT * FROM sys_schemas

Columns


Name	Type	Description
CatalogName	String	データベース名。
SchemaName	String	スキーマ名。

sys_tables

利用可能なテーブルをリストします。

次のクエリは、利用可能なテーブルおよびビューを取得します。

          SELECT * FROM sys_tables

Columns


Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベース。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	テーブル名またはビュー名。
TableType	String	テーブルの種類（テーブルまたはビュー）。
Description	String	テーブルまたはビューの説明。
IsUpdateable	Boolean	テーブルが更新可能かどうか。

sys_tablecolumns

利用可能なテーブルおよびビューのカラムについて説明します。

次のクエリは、Contacts テーブルのカラムとデータ型を返します。

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Contacts'

Columns


Name	Type	Description
CatalogName	String	テーブルまたはビューを含むデータベースの名前。
SchemaName	String	テーブルまたはビューを含むスキーマ。
TableName	String	カラムを含むテーブルまたはビューの名前。
ColumnName	String	カラム名。
DataTypeName	String	データ型の名前。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
Length	Int32	カラムのストレージサイズ。
DisplaySize	Int32	指定されたカラムの通常の最大幅（文字数）。
NumericPrecision	Int32	数値データの最大桁数。文字データおよび日時データの場合は、カラムの長さ（文字数）。
NumericScale	Int32	カラムのスケール（小数点以下の桁数）。
IsNullable	Boolean	カラムがNull を含められるかどうか。
Description	String	カラムの簡単な説明。
Ordinal	Int32	カラムのシーケンスナンバー。
IsAutoIncrement	String	カラムに固定増分値が割り当てられるかどうか。
IsGeneratedColumn	String	生成されたカラムであるかどうか。
IsHidden	Boolean	カラムが非表示かどうか。
IsArray	Boolean	カラムが配列かどうか。
IsReadOnly	Boolean	カラムが読み取り専用かどうか。
IsKey	Boolean	sys_tablecolumns から返されたフィールドがテーブルの主キーであるかどうか。
ColumnType	String	スキーマ内のカラムの役割または分類。可能な値は、SYSTEM、LINKEDCOLUMN、NAVIGATIONKEY、REFERENCECOLUMN、およびNAVIGATIONPARENTCOLUMN が含まれます。

sys_procedures

利用可能なストアドプロシージャをリストします。

次のクエリは、利用可能なストアドプロシージャを取得します。

          SELECT * FROM sys_procedures

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベース。
SchemaName	String	ストアドプロシージャを含むスキーマ。
ProcedureName	String	ストアドプロシージャの名前。
Description	String	ストアドプロシージャの説明。
ProcedureType	String	PROCEDURE やFUNCTION などのプロシージャのタイプ。

sys_procedureparameters

ストアドプロシージャパラメータについて説明します。

次のクエリは、GetOAuthAccessToken ストアドプロシージャのすべての入力パラメータについての情報を返します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND Direction = 1 OR Direction = 2

パラメータに加えて結果セットのカラムを含めるには、IncludeResultColumns 擬似カラムをTrue に設定します。

SELECT * FROM sys_procedureparameters WHERE ProcedureName = 'GetOAuthAccessToken' AND IncludeResultColumns='True'

Columns


Name	Type	Description
CatalogName	String	ストアドプロシージャを含むデータベースの名前。
SchemaName	String	ストアドプロシージャを含むスキーマの名前。
ProcedureName	String	パラメータを含むストアドプロシージャの名前。
ColumnName	String	ストアドプロシージャパラメータの名前。
Direction	Int32	パラメータのタイプに対応する整数値：input (1)。input/output (2)、またはoutput(4)。input/output タイプパラメータは、入力パラメータと出力パラメータの両方になれます。
DataType	Int32	データ型を示す整数値。この値は、実行時に環境に基づいて決定されます。
DataTypeName	String	データ型の名前。
NumericPrecision	Int32	数値データの場合は最大精度。文字データおよび日時データの場合は、カラムの長さ（文字数）。
Length	Int32	文字データの場合は、許可される文字数。数値データの場合は、許可される桁数。
NumericScale	Int32	数値データの小数点以下の桁数。
IsNullable	Boolean	パラメータがNull を含められるかどうか。
IsRequired	Boolean	プロシージャの実行にパラメータが必要かどうか。
IsArray	Boolean	パラメータが配列かどうか。
Description	String	パラメータの説明。
Ordinal	Int32	パラメータのインデックス。
Values	String	このパラメータで設定できる値は、このカラムに表示されるものに限られます。指定できる値はカンマ区切りです。
SupportsStreams	Boolean	パラメータがファイルを表すかどうか。ファイルは、ファイルパスとして渡すことも、ストリームとして渡すこともできます。
IsPath	Boolean	パラメータがスキーマ作成操作のターゲットパスかどうか。
Default	String	何も値が指定されていない場合に、このパラメータで使用される値。
SpecificName	String	複数のストアドプロシージャが同じ名前を持つ場合、それぞれの同名のストアドプロシージャを一意に識別するラベル。特定の名前を持つプロシージャが1つだけの場合は、その名前がここに単純に反映されます。
IsCDataProvided	Boolean	プロシージャがネイティブのHubSpot プロシージャではなく、CData によって追加 / 実装されているかどうか。

Pseudo-Columns


Name	Type	Description
IncludeResultColumns	Boolean	出力にパラメータに加えて結果セットのカラムを含めるかどうか。デフォルトはFalse です。

sys_keycolumns

主キーおよび外部キーについて説明します。

次のクエリは、Contacts テーブルの主キーを取得します。

         SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Contacts'

Columns


Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
IsKey	Boolean	カラムがTableName フィールドで参照されるテーブル内の主キーかどうか。
IsForeignKey	Boolean	カラムがTableName フィールドで参照される外部キーかどうか。
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。

sys_foreignkeys

外部キーについて説明します。

次のクエリは、他のテーブルを参照するすべての外部キーを取得します。

         SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

カラム


名前	タイプ	説明
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前
PrimaryKeyName	String	主キーの名前。
ForeignKeyName	String	外部キーの名前。
ReferencedCatalogName	String	主キーを含むデータベース。
ReferencedSchemaName	String	主キーを含むスキーマ。
ReferencedTableName	String	主キーを含むテーブル。
ReferencedColumnName	String	主キーのカラム名。
ForeignKeyType	String	外部キーがインポート（他のテーブルを指す）キーかエクスポート（他のテーブルから参照される）キーかを指定します。

sys_primarykeys

主キーについて説明します。

次のクエリは、すべてのテーブルとビューから主キーを取得します。

         SELECT * FROM sys_primarykeys

Columns


Name	Type	Description
CatalogName	String	キーを含むデータベースの名前。
SchemaName	String	キーを含むスキーマの名前。
TableName	String	キーを含むテーブルの名前。
ColumnName	String	キーカラムの名前。
KeySeq	String	主キーのシーケンス番号。
KeyName	String	主キーの名前。

sys_indexes

利用可能なインデックスについて説明します。インデックスをフィルタリングすることで、より高速なクエリ応答時間でセレクティブクエリを記述できます。

次のクエリは、主キーでないすべてのインデックスを取得します。

          SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columns


Name	Type	Description
CatalogName	String	インデックスを含むデータベースの名前。
SchemaName	String	インデックスを含むスキーマの名前。
TableName	String	インデックスを含むテーブルの名前。
IndexName	String	インデックス名。
ColumnName	String	インデックスに関連付けられたカラムの名前。
IsUnique	Boolean	インデックスが固有の場合はTrue。そうでない場合はFalse。
IsPrimary	Boolean	インデックスが主キーの場合はTrue。そうでない場合はFalse。
Type	Int16	インデックスタイプに対応する整数値：statistic (0)、clustered (1)、hashed (2)、またはother (3)。
SortOrder	String	並べ替え順序：A が昇順、D が降順。
OrdinalPosition	Int16	インデックスのカラムのシーケンスナンバー。

sys_connection_props

利用可能な接続プロパティと、接続文字列に設定されている接続プロパティに関する情報を返します。

次のクエリは、接続文字列に設定されている、あるいはデフォルト値で設定されているすべての接続プロパティを取得します。

SELECT * FROM sys_connection_props WHERE Value <> ''

Columns


Name	Type	Description
Name	String	接続プロパティ名。
ShortDescription	String	簡単な説明。
Type	String	接続プロパティのデータ型。
Default	String	明示的に設定されていない場合のデフォルト値。
Values	String	可能な値のカンマ区切りリスト。別な値が指定されていると、検証エラーがスローされます。
Value	String	設定した値またはあらかじめ設定されたデフォルト。
Required	Boolean	プロパティが接続に必要かどうか。
Category	String	接続プロパティのカテゴリ。
IsSessionProperty	String	プロパティが、現在の接続に関する情報を保存するために使用されるセッションプロパティかどうか。
Sensitivity	String	プロパティの機密度。これは、プロパティがロギングおよび認証フォームで難読化されているかどうかを通知します。
PropertyName	String	キャメルケースの短縮形の接続プロパティ名。
Ordinal	Int32	パラメータのインデックス。
CatOrdinal	Int32	パラメータカテゴリのインデックス。
Hierarchy	String	このプロパティと一緒に設定する必要がある、関連のある依存プロパティを表示します。
Visible	Boolean	プロパティが接続UI に表示されるかどうかを通知します。
ETC	String	プロパティに関するその他のさまざまな情報。

sys_sqlinfo

Cloud がデータソースにオフロードできるSELECT クエリ処理について説明します。

SQL 構文の詳細については、SQL 準拠を参照してください。

データソースのSELECT 機能

以下はSQL 機能のサンプルデータセットです。 SELECT 機能のいくつかの側面がサポートされている場合には、カンマ区切りのリストで返されます。サポートされていない場合、カラムにはNO が入ります。


名前	説明	有効な値
AGGREGATE_FUNCTIONS	サポートされている集計関数。	AVG, COUNT, MAX, MIN, SUM, DISTINCT
COUNT	COUNT 関数がサポートされているかどうか。	YES, NO
IDENTIFIER_QUOTE_OPEN_CHAR	識別子をエスケープするための開始文字。	[
IDENTIFIER_QUOTE_CLOSE_CHAR	識別子をエスケープするための終了文字。	]
SUPPORTED_OPERATORS	サポートされているSQL 演算子。	=, >, <, >=, <=, <>, !=, LIKE, NOT LIKE, IN, NOT IN, IS NULL, IS NOT NULL, AND, OR
GROUP_BY	GROUP BY がサポートされているかどうか。サポートされている場合、どのレベルでサポートされているか。	NO, NO_RELATION, EQUALS_SELECT, SQL_GB_COLLATE
OJ_CAPABILITIES	サポートされている外部結合の種類。	NO, LEFT, RIGHT, FULL, INNER, NOT_ORDERED, ALL_COMPARISON_OPS
OUTER_JOINS	外部結合がサポートされているかどうか。	YES, NO
SUBQUERIES	サブクエリがサポートされているかどうか。サポートされていれば、どのレベルでサポートされているか。	NO, COMPARISON, EXISTS, IN, CORRELATED_SUBQUERIES, QUANTIFIED
STRING_FUNCTIONS	サポートされている文字列関数。	LENGTH, CHAR, LOCATE, REPLACE, SUBSTRING, RTRIM, LTRIM, RIGHT, LEFT, UCASE, SPACE, SOUNDEX, LCASE, CONCAT, ASCII, REPEAT, OCTET, BIT, POSITION, INSERT, TRIM, UPPER, REGEXP, LOWER, DIFFERENCE, CHARACTER, SUBSTR, STR, REVERSE, PLAN, UUIDTOSTR, TRANSLATE, TRAILING, TO, STUFF, STRTOUUID, STRING, SPLIT, SORTKEY, SIMILAR, REPLICATE, PATINDEX, LPAD, LEN, LEADING, KEY, INSTR, INSERTSTR, HTML, GRAPHICAL, CONVERT, COLLATION, CHARINDEX, BYTE
NUMERIC_FUNCTIONS	サポートされている数値関数。	ABS, ACOS, ASIN, ATAN, ATAN2, CEILING, COS, COT, EXP, FLOOR, LOG, MOD, SIGN, SIN, SQRT, TAN, PI, RAND, DEGREES, LOG10, POWER, RADIANS, ROUND, TRUNCATE
TIMEDATE_FUNCTIONS	サポートされている日付および時刻関数。	NOW, CURDATE, DAYOFMONTH, DAYOFWEEK, DAYOFYEAR, MONTH, QUARTER, WEEK, YEAR, CURTIME, HOUR, MINUTE, SECOND, TIMESTAMPADD, TIMESTAMPDIFF, DAYNAME, MONTHNAME, CURRENT_DATE, CURRENT_TIME, CURRENT_TIMESTAMP, EXTRACT
REPLICATION_SKIP_TABLES	レプリケーション中にスキップされたテーブルを示します。
REPLICATION_TIMECHECK_COLUMNS	レプリケーション中に更新判断のカラムとして使用するかどうかを、（指定された順に）チェックするカラムのリストを含む文字列の配列。
IDENTIFIER_PATTERN	識別子としてどの文字列が有効かを示す文字列値。
SUPPORT_TRANSACTION	プロバイダーが、コミットやロールバックなどのトランザクションをサポートしているかどうかを示します。	YES, NO
DIALECT	使用するSQL ダイアレクトを示します。
KEY_PROPERTIES	Uniform データベースを特定するプロパティを示します。
SUPPORTS_MULTIPLE_SCHEMAS	プロバイダー用に複数のスキームが存在するかどうかを示します。	YES, NO
SUPPORTS_MULTIPLE_CATALOGS	プロバイダー用に複数のカタログが存在するかどうかを示します。	YES, NO
DATASYNCVERSION	このドライバーにアクセスするために必要な、CData Sync のバージョン。	Standard, Starter, Professional, Enterprise
DATASYNCCATEGORY	このドライバーのCData Sync カテゴリ。	Source, Destination, Cloud Destination
SUPPORTSENHANCEDSQL	API で提供されている以上の、追加SQL 機能がサポートされているかどうか。	TRUE, FALSE
SUPPORTS_BATCH_OPERATIONS	バッチ操作がサポートされているかどうか。	YES, NO
SQL_CAP	このドライバーでサポートされているすべてのSQL 機能。	SELECT, INSERT, DELETE, UPDATE, TRANSACTIONS, ORDERBY, OAUTH, ASSIGNEDID, LIMIT, LIKE, BULKINSERT, COUNT, BULKDELETE, BULKUPDATE, GROUPBY, HAVING, AGGS, OFFSET, REPLICATE, COUNTDISTINCT, JOINS, DROP, CREATE, DISTINCT, INNERJOINS, SUBQUERIES, ALTER, MULTIPLESCHEMAS, GROUPBYNORELATION, OUTERJOINS, UNIONALL, UNION, UPSERT, GETDELETED, CROSSJOINS, GROUPBYCOLLATE, MULTIPLECATS, FULLOUTERJOIN, MERGE, JSONEXTRACT, BULKUPSERT, SUM, SUBQUERIESFULL, MIN, MAX, JOINSFULL, XMLEXTRACT, AVG, MULTISTATEMENTS, FOREIGNKEYS, CASE, LEFTJOINS, COMMAJOINS, WITH, LITERALS, RENAME, NESTEDTABLES, EXECUTE, BATCH, BASIC, INDEX
PREFERRED_CACHE_OPTIONS	使用したいcacheOptions を指定する文字列値。
ENABLE_EF_ADVANCED_QUERY	ドライバーがEntity Framework の高度なクエリをサポートしているかどうかを示します。サポートしていなければ、クエリはクライアントサイドで処理されます。	YES, NO
PSEUDO_COLUMNS	利用可能な疑似カラムを示す文字列の配列。
MERGE_ALWAYS	値がtrue であれば、CData Sync 内でMerge Model が強制的に実行されます。	TRUE, FALSE
REPLICATION_MIN_DATE_QUERY	レプリケート開始日時を返すSELECT クエリ。
REPLICATION_MIN_FUNCTION	サーバーサイドでmin を実行するために使用する式名を、プロバイダーが指定できるようになります。
REPLICATION_START_DATE	レプリケート開始日を、プロバイダーが指定できるようになります。
REPLICATION_MAX_DATE_QUERY	レプリケート終了日時を返すSELECT クエリ。
REPLICATION_MAX_FUNCTION	サーバーサイドでmax を実行するために使用する式名を、プロバイダーが指定できるようになります。
IGNORE_INTERVALS_ON_INITIAL_REPLICATE	初回のレプリケートで、レプリケートをチャンクに分割しないテーブルのリスト。
CHECKCACHE_USE_PARENTID	CheckCache 構文を親キーカラムに対して実行するかどうかを示します。	TRUE, FALSE
CREATE_SCHEMA_PROCEDURES	スキーマファイルの生成に使用できる、ストアドプロシージャを示します。

次のクエリは、WHERE 句で使用できる演算子を取得します。

SELECT * FROM sys_sqlinfo WHERE Name = 'SUPPORTED_OPERATORS'

WHERE 句では、個々のテーブルの制限や要件が異なる場合がありますので注意してください。詳しくは、データモデルセクションを参照してください。

Columns


Name	Type	Description
NAME	String	SQL 構文のコンポーネント、またはサーバー上で処理できる機能。
VALUE	String	サポートされるSQL またはSQL 構文の詳細。

sys_identity

試行された変更に関する情報を返します。

次のクエリは、バッチ処理で変更された行のId を取得します。

         SELECT * FROM sys_identity

Columns


Name	Type	Description
Id	String	データ変更処理から返された、データベース生成Id。
Batch	String	バッチの識別子。1 は単一処理。
Operation	String	バッチ内の処理の結果：INSERTED、UPDATED、またはDELETED。
Message	String	SUCCESS、またはバッチ内の更新が失敗した場合のエラーメッセージ。

sys_information

利用可能なシステム情報を説明します。

次のクエリは、すべてのカラムを取得します。

SELECT * FROM sys_information

Columns


Name	Type	Description
Product	String	製品名。
Version	String	製品のバージョン番号。
Datasource	String	製品が接続するデータソースの名前。
NodeId	String	製品がインストールされているマシンの固有識別子。
HelpURL	String	製品のヘルプドキュメントのURL。
License	String	製品のライセンス情報。（この情報が利用できない場合、この項目は空白のままか「N/A」と表示されます。）
Location	String	製品のライブラリが格納されているファイルパスの場所。
Environment	String	製品が現在稼働している環境またはランタイムのバージョン。
DataSyncVersion	String	本コネクタを使用するために必要なCData Sync のティア。
DataSyncCategory	String	CData Sync 機能のカテゴリ（例：Source、Destination）。

データ型マッピング

Data Type Mappings

The Cloud maps types from the data source to the corresponding data type available in the schema. The table below documents these mappings.


HubSpot Field Type	CData Schema
Date picker	date
Dropdown select	string
HubSpot user	string
Multi-line text	string
Multiple checkboxes	string
Number	float
Radio select	string
Single checkbox	string
Single-line text	string

接続文字列オプション

接続文字列プロパティは、接続を確立するために使用できるさまざまなオプションです。このセクションでは、本プロバイダーの接続文字列で設定できるオプションの一覧を示します。詳細については各リンクをクリックしてください。

Authentication

プロパティ	説明
AuthScheme	Specifies the authentication method to use when connecting to HubSpot.
Schema	Specifies which version of the HubSpot API the provider should use. HubSpotV4 is the latest available API version.
OAuthOptionalScopes	Specifies a space-separated list of optional OAuth scopes to include in the authorization request.
OAuthRequiredScopes	Specifies a space-separated list of required OAuth scopes that the HubSpot app must request during authentication.

OAuth

プロパティ	説明
OAuthAccessToken	データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

Logging

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Schema

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

Miscellaneous

プロパティ	説明
Archived	Specifies whether the provider retrieves archived records when querying supported objects.
ColumnSizes	Specifies a comma-separated list that defines custom column sizes for specific fields.
ExpandAssociations	Specifies whether the provider expands association tables to include one table per object-to-object relationship.
IncludeCustomTables	Specifies whether the provider includes custom HubSpot objects in the schema.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
NumberColumnMode	Specifies how the provider represents numeric fields detected as number types in HubSpot.
Pagesize	Specifies the maximum number of records to retrieve per page when querying data from HubSpot.
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDisplayNames	Specifies whether to use HubSpot's display names for tables and columns instead of their internal API names.
UseDropdownLabels	Specifies whether to return dropdown labels instead of internal values for custom enum fields.
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを指定します。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
AuthScheme	Specifies the authentication method to use when connecting to HubSpot.
Schema	Specifies which version of the HubSpot API the provider should use. HubSpotV4 is the latest available API version.
OAuthOptionalScopes	Specifies a space-separated list of optional OAuth scopes to include in the authorization request.
OAuthRequiredScopes	Specifies a space-separated list of required OAuth scopes that the HubSpot app must request during authentication.

AuthScheme

Specifies the authentication method to use when connecting to HubSpot.

Possible Values

OAuth, PrivateAppToken

データ型

string

デフォルト値

"OAuth"

解説

Use this property to control how the Cloud authenticates with HubSpot. Choose one of the following supported authentication schemes:

OAuth: Performs OAuth 2.0 authentication. Use this method if you are connecting through a registered HubSpot app and using a standard OAuth flow.
PrivateAppToken: Performs token-based authentication using a HubSpot Private App. Set this option if you want to authenticate using the OAuthAccessToken property and a token generated from a HubSpot Private App.

This property is required when establishing a connection and determines how credentials are exchanged with the HubSpot API.

Schema

Specifies which version of the HubSpot API the provider should use. HubSpotV4 is the latest available API version.

Possible Values

HubSpot, HubSpotV3, HubSpotV4

データ型

string

デフォルト値

"HubSpotV3"

解説

This property determines which version of the HubSpot API the Cloud connects to and controls which tables and views are available. Choose from the following options:

HubSpot: Connects to the CRM API v2.
HubSpotV3: Connects to the CRM API v3.
HubSpotV4: Connects to the CRM API v4.

The selected schema version impacts both the structure of available objects and the performance of certain queries.

While HubSpotV4 supports more detailed association data, most endpoints outside of associations do not yet support advanced filtering and may result in slower client-side processing. As a result, HubSpotV3 is generally recommended for most standard queries, while HubSpotV4 is best suited for querying associations.

OAuthOptionalScopes

Specifies a space-separated list of optional OAuth scopes to include in the authorization request.

データ型

string

デフォルト値

"content social automation files forms timeline e-commerce business-intelligence tickets sales-email-read crm.objects.custom.read crm.objects.custom.write crm.schemas.custom.read crm.objects.feedback_submissions.read crm.objects.goals.read crm.objects.leads.read crm.objects.leads.write crm.objects.orders.read crm.objects.orders.write crm.schemas.orders.read crm.schemas.orders.write conversations.read conversations.write crm.objects.users.read settings.users.read settings.users.teams.read crm.objects.quotes.read crm.objects.quotes.write crm.schemas.quotes.read marketing.campaigns.read marketing.campaigns.write crm.objects.invoices.read crm.objects.invoices.write crm.objects.appointments.read crm.objects.appointments.write crm.schemas.appointments.read crm.schemas.appointments.write crm.objects.courses.read crm.objects.courses.write crm.schemas.courses.read crm.schemas.courses.write crm.objects.listings.read crm.objects.listings.write crm.schemas.listings.read crm.schemas.listings.write crm.objects.services.read crm.objects.services.write crm.schemas.services.read crm.schemas.services.write"

解説

This property defines a set of optional OAuth scopes that can be requested when connecting to HubSpot using OAuth 2.0. These scopes provide access to additional features or data types that are not required for basic functionality but may be useful depending on your use case.

HubSpot uses scopes to determine what your application is allowed to access, such as marketing emails, files, quotes, custom objects, and more. These permissions are presented to the user during the OAuth consent flow.

All scopes listed in this property are optional. If the user approves them, the corresponding permissions are included in the access and refresh tokens. If a scope is listed, but the user’s HubSpot account does not support it, the authorization still succeeds, but the resulting tokens do not include access to that feature.

You can modify this list to request access to specific optional features your application uses, such as quotes, forms, or custom objects. For example: "forms crm.objects.quotes.read".

Important: Scopes must be space-separated, not comma-separated. Using commas results in an invalid or incomplete authorization request. To learn more about available scopes and how to configure them, refer to the HubSpot API documentation for more details.

OAuthRequiredScopes

Specifies a space-separated list of required OAuth scopes that the HubSpot app must request during authentication.

データ型

string

デフォルト値

"oauth crm.lists.read crm.lists.write crm.objects.companies.read crm.objects.companies.write crm.objects.contacts.read crm.objects.contacts.write crm.objects.deals.read crm.objects.deals.write crm.objects.owners.read crm.schemas.deals.read crm.schemas.deals.write crm.schemas.companies.read crm.schemas.companies.write crm.schemas.contacts.read crm.schemas.contacts.write"

解説

This property defines the minimum set of permissions (OAuth scopes) that must be requested from HubSpot when connecting using OAuth 2.0. These scopes allow the Cloud to read and write data from specific objects and schemas in your HubSpot account.

HubSpot scopes define what your application can do. Whether it's reading contacts, updating deals, or syncing schemas. These permissions are granted by the user during the OAuth consent flow.

There are two kinds of scopes that may appear in this list:

Required scopes must always be included. If any are missing, HubSpot rejects the authorization request and displays an error to the user.
Conditionally required scopes may depend on the user's account type or the specific HubSpot features enabled. If one of these scopes is included but not available in the user’s account, the authorization fails with an error.

You can modify this list to reduce the permissions your app requests, especially if your app only interacts with a limited set of HubSpot features such as contacts. For example: "oauth crm.objects.contacts.read crm.objects.contacts.write". This configuration only requests access to contact records.

Important: Scopes must be space-separated, not comma-separated. This formatting follows the OAuth 2.0 standard and is required by the HubSpot API. Using commas results in an invalid or incomplete authorization request. To learn more about available scopes and how to configure them, refer to the HubSpot API documentation for more details.

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthAccessToken	データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。

OAuthAccessToken

データソースへのリクエストを認証するために使用されるOAuth アクセストークンを指定します。このトークンは、OAuth 交換が正常に完了した後に認可サーバーから発行されます。

データ型

string

デフォルト値

""

解説

OAuthAccessToken は、保護されたリソースへのアクセスを認可する一時的な認証情報です。これは通常、ユーザーまたはクライアントアプリケーションがOAuth 認証フローを完了した後に、ID プロバイダーから返されます。このプロパティは、自動化されたワークフローや、トークンの処理をドライバーの外部で管理したいカスタムOAuth 実装で最も一般的に使用されます。

OAuth アクセストークンにはサーバーに依存する時間制限があり、ユーザーのアクセスを制限します。タイムアウトは、OAuthExpiresIn プロパティを使用して設定します。ただし、ユーザーが操作を続けている限り、リクエスト間で再発行することでアクセスを維持することができます。

InitiateOAuth がREFRESH に設定されている場合、OAuthExpiresIn とOAuthTokenTimestamp の両方を設定することを推奨します。 Cloud は、これらのプロパティを使用してトークンの有効期限を判断し、最も効率的にリフレッシュできるようにします。 OAuthExpiresIn およびOAuthTokenTimestamp が指定されていない場合、Cloud はトークンを直ちにリフレッシュします。

Note：アクセストークンは機密性の高い認証情報として扱い、安全に保管する必要があります。アクセス制御されていないログ、スクリプト、または設定ファイルでの公開は避けてください。

接続設定時にこのプロパティを使用する方法の詳細については、接続の確立を参照してください。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

SSLServerCert

TLS/SSL を使用して接続する際に、サーバーが受け入れ可能な証明書を指定します。

データ型

string

デフォルト値

""

解説

TLS/SSL 接続を使用している場合は、このプロパティを使用して、サーバーが受け入れるTLS/SSL 証明書を指定できます。このプロパティに値を指定すると、マシンによって信頼されていない他の証明書はすべて拒否されます。

このプロパティは、次のフォームを取ります：


説明	例
フルPEM 証明書（例では省略されています）	`-----BEGIN CERTIFICATE----- MIIChTCCAe4CAQAwDQYJKoZIhv......Qw== -----END CERTIFICATE-----`
証明書を保有するローカルファイルへのパス。	C:\cert.cer
公開鍵（例では省略されています）	`-----BEGIN RSA PUBLIC KEY----- MIGfMA0GCSq......AQAB -----END RSA PUBLIC KEY-----`
MD5 Thumbprint（hex 値はスペースまたはコロン区切り）	`ecadbdda5a1529c58a1e9e09828d70e4`
SHA1 Thumbprint（hex 値はスペースまたはコロン区切り）	`34a929226ae0819f2ec14b4a3d904f801cbb150d`

Note：'*' を使用してすべての証明書を受け入れるように指定することも可能ですが、セキュリティ上の懸念があるため推奨されません。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
Verbosity	ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

Verbosity

ログファイルのVerbosity レベルを指定し、記録される情報の詳細度を制御します。サポートされる値の範囲は1から5までです。

データ型

string

デフォルト値

"1"

解説

このプロパティは、Cloud がログファイルに含める詳細レベルを定義します。 Verbosity レベルを高くするとログに記録される情報の詳細が増えますが、ログファイルが大きくなり取り込まれるデータが増えるためパフォーマンスが低下する可能性があります。

デフォルトのVerbosity レベルは1で、通常の運用にはこれが推奨されます。より高いVerbosity レベルは主にデバッグを目的としています。各レベルの詳細については、ログを参照してください。

LogModules プロパティと組み合わせることで、Verbosity は特定の情報カテゴリに対するログの詳細度を調整できます。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
BrowsableSchemas	レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

BrowsableSchemas

レポートされるスキーマを利用可能なすべてのスキーマのサブセットに制限するオプション設定。例えば、 BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

データ型

string

デフォルト値

""

解説

利用可能なデータベーススキーマをすべてリストすると余分な時間がかかり、パフォーマンスが低下します。接続文字列にスキーマのリストを指定することで、時間を節約しパフォーマンスを向上させることができます。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
Archived	Specifies whether the provider retrieves archived records when querying supported objects.
ColumnSizes	Specifies a comma-separated list that defines custom column sizes for specific fields.
ExpandAssociations	Specifies whether the provider expands association tables to include one table per object-to-object relationship.
IncludeCustomTables	Specifies whether the provider includes custom HubSpot objects in the schema.
MaxRows	集計やGROUP BY を含まないクエリで返される最大行数を指定します。
NumberColumnMode	Specifies how the provider represents numeric fields detected as number types in HubSpot.
Pagesize	Specifies the maximum number of records to retrieve per page when querying data from HubSpot.
PseudoColumns	テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。
Timeout	provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。
UseDisplayNames	Specifies whether to use HubSpot's display names for tables and columns instead of their internal API names.
UseDropdownLabels	Specifies whether to return dropdown labels instead of internal values for custom enum fields.
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを指定します。

Archived

Specifies whether the provider retrieves archived records when querying supported objects.

データ型

bool

デフォルト値

false

解説

This property is only supported when using the HubSpotV3 schema.

When set to true, the Cloud includes archived records in query results.

When set to false, only unarchived (active) records are retrieved.

This property is useful for accessing historical data or records that were previously deleted or deactivated in the HubSpot UI. Archived records may be relevant for audits, migrations, or data recovery scenarios.

Note: Most HubSpotV3 tables support this property, even if they do not include an Archived column. However, the following tables do not support archived filtering, and this property will have no effect:

Workflows
Roles
Teams
UserProvisioning
Folders
Files
Campaigns
All Pipeline tables (DealPipelines, TicketPipelines, etc.)
All PipelineStages tables (DealPipelineStages, LeadPipelineStages, etc.)
All PropertyGroups tables (ContactPropertyGroups, CompanyPropertyGroups, etc.)

ColumnSizes

Specifies a comma-separated list that defines custom column sizes for specific fields.

データ型

string

デフォルト値

""

解説

Use this property to override the default column sizes for fields returned by the Cloud in the HubSpot schema. This is useful when certain fields are known to exceed the default size and require a larger buffer for accurate retrieval.

Accepted formats include:

TableName.ColumnName=Size
ColumnName=Size

For example: Table1.Col1=4000,Table1.Col2=5000,Col1=13

In this example:

Col1 in Table1 is set to 4000.
Col2 in Table1 is set to 5000.
Col1 in all other tables is set to 13.

When both a fully qualified (TableName.ColumnName) and unqualified (ColumnName) entry exist, the fully qualified value takes precedence.

Note: This property is valid only for HubSpot Object tables like: Contacts, Companies, Deals, etc.

Performance Considerations

Setting unnecessarily large column sizes may increase memory usage and reduce performance in client applications, especially when working with large datasets. For best results, size fields only when the default length is known to be insufficient.

ExpandAssociations

Specifies whether the provider expands association tables to include one table per object-to-object relationship.

データ型

bool

デフォルト値

false

解説

This property controls how association data is represented in the schema. It is valid in the HubSpotV3 and HubSpotV4 schemas.

When set to false, the Cloud exposes one associations table per object type. For example:

DealAssociations
CompanyAssociations
ContactAssociations

Each table returns the IDs of the objects associated with that type. For example, DealAssociations returns the IDs of objects associated with each deal.

When set to true, the Cloud expands the schema to include a separate associations table for each pair of related object types. For example:

CompaniesToContactsAssociations
ContactsToDealsAssociations
DealsToLineItemsAssociations

These tables return pairs of IDs showing the relationships between the two object types.

Performance Considerations

Enabling this property increases the number of tables in the schema. This may improve clarity and querying flexibility when working with complex inter-object relationships, but could impact metadata loading time, especially in tools that introspect the full schema.

IncludeCustomTables

Specifies whether the provider includes custom HubSpot objects in the schema.

データ型

bool

デフォルト値

true

解説

When set to true, the Cloud exposes both standard and custom HubSpot objects as tables.

When set to false, only standard objects are exposed. Custom HubSpot objects are excluded from the schema.

This property is available for the HubSpotV3 and HubSpotV4 schemas.

Performance Considerations

Disabling this property may improve metadata load times and reduce schema complexity, especially in environments where custom objects are not used or not relevant to the current integration.

MaxRows

集計やGROUP BY を含まないクエリで返される最大行数を指定します。

データ型

int

デフォルト値

-1

解説

このプロパティのデフォルト値である-1 は、クエリに明示的にLIMIT 句が含まれていない限り、行の制限が適用されないことを意味します。（クエリにLIMIT 句が含まれている場合、クエリで指定された値がMaxRows 設定よりも優先されます。）

MaxRows を0より大きい整数に設定することで、クエリがデフォルトで過度に大きな結果セットを返さないようにします。

このプロパティは、非常に大きなデータセットを返す可能性のあるクエリを実行する際に、パフォーマンスを最適化し、過剰なリソース消費を防ぐのに役立ちます。

NumberColumnMode

Specifies how the provider represents numeric fields detected as number types in HubSpot.

Possible Values

DOUBLE, DECIMAL, STRING

データ型

string

デフォルト値

"DECIMAL"

解説

HubSpot reports all numeric fields (integers, floats, and decimals) using a generic number type. Because of this, the Cloud cannot reliably infer the exact numeric type for each field.

Use this property to control how those fields are reported in the schema. Valid values include:

DOUBLE: Numeric fields are reported using the DOUBLE type, suitable for floating-point math or large datasets where precision is less critical.
DECIMAL: Numeric fields are reported using the DECIMAL type for high-precision use cases.
STRING: Numeric fields are reported as STRING values. Use this when numeric precision or formatting may vary or when working with systems that do not natively support numeric types.

Performance Considerations

Choosing DOUBLE may improve performance for mathematical operations, while DECIMAL offers better precision. Setting the value to STRING avoids rounding or precision issues altogether but may impact downstream numerical calculations.

Note: This property is only applicable when using the HubSpotV3 schema.

Pagesize

Specifies the maximum number of records to retrieve per page when querying data from HubSpot.

データ型

int

デフォルト値

-1

解説

This property controls the page size used in API calls to HubSpot and can be tuned based on the type of data being queried. The effective default and maximum values vary by object type and API endpoint:

Search API (HubSpotV3): The default value is 100. The maximum value is 200.
PropertiesHistory views (HubSpotV3 and HubSpotV4): The default value is 50. The maximum value is 50.
Lists (HubSpotV3): The default value is 100. The maximum value is 500.
ListMemberships (HubSpotV3): The default value is 100. The maximum value is 250.
Association tables (HubSpotV4); when the Id and Type columns are present in the criteria and ExpandAssociations is disabled, or when the Id column is present in the criteria and ExpandAssociations is enabled: The default and maximum value is 500.
All other cases (HubSpotV3 and HubSpotV4): The default and maximum value is 100.

Note: This property is supported only in the HubSpotV3 and HubSpotV4 schemas.

Performance Considerations

Larger page sizes reduce the number of API calls required to retrieve data but may increase memory usage and response time per request. Smaller values may be more reliable when working with large datasets or limited bandwidth environments.

PseudoColumns

テーブルカラムとして公開する擬似カラムを、'TableName=ColumnName;TableName=ColumnName' の形式の文字列で指定します。

データ型

string

デフォルト値

""

解説

このプロパティを使用すると、Cloud がテーブルカラムとして公開する擬似カラムを定義できます。

個々の擬似カラムを指定するには、以下の形式を使用します。

Table1=Column1;Table1=Column2;Table2=Column3

すべてのテーブルのすべての擬似カラムを含めるには、次を使用してください：

*=*

Timeout

provider がタイムアウトエラーを返すまでにサーバーからの応答を待機する最大時間を秒単位で指定します。

データ型

int

デフォルト値

60

解説

タイムアウトは、クエリや操作全体ではなくサーバーとの個々の通信に適用されます。例えば、各ページング呼び出しがタイムアウト制限内に完了する場合、クエリは60秒を超えて実行を続けることができます。

タイムアウトはデフォルトで60秒に設定されています。タイムアウトを無効にするには、このプロパティを0に設定します。

タイムアウトを無効にすると、操作が成功するか、サーバー側のタイムアウト、ネットワークの中断、またはサーバーのリソース制限などの他の条件で失敗するまで無期限に実行されます。

Note： このプロパティは慎重に使用してください。長時間実行される操作がパフォーマンスを低下させたり、応答しなくなる可能性があるためです。

UseDisplayNames

Specifies whether to use HubSpot's display names for tables and columns instead of their internal API names.

データ型

bool

デフォルト値

true

解説

When set to true, the Cloud maps object and field names using the human-readable display names defined in HubSpot's user interface. This can make the schema easier to understand, especially for users who are not familiar with HubSpot's internal naming conventions.

When set to false, the Cloud uses the raw API names for all tables and columns. This mode is useful if you need exact alignment with HubSpot's API documentation or are working with automation scripts that require predictable field identifiers.

UseDropdownLabels

Specifies whether to return dropdown labels instead of internal values for custom enum fields.

データ型

bool

デフォルト値

true

解説

This property affects how values from custom dropdown fields are returned in query results.

When set to true, the Cloud returns the human-readable labels shown in the HubSpot UI. When set to false, the Cloud returns the raw internal values stored in HubSpot.

This setting only applies to custom properties with drop-down (enumerated) field types. Built-in properties or fields with non-enumerated types are not affected.

Use this property when you want control over whether values should be optimized for readability or precision.

UseSimpleNames

テーブルとカラムに簡略名を使用するかどうかを指定します。

データ型

bool

デフォルト値

false

解説

HubSpot テーブルでは、標準的なデータベースでは通常許可されない特殊文字を名前に含めることができます。このプロパティを使用すると、Cloud を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をTrue に設定すると、返されるカラム名をシンプルにします。表示されるカラム名において、アルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。

Notes：

英数字以外の文字はアンダースコアに置き換えられます。
カラム名やテーブル名が128 文字を超える場合は、SQL Server 標準に準拠するために128文字に切り詰められます。

Third Party Copyrights

LZMA from 7Zip LZMA SDK

LZMA SDK is placed in the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or distribute the original LZMA SDK code, either in source code form or as a compiled binary, for any purpose, commercial or non-commercial, and by any means.

LZMA2 from XZ SDK

Version 1.9 and older are in the public domain.

Xamarin.Forms

Xamarin SDK

The MIT License (MIT)

Copyright (c) .NET Foundation Contributors

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

NSIS 3.10

Copyright (C) 1999-2025 Contributors THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS COMMON PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.

1. DEFINITIONS

"Contribution" means:

a) in the case of the initial Contributor, the initial code and documentation distributed under this Agreement, and b) in the case of each subsequent Contributor:

i) changes to the Program, and

ii) additions to the Program;

where such changes and/or additions to the Program originate from and are distributed by that particular Contributor. A Contribution 'originates' from a Contributor if it was added to the Program by such Contributor itself or anyone acting on such Contributor's behalf. Contributions do not include additions to the Program which: (i) are separate modules of software distributed in conjunction with the Program under their own license agreement, and (ii) are not derivative works of the Program.

"Contributor" means any person or entity that distributes the Program.

"Licensed Patents " mean patent claims licensable by a Contributor which are necessarily infringed by the use or sale of its Contribution alone or when combined with the Program.

"Program" means the Contributions distributed in accordance with this Agreement.

"Recipient" means anyone who receives the Program under this Agreement, including all Contributors.

2. GRANT OF RIGHTS

a) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, distribute and sublicense the Contribution of such Contributor, if any, and such derivative works, in source code and object code form.

b) Subject to the terms of this Agreement, each Contributor hereby grants Recipient a non-exclusive, worldwide, royalty-free patent license under Licensed Patents to make, use, sell, offer to sell, import and otherwise transfer the Contribution of such Contributor, if any, in source code and object code form. This patent license shall apply to the combination of the Contribution and the Program if, at the time the Contribution is added by the Contributor, such addition of the Contribution causes such combination to be covered by the Licensed Patents. The patent license shall not apply to any other combinations which include the Contribution. No hardware per se is licensed hereunder.

c) Recipient understands that although each Contributor grants the licenses to its Contributions set forth herein, no assurances are provided by any Contributor that the Program does not infringe the patent or other intellectual property rights of any other entity. Each Contributor disclaims any liability to Recipient for claims brought by any other entity based on infringement of intellectual property rights or otherwise. As a condition to exercising the rights and licenses granted hereunder, each Recipient hereby assumes sole responsibility to secure any other intellectual property rights needed, if any. For example, if a third party patent license is required to allow Recipient to distribute the Program, it is Recipient's responsibility to acquire that license before distributing the Program.

d) Each Contributor represents that to its knowledge it has sufficient copyright rights in its Contribution, if any, to grant the copyright license set forth in this Agreement.

3. REQUIREMENTS

A Contributor may choose to distribute the Program in object code form under its own license agreement, provided that:

a) it complies with the terms and conditions of this Agreement; and

b) its license agreement:

i) effectively disclaims on behalf of all Contributors all warranties and conditions, express and implied, including warranties or conditions of title and non-infringement, and implied warranties or conditions of merchantability and fitness for a particular purpose;

ii) effectively excludes on behalf of all Contributors all liability for damages, including direct, indirect, special, incidental and consequential damages, such as lost profits;

iii) states that any provisions which differ from this Agreement are offered by that Contributor alone and not by any other party; and

iv) states that source code for the Program is available from such Contributor, and informs licensees how to obtain it in a reasonable manner on or through a medium customarily used for software exchange.

When the Program is made available in source code form:

a) it must be made available under this Agreement; and

b) a copy of this Agreement must be included with each copy of the Program.

Contributors may not remove or alter any copyright notices contained within the Program.

Each Contributor must identify itself as the originator of its Contribution, if any, in a manner that reasonably allows subsequent Recipients to identify the originator of the Contribution.

4. COMMERCIAL DISTRIBUTION

Commercial distributors of software may accept certain responsibilities with respect to end users, business partners and the like. While this license is intended to facilitate the commercial use of the Program, the Contributor who includes the Program in a commercial product offering should do so in a manner which does not create potential liability for other Contributors. Therefore, if a Contributor includes the Program in a commercial product offering, such Contributor ("Commercial Contributor") hereby agrees to defend and indemnify every other Contributor ("Indemnified Contributor") against any losses, damages and costs (collectively "Losses") arising from claims, lawsuits and other legal actions brought by a third party against the Indemnified Contributor to the extent caused by the acts or omissions of such Commercial Contributor in connection with its distribution of the Program in a commercial product offering. The obligations in this section do not apply to any claims or Losses relating to any actual or alleged intellectual property infringement. In order to qualify, an Indemnified Contributor must: a) promptly notify the Commercial Contributor in writing of such claim, and b) allow the Commercial Contributor to control, and cooperate with the Commercial Contributor in, the defense and any related settlement negotiations. The Indemnified Contributor may participate in any such claim at its own expense.

For example, a Contributor might include the Program in a commercial product offering, Product X. That Contributor is then a Commercial Contributor. If that Commercial Contributor then makes performance claims, or offers warranties related to Product X, those performance claims and warranties are such Commercial Contributor's responsibility alone. Under this section, the Commercial Contributor would have to defend claims against the other Contributors related to those performance claims and warranties, and if a court requires any other Contributor to pay any damages as a result, the Commercial Contributor must pay those damages.

5. NO WARRANTY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the appropriateness of using and distributing the Program and assumes all risks associated with its exercise of rights under this Agreement, including but not limited to the risks and costs of program errors, compliance with applicable laws, damage to or loss of data, programs or equipment, and unavailability or interruption of operations.

6. DISCLAIMER OF LIABILITY

EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.

7. GENERAL

If any provision of this Agreement is invalid or unenforceable under applicable law, it shall not affect the validity or enforceability of the remainder of the terms of this Agreement, and without further action by the parties hereto, such provision shall be reformed to the minimum extent necessary to make such provision valid and enforceable.

If Recipient institutes patent litigation against a Contributor with respect to a patent applicable to software (including a cross-claim or counterclaim in a lawsuit), then any patent licenses granted by that Contributor to such Recipient under this Agreement shall terminate as of the date such litigation is filed. In addition, if Recipient institutes patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Program itself (excluding combinations of the Program with other software or hardware) infringes such Recipient's patent(s), then such Recipient's rights granted under Section 2(b) shall terminate as of the date such litigation is filed.

All Recipient's rights under this Agreement shall terminate if it fails to comply with any of the material terms or conditions of this Agreement and does not cure such failure in a reasonable period of time after becoming aware of such noncompliance. If all Recipient's rights under this Agreement terminate, Recipient agrees to cease use and distribution of the Program as soon as reasonably practicable. However, Recipient's obligations under this Agreement and any licenses granted by Recipient relating to the Program shall continue and survive.

Everyone is permitted to copy and distribute copies of this Agreement, but in order to avoid inconsistency the Agreement is copyrighted and may only be modified in the following manner. The Agreement Steward reserves the right to publish new versions (including revisions) of this Agreement from time to time. No one other than the Agreement Steward has the right to modify this Agreement. IBM is the initial Agreement Steward. IBM may assign the responsibility to serve as the Agreement Steward to a suitable separate entity. Each new version of the Agreement will be given a distinguishing version number. The Program (including Contributions) may always be distributed subject to the version of the Agreement under which it was received. In addition, after a new version of the Agreement is published, Contributor may elect to distribute the Program (including its Contributions) under the new version. Except as expressly stated in Sections 2(a) and 2(b) above, Recipient receives no rights or licenses to the intellectual property of any Contributor under this Agreement, whether expressly, by implication, estoppel or otherwise. All rights in the Program not expressly granted under this Agreement are reserved.

This Agreement is governed by the laws of the State of New York and the intellectual property laws of the United States of America. No party to this Agreement will bring a legal action under this Agreement more than one year after the cause of action arose. Each party waives its rights to a jury trial in any resulting litigation.

Cloud

HubSpot - CData Cloud

概要

主要機能

はじめに

HubSpot への接続

CData Cloud サービスからデータにアクセス

接続の確立

HubSpot への認証

OAuth

データアクセスのファインチューニング

カスタムフィールドへのアクセス

データアクセスのファインチューニング

廃止予定機能の通知

HubSpot Contact Lists API の廃止について

その他の影響を受ける可能性のあるテーブル

推奨事項

HubSpot Marketing Email V1 API の廃止について

OAuth スコープとエンドポイント

HubSpot に必要なスコープおよびエンドポイントドメイン

スコープについて

HubSpot に必要なスコープ

エンドポイントドメインについて

HubSpot に必要なエンドポイントドメイン

SSL の設定

SSL 設定のカスタマイズ

ファイアウォールとプロキシ

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

バッチ操作

HubSpot データモデル

テーブル

ストアドプロシージャ

テーブル

CData Cloud - HubSpot テーブル

Companies

Table Specific Information

SELECT

Columns

CompanyProperties

Table Specific Information

SELECT

Columns

CompanyPropertyGroups

Table Specific Information

SELECT

Columns

ContactProperties

Table Specific Information

SELECT

Columns

ContactPropertyGroups

Table Specific Information

SELECT

Columns

Contacts

Table Specific Information

SELECT

UPDATE

Columns

CrmAssociations

Table Specific Information

SELECT

INSERT

UPDATE

DELETE

Columns

DealAssociations

Table Specific Information

SELECT

INSERT

DELETE

Columns

DealProperties

Table Specific Information

SELECT

Columns

DealPropertyGroups