接続の確立

HubSpot への接続を追加

HubSpot への接続を追加するには：

アプリケーションコンソールで、接続ページに移動します。
接続の追加パネルで、追加したい接続のアイコンを選択します。
HubSpot アイコンが利用できない場合は、Add More アイコンをクリックしてCData サイトからHubSpot コネクタをダウンロードおよびインストールします。

必須プロパティについては、設定タブを参照してください。

通常必須ではない接続プロパティについては、高度な設定タブを参照してください。

HubSpot への認証

HubSpot データソースへの接続に使用できる認証方法は2つあります。非公開アプリトークンベースおよびOAuth 認証です。

HubspotV3 スキーマのいくつかのテーブルは、OAuth の仕組みでは動作しないかもしれません。API 制限のため、これらのスキーマはPrivateAppToken ベース認証での使用に限定されます。具体的には、データモデルセクションの各テーブルで、サポートされる認証方法を説明します。

OAuth

AuthScheme は、すべてのOAuth フローでOAuth に設定する必要があります。以下のOAuth フローは、すでに設定済みであることを前提として書かれています。

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

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

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

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

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

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

UseDisplayNames
UseSimpleNames

高度な機能

このセクションでは、HubSpot Sync App の高度な機能を厳選して説明します。

ユーザー定義ビュー

Sync App を使用すると、事前設定されたクエリによって内容が決定されるユーザー定義ビューと呼ばれる仮想テーブルを定義できます。このビューは、ドライバーに発行されるクエリを直接制御できない場合に有効です。カスタムビューの作成と設定の概要については、ユーザー定義ビューを参照してください。

SSL の設定

SSL の設定を使用して、Sync App が証明書のネゴシエーションをどのように扱うかを調整します。さまざまな証明書形式を選択できます。詳しくは、接続文字列オプションにあるSSLServerCert プロパティを参照してください。

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

Windows プロキシとHTTP プロキシを含むファイアウォールとプロキシに合致するようSync App を設定します。トンネル接続を設定することもできます。

クエリ処理

Sync App は、HubSpot にできるだけ多くのSELECT ステートメント処理をオフロードし、残りのクエリをクライアント側のインメモリで処理します。

詳しくはクエリ処理を参照してください。

ログ

CData ログを調整するために使用可能な設定の概要については、ログを参照してください。基本的なロギングでは、次の2つの接続プロパティを設定するだけです。LogModules 接続プロパティを使用してログに記録する情報のサブセットを選択できる、より洗練されたロギングをサポートする多数の機能があります。

SSL の設定

SSL 設定のカスタマイズ

デフォルトでは、Sync App はサーバーの証明書をシステムの信頼できる証明書ストアと照合してSSL / TLS のネゴシエーションを試みます。

別の証明書を指定するには、利用可能なフォーマットについてSSLServerCert プロパティを参照してください。

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

Firewall またはProxy 経由の接続

HTTP プロキシ

Windows のシステムプロキシ経由の接続では、接続プロパティを追加で設定する必要はありません。他のプロキシに接続するには、ProxyAutoDetect をfalse に設定します。

さらにHTTP プロキシへの認証には、ProxyServer とProxyPort に加えてProxyAuthScheme、ProxyUser、およびProxyPassword を設定します。

その他のプロキシ

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

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

データモデル

CData Sync App は、HubSpot エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。このセクションでは、API の制限および要件について説明します。既定の SupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

HubSpot API の使用

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

HubSpot V3 API の使用

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

HubSpot V4 API の使用

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

HubSpot データモデル

CData Sync App は、HubSpot エンティティをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。このセクションでは、API の制限および要件について説明します。既定の SupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

テーブル

テーブルでは、利用可能なテーブルを説明します。

ビュー

ビューは変更ができないテーブルです。一般的には、Read-only で更新が不可能なデータはビューとして表されます。

ストアドプロシージャ

ストアドプロシージャは、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

テーブル

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

HubSpot Connector for CData Sync テーブル


Name	Description
Companies	Companies may be kept track of in HubSpot just like contacts. They can be added to, updated, and removed from this table.
CompanyProperties	Company properties are the standard and custom pieces of field data that appear in HubSpot.
CompanyPropertyGroups	Company property groups in HubSpot offer a way of organizing individual types of properties for companies. Each company property must belong to a property group.
ContactLists	Contact lists in HubSpot can be used to group together contacts with similar characteristics.
ContactProperties	Contact properties are the standard and custom pieces of field data that appear in HubSpot.
ContactPropertyGroups	Contact property groups in HubSpot offer a way of organizing individual types of properties for contacts. Each contact property must belong to a property group.
Contacts	Your contacts in HubSpot may be used for marketing campaigns and can be retrieved, inserted, updated, and deleted from this table.
ContactsInList	Retrieves the contacts in a given list in HubSpot. New contacts may be added to the list or removed from it. A ListId must be specified to retrieve the current contacts in the list.
CrmAssociations	Query the available CRM Associations in HubSpot.
DealAssociations	Deal associations can be used to insert or delete individual associations with Deals.
DealProperties	Deal properties are the standard and custom pieces of field data that appear in HubSpot.
DealPropertyGroups	Contact property groups in HubSpot offer a way of organizing individual types of properties for contacts. Each contact property must belong to a property group.
Deals	Your deals in HubSpot which may be used for making offers to potential customers.
EcommerceSettings	Retrieve the current ecommerce settings for your portal or app.
EmailSubscriptions	The subscription types a given email is subscribed to. An email must be specified to return results. Subscriptions may be removed by deleting them.
Engagements	Engagements represent any of a number of different types of engagements you have in HubSpot.
Forms	Create and manage HubSpot Forms.
LineItemProperties	Get all of the properties for the line item object type, along with the property definitions.
LineItems	Query the available line items in HubSpot.
MarketingEmails	Create and manage HubSpot Marketing Emails.
ProductProperties	Get all of the properties for the product object type, along with the property definitions.
Products	Query the available products in HubSpot.
SocialMediaMessages	Create and manage HubSpot social media messages.
TicketProperties	Get all of the properties for the ticket object type, along with the property definitions.
TicketPropertyGroups	Get all of the property groups for the specified Ticket object type.
Tickets	Get all tickets from a portal.
Workflows	Select and manage HubSpot workflows.

Companies

Companies may be kept track of in HubSpot just like contacts. They can be added to, updated, and removed from this table.

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		The id of the company in HubSpot.
IsDeleted	Boolean	True		A boolean indicating if the company is deleted.
OtherProperties	String	True		Other properties about the company will dynamically obtained at runtime and will vary depending on the company properties specific to your HubSpot HUB.

CompanyProperties

Company properties are the standard and custom pieces of field data that appear in HubSpot.

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		The name of the contact property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		The human readable label for the company property that will display in the HubSpot UI.
FieldType	String	False		The type of field that will display on the screen for the company property. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, booleancheckbox, checkbox
Type	String	False		The stored machine type for the company property. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False	ContactPropertyGroups.Name	The group the company property is a part of.
Description	String	False		A description of what the property is for.
DisplayMode	String	False		How the property will be displayed.
DisplayOrder	Integer	False		The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False		Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False		Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False		Boolean indicating if the property is calculated.
IsHidden	Boolean	False		Boolean indicating if the property is hidden.
IsHubspotDefined	Boolean	False		Boolean indicating if the property is defined by HubSpot.
MutableDefinitionNotDeletable	Boolean	False		Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False		Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False		An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

CompanyPropertyGroups

Company property groups in HubSpot offer a way of organizing individual types of properties for companies. Each company property must belong to a property group.

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		The name of the contact property group.
DisplayName	String	False		The display name of the contact group.
DisplayOrder	Integer	False		The numerical order of the contact group with respect to other contact groups.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

ContactLists

Contact lists in HubSpot can be used to group together contacts with similar characteristics.

Table Specific Information

Contact lists represent lists that contacts can be added to in order to more easily sort them. They can be either manual lists or dynamic lists. Contacts will be added to the list automatically when they are added to HubSpot based on some criteria.

SELECT

Contact lists can be filtered by ListId or by whether or not they are dynamic. For example:

SELECT * FROM ContactLists WHERE ListId = '123456789'
SELECT * FROM ContactLists WHERE IsDynamic = 'false'

Multiple ListIds may be specified together with an IN operator:

SELECT * FROM ContactLists WHERE ListId IN (1, 2, 3)

Columns


Name	Type	ReadOnly	References	Description
ListId [KEY]	Long	True		The unique id of the list.
Name	String	False		The name of the contact list.
CreatedAt	Datetime	True		When the contact list was created.
UpdatedAt	Datetime	True		When the contact list was last updated.
IsDynamic	Boolean	False		A boolean indicating if the contact list is dynamic.
FiltersAggregate	String	False		An aggregate of filters that a dynamic contact list uses to determine if a newly created contact should be added to the list.
InternalListId	Long	True		An internal id for the contact list.
LastProcessingStateChangeAt	Datetime	True		Metadata describing when the last processing state was changed.
ProcessingState	String	True		Metadata indicating the current stage of processing.
LastSizeChangeAt	Datetime	True		Metadata describing when the last time the contact list size was changed.
ListSize	Long	True		Metadata indicating the size of the contact list.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

ContactProperties

Contact properties are the standard and custom pieces of field data that appear in HubSpot.

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		The name of the contact property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		The human readable label for the contact property that will display in the HubSpot UI.
FieldType	String	False		The type of field that will display on the screen for the company property. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox
Type	String	False		The stored machine type for the company property. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False	ContactPropertyGroups.Name	The group the company property is a part of.
Description	String	False		A description of what the property is for.
DisplayMode	String	False		How the property will be displayed.
DisplayOrder	Integer	False		The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False		Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False		Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False		Boolean indicating if the property is calculated.
IsHidden	Boolean	False		Boolean indicating if the property is hidden.
IsFavorited	Boolean	False		Boolean indicating if the property is favorited.
FavoritedOrder	Integer	False		The favorited order for this property.
MutableDefinitionNotDeletable	Boolean	False		Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False		Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False		An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

ContactPropertyGroups

Contact property groups in HubSpot offer a way of organizing individual types of properties for contacts. Each contact property must belong to a property group.

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		The name of the contact property group.
DisplayName	String	False		The display name of the contact group.
DisplayOrder	Integer	False		The numerical order of the contact group with respect to other contact groups.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Contacts

Your contacts in HubSpot may be used for marketing campaigns and can be retrieved, inserted, updated, and deleted from this table.

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		The unique id for the contact.
ListId	Long	True		The list id the contact is a part of.
SearchTerms	String	True		An input only field representing potential searchterms you would like to specify when selecting contacts.
CanonicalVid	Long	True		The cannonical vid associated with the contact.
ProfileToken	String	True		A token for the profile of the contact.
ProfileUrl	String	True		A url to the profile of the contact.
IdentityProfilesAggregate	String	True		An aggregate of identities associated with this contact if any.
FormSubmissionsAggregate	String	True		An aggregate of forms submitted by this contact if any.
MergeAuditsAggregate	String	True		An aggregate of merged audits associated with this contact.
MergedVidsAggregate	String	True		An aggregate of merged vids associated with this contact.
OtherProperties	String	True		Other properties about the contact will dynamically obtained at runtime and will vary depending on the contact properties specific to your HubSpot HUB.

ContactsInList

Retrieves the contacts in a given list in HubSpot. New contacts may be added to the list or removed from it. A ListId must be specified to retrieve the current contacts in the list.

Table Specific Information

Contacts in a given list can be selected, inserted, and removed from that list using this table.

SELECT

When selecting from ContactsInList, the ListId must be specified in order to retrieve any results. For example:

SELECT * FROM ContactsInList WHERE ListId = '123456789'

Columns


Name	Type	ReadOnly	References	Description
VID [KEY]	Long	False		The unique id for the contact.
ListId [KEY]	Long	False		The list id the contact is a part of.
CanonicalVid	Long	True		The cannonical vid associated with the contact.
ProfileToken	String	True		A token for the profile of the contact.
ProfileUrl	String	True		A url to the profile of the contact.
IdentityProfilesAggregate	String	True		An aggregate of identities associated with this contact if any.
FormSubmissionsAggregate	String	True		An aggregate of forms submitted by this contact if any.
MergeAuditsAggregate	String	True		An aggregate of merged audits associated with this contact.
MergedVidsAggregate	String	True		An aggregate of merged vids associated with this contact.
OtherProperties	String	True		Other properties about the contact will dynamically obtained at runtime and will vary depending on the contact properties specific to your HubSpot HUB.

CrmAssociations

Query the available CRM Associations in HubSpot.

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		The IDs of objects associated with the given object, based on the specified association type.
FromObjectId [KEY]	Long	False		The ID of the object being associated.
ToObjectId [KEY]	Long	False		The ID of the object the from object is being associated with.
Category [KEY]	String	False		The category of the association. Currently this must be 'HUBSPOT_DEFINED'.
DefinitionId [KEY]	Long	False		The ID of the association definition.

DealAssociations

Deal associations can be used to insert or delete individual associations with Deals.

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	The Id of the deal.
AssociatedId [KEY]	Long	False		The Id of the associated entity.
AssociationType [KEY]	String	False		The type of association such as Company, or Contact.

DealProperties

Deal properties are the standard and custom pieces of field data that appear in HubSpot.

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		The name of the contact property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		The human readable label for the contact property that will display in the HubSpot UI.
FieldType	String	False		The type of field that will display on the screen for the company property. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox, booleancheckbox
Type	String	False		The stored machine type for the company property. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False	DealPropertyGroups.Name	The group the company property is a part of.
Description	String	False		A description of what the property is for.
DisplayMode	String	False		How the property will be displayed.
DisplayOrder	Integer	False		The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False		Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False		Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False		Boolean indicating if the property is calculated.
IsHidden	Boolean	False		Boolean indicating if the property is hidden.
IsDeleted	Boolean	True		Boolean indicating if the property has been deleted.
IsHubspotDefined	Boolean	True		Boolean indicating if the property is defined by HubSpot.
ShowCurrencySymbol	Boolean	False		Boolean indicating if the currency symbol should be shown. Only applicable for numbers.
MutableDefinitionNotDeletable	Boolean	False		Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False		Boolean indicating if the value of the property is read only.
OptionsUpdatable	Boolean	False		Boolean indicating if the options can be modified.
OptionsAggregate	String	False		An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

DealPropertyGroups

Contact property groups in HubSpot offer a way of organizing individual types of properties for contacts. Each contact property must belong to a property group.

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		The name of the contact property group.
DisplayName	String	False		The display name of the contact group.
DisplayOrder	Integer	False		The numerical order of the contact group with respect to other contact groups.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Deals

Your deals in HubSpot which may be used for making offers to potential customers.

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		The unique id for the deal.
DealName	String	True		The name of the deal.
IsDeleted	Boolean	True		A boolean indicating if the deal has been deleted.
AssociatedCompanyIds	String	True		A comma separated list of company ids associated with the deal.
AssociatedDealIds	String	True		A comma separated list of other deals associated with this deal.
AssociatedVids	String	True		A comma separated list of contact ids associated with this deal.

EcommerceSettings

Retrieve the current ecommerce settings for your portal or app.

Table Specific Information

The Ecommerce Settings table is where you set up the property mappings for your use of the Ecommerce Bridge API.

SELECT

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

SELECT * FROM EcommerceSettings

SELECT * FROM EcommerceSettings WHERE AppId = '123456'

Columns


Name	Type	ReadOnly	References	Description
PropertyName	String	True		Name of the property.
DataType	String	True		Data type of the property. 使用できる値は次のとおりです。STRING, NUMBER, DATETIME, AVATAR_IMAGE
TargetHubspotProperty	String	True		Name of the target property on Hubspot that this property represents.
Enabled	Boolean	True		Boolean value that shows if this representation of this property is enabled or not.
ImportOnInstall	Boolean	True		Boolean value that shows if this property should be imported during installation procedure.
SettingType	String	True		The type of the property. It can be: Product, Deal, LineItem or Contact 使用できる値は次のとおりです。PRODUCT, DEAL, CONTACT, LINE_ITEM
AppId	String	True		The app ID in which the property is or will be imported.

EmailSubscriptions

The subscription types a given email is subscribed to. An email must be specified to return results. Subscriptions may be removed by deleting them.

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 which has been subscribed.
SubscriptionId [KEY]	Long	True		The id of the subscription type.
IsSubscribed	Boolean	False		Boolean indicating if the customer is subscribed.
ExtraUrlParameters	String	False		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.
LegalBasis	String	False		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'. 使用できる値は次のとおりです。LEGITIMATE_INTEREST_PQL, LEGITIMATE_INTEREST_CLIENT, PERFORMANCE_OF_CONTRACT, CONSENT_WITH_NOTICE, NON_GDPR, PROCESS_AND_STORE, LEGITIMATE_INTEREST_OTHER
LegalBasisExplanation	String	False		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.
OptState	String	False		Determines whether a contact is opted in or out of a given email subscription. If you OPT OUT of all emails or a specific email subscription type for a recipient, there is NO UNDO for this operation. The possible values are OPT_IN, OPT_OUT, and NOT_OPTED. 使用できる値は次のとおりです。OPT_IN, OPT_OUT, NOT_OPTED

Engagements

Engagements represent any of a number of different types of engagements you have in HubSpot.

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		The id of the engagement.
PortalId	Long	True		The portal id the engagement is associated with.
IsActive	Boolean	True		Boolean indicating if the engagement is active or not.
CreatedAt	Datetime	True		When the engagement was created.
UpdatedAt	Datetime	True		When the engagement was last updated.
CreatedBy	Long	True		User id of the user who created the engagement.
ModifiedBy	Long	True		User id of the user who lastmodified the engagement.
OwnerId	Long	False	Owners.OwnerId	The owner id of the engagement.
Type	String	False		The type of engagement. Required on inserts.
ActivityType	String	False		The activity type of engagement.
DateTime	Datetime	False		A custom datetime that can be specified when inserting the engagement. This can be used for keeping track of something related to the engagement such as when a call was made.
AssociatedContacts	String	False		A comma separated list of contact ids associated with the engagement.
AssociatedCompanies	String	False		A comma separated list of company ids associated with the engagement.
AssociatedDeals	String	False		A comma separated list of deal ids associated with the engagement.
AssociatedOwners	String	True		A comma separated list of owner ids associated with the engagement.
AssociatedWorkflows	String	False		A comma separated list of workflow ids associated with the engagement.
AssociatedTickets	String	False		A comma separated list of ticket ids associated with the engagement.
Attachments	String	False		The attachments associated with this engagement.
MessageId	String	False		The messageId of an engagement.
ThreadId	String	False		The threadId of an engagement.
Body	String	False		The body of an engagement. Only used when Type = NOTE, TASK, PUBLISHING_TASK, CALL, or MEETING.
Status	String	False		The status of the task. Only used when Type = TASK, CALL, MEETING.
ForObjectType	String	False		The object type the task is for. For instance, CONTACT. Only used when Type = TASK.
StartTime	String	False		The start date time for the meeting. Only used when Type = MEETING.
EndTime	String	False		The end date time for the meeting. Only used when Type = MEETING.
Title	String	False		The title of the meeting. Only used when Type = MEETING.
FromEmail	String	False		The from email in the engagement. Only used when Type = EMAIL.
FromFirstName	String	False		The first name the email was from in the engagement. Only used when Type = EMAIL.
FromLastName	String	False		The last name the email was from in the engagement. Only used when Type = EMAIL.
ToEmail	String	False		A comma separated list of emails the message was sent to. Only used when Type = EMAIL.
Cc	String	False		A comma separated list of cc'd email addresses. Only used when Type = EMAIL.
Bcc	String	False		A comma separated list of bcc'd email addresses. Only used when Type = EMAIL.
Subject	String	False		The subject of the email. Only used when Type = EMAIL.
EmailHtml	String	False		Html content consisting of the body of the email. Only used when Type = EMAIL.
EmailText	String	False		Plain text content consisting of the body of the email. Only used when Type = EMAIL.
CampaignGuid	String	False		The campaign guid of an engagement. Only used when Type = PUBLISHING_TASK.
Category	String	False		The category of the engagement. Used when Type = PUBLISHING_TASK.
CategoryId	Integer	False		The category id of the engagement. Used when Type = PUBLISHING_TASK.
ContentId	String	False		The content id of the engagement. Used when Type = PUBLISHING_TASK.
State	String	False		The state of the engagement. Used when Type = PUBLISHING_TASK.
Name	String	False		The name of the engagement. Used when Type = PUBLISHING_TASK.
ToNumber	String	False		The phone number that was called. Used when Type = CALL.
FromNumber	String	False		The phone number that was used as the from number. Used when Type = CALL.
ExternalId	String	False		For calls made in HubSpot, this will be the internal ID of the call. Used when Type = CALL.
DurationMilliseconds	Long	False		The duration of the call in milliseconds. Used when Type = CALL.
ExternalAccountId	String	False		For calls made in HubSpot, this will be the internal ID of the account used to make the call. Used when Type = CALL.
RecordingUrl	String	False		The URL of the recording file . Used when Type = CALL.
Disposition	String	False		Internal GUID that corresponds to the Call Outcome. Used when Type = CALL.
MeetingOutcome	String	False		Meeting outcome. Used when TYPE = MEETING. The allowed values are: SCHEDULED, COMPLETED, RESCHEDULED, NO SHOW, CANCELED.
TaskType	String	False		Task type. Used when TYPE = TASK. The allowed values are: TODO, EMAIL, CALL.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Forms

Create and manage HubSpot Forms.

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		The unique key for the form.
Name	String	False		The name of the form.
Action	String	False		An action to execute when the form is submitted.
CSSClass	String	False		The CSS class associated with the form.
IsDeletable	Boolean	False		A boolean indicating if the form is deletable.
EmbeddedCode	String	False		Embedded javascript code included with the form.
FollowUpId	String	False		An Id to follow up with if available.
IgnoreCurrentValues	Boolean	False		A boolean indicating if current or default values should be ignored when submitting the form.
Method	String	False		The HTTP method to use when submitting the form.
MigratedFrom	String	True		Information about where the form was migrated from if available.
NotifyRecipients	String	False		Email address of recipients that should notified when the form is submitted.
PerformableHTML	String	False		HTML that should be performed on the form.
Redirect	String	False		A url to redirect the user to once the form has been submitted.
SubmitText	String	False		The submit button text.
CreatedAt	Datetime	True		When the form was created.
UpdatedAt	Datetime	True		When the form was last updated.
FormFieldGroupsAggregate	String	False		A collection of the groups of fields available in the form.
SelectedExternalOptionsAggregate	String	False		The selected external options for the form. This includes the default lifecycle stage which categorizes your contacts and companies while providing context about where they are in your sales and marketing processes.
MetaDataAggregate	String	True		A collection of metadata about the form.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

LineItemProperties

Get all of the properties for the line item object type, along with the property definitions.

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		The name of the ticket property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		The human readable label for the ticket property that will display in the HubSpot UI.
FieldType	String	False		The type of field that will display on the screen for the company property. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox
Type	String	False		The stored machine type for the company property. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False		The group the company property is a part of.
Description	String	False		A description of what the property is for.
DisplayMode	String	False		How the property will be displayed.
DisplayOrder	Integer	False		The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False		Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False		Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False		Boolean indicating if the property is calculated.
IsHidden	Boolean	False		Boolean indicating if the property is hidden.
IsFavorited	Boolean	False		Boolean indicating if the property is favorited.
FavoritedOrder	Integer	False		The favorited order for this property.
MutableDefinitionNotDeletable	Boolean	False		Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False		Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False		An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

LineItems

Query the available line items in HubSpot.

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		The internal ID for this line item.
Name	String	False		The name for the product for this line item.
Price	String	False		The price of the line item.
Quantity	String	False		The quantity of the line item.
Description	String	False		The description of the line item.
ProductId	String	False		The objectId of a product object, and represents the product being sold. It is required when you create a new line item.
Version	Integer	True		The current version of this line item. This is incremented each time the line item is updated.
IsDeleted	Boolean	True		Boolean indicating whether or not the line item is deleted. Deleted records will not be included unless you specifically request that deleted records be included.

Pseudo-Columns

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


Name	Type	Description
IncludeDeleted	String	By default, deleted records will not be returned by the API. When selecting by Id, you can include this parameter to make sure that records are returned even when they are deleted

MarketingEmails

Create and manage HubSpot Marketing Emails.

Columns


Name	Type	ReadOnly	References	Description
Id [KEY]	Long	True		The id of the email.
RssToEmailTimingRepeats	String	False		[ 'instant', 'daily', 'weekly', 'monthly' ]
RssToEmailTimingRepeatsOnMonthly	Integer	False		What day of the month should the monthly email be sent [1-31].
RssToEmailTimingRepeatsOnWeekly	Integer	False		What day of the week should the weekly email be sent [1=monday - 7=sunday].
RssToEmailTimingSummary	String	False		Descripton. Not used.
RssToEmailTimingTime	String	False		Time the email should be sent at.
Ab	Boolean	True		Whether or not the page is part of an AB test.
AbHoursToWait	Integer	False		On AB emails, if test results are inconclusive after the specified hours, variation A will be sent.
AbSampleSizeDefault	String	True		['MASTER', 'VARIANT'] if there are less than 1000 recipients, only one variation will be sent.
AbSamplingDefault	String	False		['MASTER', 'VARIANT'] if AB test results are inconclusive in the test group, choose a variation to send (resp. A or B) to the remaining contacts.
AbStatus	String	False		['MASTER', 'VARIANT'] determines if the current email is variation A or variation B.
AbSuccessMetric	String	False		[ CLICKS_BY_OPENS, CLICKS_BY_DELIVERED, OPENS_BY_DELIVERED ] metric that will be used to determine the winning variation.
AbTestId	String	False		ID shared between variation A and B
AbTestPercentage	Integer	False		The size of the test group.
AbVariation	Boolean	False		Determines whether the email is a variant or not.
AbsoluteUrl	String	False		The URL of the web version of the email.
AllEmailCampaignIds	String	False		A list of email IDs that are associated with the email.
AnalyticsPageId	String	False		The ID used to access the analytics page of the email.
AnalyticsPageType	String	True		Always 'email' for an email.
Archived	Boolean	False		Determines whether the email is archived or not.
Author	String	True		The email of the user who made the last update to the email.
AuthorAt	Datetime	True		Timestamp of the last update to the email in milliseconds.
AuthorEmail	String	True		The email of the user who made the last update to the email.
AuthorName	String	True		The name of the user who made the last update to the email.
AuthorUserId	Long	True		ID of the user who made the last update to the email.
BlogEmailType	String	False		['instant', 'daily', 'weekly', 'monthly'] the cadence for how often blog emails should be sent.
Campaign	String	False		The ID of an email's marketing campaign.
CampaignName	String	False		The name of the email's marketing campaign.
CanSpamSettingsId	Long	False		ID used to retrieve the company address, shown in the footer.
CategoryId	Integer	True		The category ID value, which is always 2 for emails (read only).
ClonedFrom	Long	True		If the email was cloned, ID of the email it was cloned from.
ContentTypeCategory	Integer	True		The category ID value, which is always 2 for emails (read only).
CreatePage	Boolean	False		Enables a web version of the email when set to true.
Created	Datetime	True		The timestamp of the email's creation, in milliseconds.
CurrentlyPublished	Boolean	False		Determines the publish status of the email.
Domain	String	True		The domain of the web version of the email. Defaults to the primary domain.
EmailBody	String	False		The main content of the email within the 'main email body' module.
EmailNote	String	False		Optional email notes, included in the details page of the email.
EmailType	String	False		Type of the email.
FeedbackEmailCategory	String	False		[ 'NPS', 'CES', 'CUSTOM' ] If the email is a feedback email, determines type of feedback email.
FeedbackSurveyId	Long	False		The id of the feedback survey that is linked to the email.
FolderId	Long	False		If the email is in a folder, id of that folder.
FreezeDate	Datetime	False		The publish date or updated date if the email is not published.
FromName	String	False		The sender name recipients will see (linked to the replyTo address).
HtmlTitle	String	False		The page title of the web version of the email.
IsGraymailSuppressionEnabled	Boolean	False		If true, the email will not send to unengaged contacts.
IsLocalTimezoneSend	Boolean	False		If true, the email will adjust its send time relative to the recipients timezone.
IsPublished	Boolean	False		If true, the email is in a published state.
LiveDomain	String	True		Domain actually used in the web version (read only)
MailingListsExcluded	String	True		A list of all contact lists to exclude from the email send.
MailingListsIncluded	String	True		A list of all contact lists included in the email send.
MaxRssEntries	Long	False		In blog and recurring emails, the max number of entries to include.
MetaDescription	String	False		Meta description of the web version of the email, to drive search engine traffic to your page
Name	String	False		The name of the email, as displayed on the email dashboard.
PageExpiryDate	Datetime	False		The expiration date of the web version of an email, in milliseconds.
PageExpiryRedirectId	Long	False		The url of the page the user will be redirected to after the web version of the email expires.
PageRedirected	Boolean	False		Indicates if the email's web version has already been set to redirect
PortalId	Long	False		The id of the parent portal.
PreviewKey	String	False		The preview key used to generate the preview url before the email is published
ProcessingStatus	String	False		The email's processing status.
PublishDate	Datetime	False		The timestamp in milliseconds that the email has been published at, or scheduled to send at.
PublishImmediately	Boolean	False		True if the email is not scheduled but will send at publish time.
PublishedAt	Datetime	True		If the email has been published, the time when the publish button has been pressed.
PublishedById	Long	True		If the email has been published, email of the user that pressed the publish button.
PublishedByName	String	True		If the email has been published, name of the user that pressed the publish button.
PublishedUrl	String	True		AbsoluteUrl, only if the email is currentlyPublished
ReplyTo	String	False		The email address the recipient will see and reply to.
ResolvedDomain	String	True		The domain used in the web version: either the primary one or the one set in the domain field.
RssEmailAuthorLineTemplate	String	False		Text shown before the 'author_line' tag in blog and RSS email's items.
RssEmailBlogImageMaxWidth	Integer	False		The max width for blog post images in RSS emails.
RssEmailByText	String	False		If rssEmailAuthorLineTemplate is not set, word before the author name in blog and RSS email's items.
RssEmailClickThroughText	String	False		Text shown on the link to see the full post in blog and RSS email's items.
RssEmailCommentText	String	False		Text shown on the link to comment the post in blog and RSS email's items.
RssEmailEntryTemplate	String	False		Optional, custom template for every RSS entry.
RssEmailEntryTemplateEnabled	Boolean	False		Determines if the Entry Template is used for an RSS email.
RssEmailUrl	String	False		URL used for social sharing.
Slug	String	False		Path of the web version URL.
Subcategory	String	False		Subcategory.
Subject	String	False		The subject of the email.
Subscription	Long	False		The id of the email's subscription type.
SubscriptionBlogId	Long	False		For blog emails, id of the linked blog.
SubscriptionName	String	False		The name of the email's subscription type.
TemplatePath	String	False		The path of the email's body template within the design manager.
Transactional	Boolean	True		Determines whether the email is a transactional email or not.
UnpublishedAt	Datetime	False		The timestamp in milliseconds of when the email was unpublished.
Updated	Datetime	True		Timestamp of the last update in milliseconds.
UpdatedById	Long	True		The ID of the last user who updated the email.
Url	String	True		The web version URL
UseRssHeadlineAsSubject	Boolean	False		Setting for RSS emails, uses the latest RSS entry as the email subject.
Widgets	String	True		The content of layout sections of the email (widgets).
VidsExcluded	String	True		A list of contact IDs to exclude from being sent the email.
VidsIncluded	String	True		A list of contacts IDs to include in the email send.
WorkflowNames	String	True		A list of all linked workflows to this email.

ProductProperties

Get all of the properties for the product object type, along with the property definitions.

Columns


Name	Type	ReadOnly	References	Description
Name [KEY]	String	False		The name of the ticket property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		The human readable label for the ticket property that will display in the HubSpot UI.
FieldType	String	False		The type of field that will display on the screen for the company property. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox
Type	String	False		The stored machine type for the company property. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False		The group the company property is a part of.
Description	String	False		A description of what the property is for.
DisplayMode	String	False		How the property will be displayed.
DisplayOrder	Integer	False		The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False		Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False		Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False		Boolean indicating if the property is calculated.
IsHidden	Boolean	False		Boolean indicating if the property is hidden.
IsFavorited	Boolean	False		Boolean indicating if the property is favorited.
FavoritedOrder	Integer	False		The favorited order for this property.
MutableDefinitionNotDeletable	Boolean	False		Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False		Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False		An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Products

Query the available products in HubSpot.

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 internal ID for this product.
Name	String	False		The name of the product.
Sku	String	False		The SKU of the product.
Price	String	False		The price of the product.
Description	String	False		The description of the product.
Version	Integer	True		The current version of the product. This is incremented each time the product is updated.
IsDeleted	Boolean	False		Boolean indicating whether or not the product is deleted. Deleted records will not be included unless you specifically request that deleted records be included.

Pseudo-Columns

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


Name	Type	Description
IncludeDeleted	String	By default, deleted records will not be returned by the API. When selecting by Id, you can include this parameter to make sure that records are returned even when they are deleted

SocialMediaMessages

Create and manage HubSpot social media messages.

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		The Id of the social media message.
ContentBody	String	False		The body of the content for the message.
ContentOriginalBody	String	False		The original body of the content for the message if it has been altered.
ContentPhotoUrl	String	False		The photo associatedwith the message.
ContentUncompressedLinks	String	False		Any uncompressed links associated with the message.
TriggerAt	Datetime	False		When to trigger the social media message.
Channel	String	True		The social media channel the message will be posted to.
ChannelGUID	String	False		The social media channel GUID.
CampaignGUID	String	True		The campaign GUID associated with the social media message.
CampaignName	String	True		The campaign name associated with the social media message.
Clicks	Long	True		The number of clicks HubSpot has recorded for the links in the social media message.
ClientTag	String	True		Client tags associated with the social media message.
CreatedAt	Datetime	True		When the social media message was created.
CreatedBy	Long	True		An integer indicating which user created the social mdia message.
FinishedAt	Datetime	True		When the social media message was finished posting.
ForeignId	String	True		An optional ForeignId associated with the social media message.
GroupGUID	String	True		The group GUID associated with the social media message.
IsFailed	Boolean	True		A boolean indicating if the message has failed to post.
IsPending	Boolean	True		A boolean indicating if the message is pending a post.
IsPublished	Boolean	True		A boolean indicating if the message has been posted.
IsRetry	Boolean	True		A boolean indicating if the message is being retried.
Message	String	True		The message that came back from the social media site if any. This may contain an error message if the social media message failed if the status is ERROR_FATAL.
MessageUrl	String	True		A url associated with the message that came back from the social media site. This may simply be a link to the social media posting if the status is SUCCESS.
RemoteContentId	String	True		A remote content id if any.
RemoteContentType	String	True		The remote content type if any.
Status	String	True		The current status of the social media message. 使用できる値は次のとおりです。SUCCESS, WAITING, CANCELED, ERROR_FATAL
UpdatedBy	Long	True		An integer indicating who last updated the social media message.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

TicketProperties

Get all of the properties for the ticket object type, along with the property definitions.

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		The name of the ticket property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
Label	String	False		The human readable label for the ticket property that will display in the HubSpot UI.
FieldType	String	False		The type of field that will display on the screen for the company property. 使用できる値は次のとおりです。textarea, select, text, date, file, number, radio, checkbox
Type	String	False		The stored machine type for the company property. 使用できる値は次のとおりです。string, number, bool, datetime, enumeration
GroupName	String	False		The group the company property is a part of.
Description	String	False		A description of what the property is for.
DisplayMode	String	False		How the property will be displayed.
DisplayOrder	Integer	False		The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Boolean	False		Boolean indicating if there are external options associate with the company property.
IsFormField	Boolean	False		Boolean indicating if the property is a field that is part of a form.
IsCalculated	Boolean	False		Boolean indicating if the property is calculated.
IsHidden	Boolean	False		Boolean indicating if the property is hidden.
IsFavorited	Boolean	False		Boolean indicating if the property is favorited.
FavoritedOrder	Integer	False		The favorited order for this property.
MutableDefinitionNotDeletable	Boolean	False		Boolean indicating if the property can be modified but not deleted.
ReadOnlyDefinition	Boolean	False		Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Boolean	False		Boolean indicating if the value of the property is read only.
OptionsAggregate	String	False		An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

TicketPropertyGroups

Get all of the property groups for the specified Ticket object type.

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 name of the contact property group.
DisplayName	String	False		The display name of the contact group.
DisplayOrder	Integer	False		The numerical order of the contact group with respect to other contact groups.
IsHubspotDefined	Boolean	True		Indicator whether or not this field is defined in the Hubspot.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Tickets

Get all tickets from a portal.

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 internal ID for this ticket.
PortalId	Long	False		The Portal or Hub ID that this object belongs to.
Version	Long	False		Version of the ticket.
IsDeleted	Boolean	False		Whether or not the ticket is deleted. Deleted records will not be included unless you specifically request that deleted records be included.

Workflows

Select and manage HubSpot workflows.

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		The Id of the workflow.
Name	String	False		The name of the workflow.
Description	String	False		A description of the workflow.
IsEnabled	Boolean	False		A boolean indicating if this workflow is enabled.
CreatedAt	Datetime	True		When the workflow was created.
UpdatedAt	Datetime	True		When the workflow was last updated.
AllowContactToTriggerMultipleTimes	Boolean	False		A boolean indicating if the workflow can be triggered for the same contact multiple times.
CanEnrollFromSalesforce	Boolean	False		A boolean indicating if contacts can be enrolled to this workflow from Salesforce.
IsInternal	Boolean	False		A boolean indicating if the workflow is internal.
LegacyCampaignId	Long	False		The campaign id associated with the workflow if available.
LegacyMigration	Boolean	False		A boolean indicating if the workflow was migrated from the legacy lead nurturing tool.
IsListening	Boolean	False		A boolean indicating if the workflow is listening or active.
ContactListIdsCompleted	Long	True		The number of contacts that have been completed.
ContactListIdsEnrolled	Long	True		The number of contacts that have been enrolled.
ContactListIdsFailed	Long	True		The number of contacts that have failed in the workflow.
ContactListIdsSucceeded	Long	True		The number of contacts that have successfully completed the workflow.
NurtureTimeRangeEnabled	Boolean	False		A boolean indicating if this workflow is enabled for a nurture time range.
NurtureTimeRangeStartHour	Integer	False		The hour of day nurturing begins for this workflow.
NurtureTimeRangeStopHour	Integer	False		The hour of day nurturing ends for this workflow.
OnlyExecOnBizDays	Boolean	False		A boolean indicating if this workflow should only execute on standard business days.
StepsAggregate	String	False		An aggregate of the steps to take when executing this workflow.
SupresssionSettingsAggregate	String	False		An aggregate of supression properties for this workflow.
TriggerSetsAggregate	String	False		An aggregate of trigger sets for this workflow.
TriggersAggregate	String	False		An aggregate of triggers for this workflow.
UnenrollmentSettingType	String	False		The type of unenrollment setting for this workflow.
UnenrollmentSettingExcludedWorkflowsAggregate	String	False		An workflows to exclude a contact from if they enroll in this workflow.
GoalListAggregate	String	False		An aggregate of goal ids for this workflow.
ExtraUrlParameters	String	True		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

ビュー

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

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

HubSpot Connector for CData Sync ビュー


Name	Description
AnalyticsBreakdowns	Get analytics data broken down by the specified category.
AnalyticsContents	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.
AnalyticsEventCompletions	Get analytics data for event completion objects.
AnalyticsForms	Get analytics data for form objects.
AnalyticsSessions	Get analytics data broken down by sessions.
AnalyticsSocialAssists	Get analytics data for social assist objects.
AnalyticsViews	Get the details for the analytics views set up in the portal.
BlogAuthors	Retrieve the available blog authors in HubSpot.
BlogPosts	Retrieve the available blog posts in HubSpot.
Blogs	Retrieve the available blogs in HubSpot.
BlogTopics	Retrieve the available blog topics in HubSpot.
Comments	Retrieve the available comments from your blog in HubSpot.
CompanyPropertiesHistory	A list of the historical values of the property.
ContactFormSubmissions	List of Contact's Form Submissions.
ContactIdentityProfiles	List of Contact's Identity profiles
ContactListMemberships	Returns the list memberships of contacts in HubSpot.
ContactPropertiesHistory	A list of the historical values of the property.
ContactStatistics	Basic contact statistics that can be retrieved from HubSpot such as the total number and when the last new contact was created.
DealPipelines	Deal pipelines may be used to organize what stages a given deal is on.
DealPipelineStages	The stages for a given Deal Pipeline.
DealPropertiesHistory	A list of the historical values of the property.
DealStages	The stages for a given Deal.
Domains	Retrieve the available domains in HubSpot.
EcommerceSyncErrors	Get errors from previously processed sync messages.
EmailCampaignEvents	The events associated with an email campaign or a recipient.
EmailCampaigns	Email campaigns in HubSpot allow you to keep track of email marketing campaigns.
EmailSubscriptionTypes	A list of email subscription types for a HubSpot hub.
EngagementScheduledTasks	List of tasks scheduled for an engagement.
EngagementsScheduledTasks	List of tasks scheduled for an engagement.
Events	Returns all of the event definitions in a given portal.
Files	Retrieves information about the available files in HubSpot.
Folders	Retrieves information about the available folders in HubSpot.
FormFields	Get fields of HubSpot Forms.
FormSubmissions	Get the submissions for the specified form.
Owners	Retrieve the owners in HubSpot.
Pages	Retrieve the available pages in HubSpot.
SocialMediaChannels	List available social media channels in HubSpot
Templates	Retrieve the available templates in HubSpot.
UrlMappings	Retrieve the available url mappings in HubSpot.

AnalyticsBreakdowns

Get analytics data broken down by the specified category.

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		Data will be the totals rolled up.
Sources	String		Data broken down by traffic source.
Geolocation	String		Data broken down by geographic location.
UtmCampaigns	String		Data broken down by the standard UTM campaigns parameter.
UtmContents	String		Data broken down by the standard UTM contents parameter.
UtmMediums	String		Data broken down by the standard UTM mediums parameter.
UtmSources	String		Data broken down by the standard UTM sources parameter.
UtmTerms	String		Data broken down by the standard UTM terms parameterpages.
FirstDrilldown	String		Used to drilldown into the data. This parameter is designed to reflect the functionality of the HubSpot sources reports.
SecondDrilldown	String		Used to further drill down into the data. Similar to FirstDrilldown, this reflects the functionality of the sources report.
BounceRate	Double		The rate of bounces.
ContactToCustomerRate	Double		The rate of contacts to customers.
Contacts	Long		The number of generated contacts.
Customers	Long		The number of generated customers.
Leads	Long		The number of leads.
MarketingQualifiedLeads	Long		The number of leads which are more likely to become customers.
NewVisitorSessionRate	Double		The session rate for new visitors.
Opportunities	Long		The number of opportunitites.
PageviewsPerSession	Double		The ratio of page views over sessions.
RawViews	Long		The number of raw views.
SalesQualifiedLeads	Long		The number of prospective customers that are considered ready for the sales process.
SessionToContactRate	Double		The ratio of sessions over generated contacts.
Subscribers	Long		The number of subscribers.
TimePerSession	Double		The time per session.
Visitors	Long		The number of visitors.
Visits	Long		The number of visits.
BreakdownDate	Date		The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.

Pseudo-Columns

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


Name	Type	Description
StartDate	Date		The beginning value of the query range.
EndDate	Date		The ending value of the query range.
Granularity	String		The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String		Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String		The ID of an Analytics view. If included, the returned data will only include data that matches the view.

AnalyticsContents

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.

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		Pull data for landing pages.
StandardPages	String		Pull data for website pages.
BlogPosts	String		Pull data for individual posts.
ListingPages	String		Pull data for blog listing pages.
KnowledgeArticles	String		Pull data for knowledge base articles.
AllPages	String		Get data for all URLs with data collected by HubSpot tracking code. The results are broken down by URL.
Contacts	Long		The total number of new contacts generated.
ContactsPerPageview	Double		The ratio of contacts to raw views.
CtaViews	Long		The number of CallsToAction views.
Entrances	Long		The number of entrances.
Exits	Long		The number of exits.
ExitsPerPageview	Double		The ratio of exits over page views.
Leads	Long		The number of leads.
PageBounceRate	Double		The rate of page bounces.
PageBounces	Long		The number of page bounces.
PageTime	Long		The time spent on page.
RawViews	Long		The number of raw views.
Submissions	Long		The number of submissions.
SubmissionsPerPageview	Double		The ratio of submissions over page views.
TimePerPageview	Double		The ratio of time over page views.
BreakdownDate	Date		The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.

Pseudo-Columns

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


Name	Type	Description
StartDate	Date		The beginning value of the query range.
EndDate	Date		The ending value of the query range.
Granularity	String		The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String		Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String		The ID of an Analytics view. If included, the returned data will only include data that matches the view.

AnalyticsEventCompletions

Get analytics data for event completion objects.

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		Analytics data for event completions.
Completions	Long		The number of event completions.
BreakdownDate	Date		The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.

Pseudo-Columns

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


Name	Type	Description
StartDate	Date		The beginning value of the query range.
EndDate	Date		The ending value of the query range.
Granularity	String		The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String		Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String		The ID of an Analytics view. If included, the returned data will only include data that matches the view.

AnalyticsForms

Get analytics data for form objects.

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		Analytics data for forms.
Completions	Long		The number of completions.
FormViews	Long		The number of times the form has been viewed.
Installs	Long		The number of installs.
Interactions	Long		The number of interactions.
Submissions	Long		The number of submissions.
Visibles	Long		The number of times the form has been visible.
BreakdownDate	Date		The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.

Pseudo-Columns

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


Name	Type	Description
StartDate	Date		The beginning value of the query range.
EndDate	Date		The ending value of the query range.
Granularity	String		The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String		Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String		The ID of an Analytics view. If included, the returned data will only include data that matches the view.

AnalyticsSessions

Get analytics data broken down by 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		Analytics data for sessions.
Desktop	Long		Desktop sessions.
DirectTraffic	Long		Direct sessions.
EmailMarketing	Long		Email marketing sessions.
Mobile	Long		Mobile sessions.
OrganicSearch	Long		Organic search sessions.
OtherCampaigns	Long		Other campaigns sessions.
Others	Long		Other sessions.
PaidSearch	Long		Paid search sessions.
PaidSocial	Long		Paid social sessions.
Referrals	Long		Referrals sessions.
SocialMedia	Long		Social media sessions.
FirstDrilldown	String		Used to drilldown into the data. This parameter is designed to reflect the functionality of the HubSpot sources reports.
SecondDrilldown	String		Used to further drill down into the data. Similar to FirstDrilldown, this reflects the functionality of the sources report.
BreakdownDate	Date		The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.

Pseudo-Columns

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


Name	Type	Description
StartDate	Date		The beginning value of the query range.
EndDate	Date		The ending value of the query range.
Granularity	String		The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String		Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String		The ID of an Analytics view. If included, the returned data will only include data that matches the view.

AnalyticsSocialAssists

Get analytics data for social assist objects.

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		Analytics data for social assists.
RawViews	Long		The number of raw views.
BreakdownDate	Date		The start date of the time period for which the breakdown data are grouped. This column is applicable only for Granularity types: daily, weekly, monthly, summarize/daily, summarize/weekly and summarize/monthly.

Pseudo-Columns

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


Name	Type	Description
StartDate	Date		The beginning value of the query range.
EndDate	Date		The ending value of the query range.
Granularity	String		The time period used to group the data. Must be one of: total, daily, weekly, monthly, summarize/daily, summarize/weekly, summarize/monthly.
Filter	String		Filter the returned data to include only the specified breakdown. This parameter can be included multiple times to filter for multiple breakdowns.
Exclude	String		Exclude data for the specified breakdown. This parameter can be included multiple times to exclude multiple breakdowns.
FilterId	String		The ID of an Analytics view. If included, the returned data will only include data that matches the view.

AnalyticsViews

Get the details for the analytics views set up in the portal.

Columns


Name	Type	References	Description
Id [KEY]	Long		Id of the analytic view.
Title	String		Title of the analytic view.
CreatorId	Long		Id of the creator.
CreatedAt	Date		Date of the creation.
UpdaterId	Long		Id of the updater.
UpdatedDate	Date		Date of the update.
DeletedAt	Date		Date of the deletion.
ContainsLegacyReportProperties	Boolean		Determines if the view contains legacy report properties.
ReportPropertyFiltersAggregate	String		Report property filters of the analytic view.

BlogAuthors

Retrieve the available blog authors in HubSpot.

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		The id of the author.
FullName	String		The first and last name of the blog author.
CreatedAt	Datetime		When the blog author was first created.
Slug	String		The path appended to the blog URL at which the author page will live.
DeletedAt	Datetime		When the author was deleted.
Email	String		The email address of the blog author.
FacebookProfile	String		The blog author's Facebook page.
GooglePlusProfile	String		The blog author's Google Plus profile.
LinkedInProfile	String		The blog author's LinkedIn profile
TwitterProfile	String		The blog author's twitter handle.
AvatarUrl	String		A small photo or image of the blog author.
UserId	Long		The HubSpot user id of the blog author.
Username	String		The HubSpot username of the blog author.
Website	String		The blog author's web site.
UpdatedAt	Datetime		When the blog author was last updated.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

BlogPosts

Retrieve the available blog posts in HubSpot.

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		The id of the blog post.
AuthorUserId	Long		The HubSpot user id of the blog author.
AuthorName	String		The HubSpot username of the blog author.
BlogAuthorId	Long	BlogAuthors.Id	The integer id of the blog author, look up via the blog authors end.
CampaignId	String	EmailCampaigns.Id	The guid of the marketing campaign this post is associated with.
ContentGroupId	Long		The id of the blog that this post belongs to. Get the id by looking at the blog API.
TopicIds	String		The individual topics the post is associated with.
CreatedAt	Datetime		When the post was first created.
ArchivedAt	Datetime		When the post was deleted.
ArchivedInDashboard	Boolean		If True, the post will not show up in your dashboard, although the post will still be live.
Name	String		The internal name of the blog post.
Slug	String		The path of the URL on which the post will live.
UpdatedAt	Datetime		When the post was last updated.
PublishedAt	Datetime		When the post was published.
PostSummary	String		The summary of the blog post that will appear on the main listing page.
PostBody	String		The HTML of the main post body.
Url	String		The full URL with domain and scheme to the blog post. Will return a 404 if the post is not yet published.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Blogs

Retrieve the available blogs in HubSpot.

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		The id of the blog.
Name	String		The internal name of the blog.
AllowComments	Boolean		Are comments enabled for the blog.
CommentShouldCreateContact	Boolean		Boolean indicating if an email address that is not listed in your HubSpot contacts creates a comment, should this user be automatically added to your HubSpot contacts.
CreatedAt	Datetime		When the post was first created.
HTMLTitle	String		The title in the title attribute of the page, shows up in the browsers title bar and as the title in Google search results.
Language	String		The language of the blog.
PostsPerListingPage	Long		The number of posts listed per page in the HTML viewable blog.
PostsPerRSSFeed	Long		The number of posts listed per page in the RSS feed for the blog.
PublicTitle	String		The header of the blog.
RootURL	String		The full URL with domain and scheme to the blog post.
ShowSocialLinkFacebook	Boolean		Boolean indicating if a social link for Facebook should be displayed on the blog.
ShowSocialLinkGoogle	Boolean		Boolean indicating if a social link for Google Plus should be displayed on the blog.
ShowSocialLinkLinkedIn	Boolean		Boolean indicating if a social link for LinkedIn should be displayed on the blog.
ShowSocialLinkTwitter	Boolean		Boolean indicating if a social link for Twitter should be displayed on the blog.
Slug	String		The path of the URL on which the post will live.
UpdatedAt	Datetime		When the post was last updated.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

BlogTopics

Retrieve the available blog topics in HubSpot.

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		The blog topic id.
CreatedAt	Datetime		When the topic was created
DeletedAt	Datetime		When the topic was deleted.
Description	String		A description of the topic.
Name	String		The name of the topic.
Slug	String		How the topic will appear in the url.
UpdatedAt	Datetime		When the topic was last updated.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Comments

Retrieve the available comments from your blog in HubSpot.

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		The id of the comment.
State	String		The current state of the comment. 使用できる値は次のとおりです。APPROVED, SPAM, REJECTED, PENDING_MODERATION
PostId	Long	BlogPosts.Id	The id of the parent blog post.
Comment	String		The full text of the comment.
CommentAuthorEmail	String		Email address of the user submitting the comment.
CommentAuthorName	String		Name of the user submitting the comment.
ContentPermalink	String		A permanent link for the parent post of the comment.
ContentTitle	String		The title of the parent post for the comment.
CreatedAt	Datetime		When the comment was made.
DeletedAt	Datetime		When the comment was deleted.
FirstName	String		The first name of the user who made the comment.
LastName	String		The last name of the user who made the comment.
UserEmail	String		Email address of the user submitting the comment.
UserUrl	String		A url to the user's website if available.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

CompanyPropertiesHistory

A list of the historical values of the property.

Columns


Name	Type	References	Description
PropertyName	String		The name of the contact property.
Value	String		The historical value of the property.
Timestamp	Datetime		Datetime when the property was updated
Source	String		The method by which the property was changed
SourceId	String		Additional data realted to the source-type. May not be populated for all source-types.
SourceVid	String
CompanyId	String		The Id of the Company that the property belongs to.

ContactFormSubmissions

List of Contact's Form Submissions.

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	The unique id of the task.
FormId	String	Forms.GUID	The GUID of the form that the subission belongs to.
ConversionId	String		A Unique ID for the specific form conversion.
PortalId	Long		The Portal ID (Hub ID) that the submission belongs to
Timestamp	Datetime		The time the submission occurred.
Title	String		The title of the page that the form was submitted on.
PageId	Long	Pages.Id	Id of the page that the form was submitted on.
PageTitle	String		Title of the page that the form was submitted on.
PageURL	String		The URL that the form was submitted on.

ContactIdentityProfiles

List of Contact's Identity profiles

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	The unique id for the contact.
Type	String		The type of the identity, one of EMAIL or LEAD_GUID.
Value	String		The value of the identity.
Timestamp	Datetime		Time when the identity was created.
SavedAt	Datetime		Time when the identity was last updated.

ContactListMemberships

Returns the list memberships of contacts in HubSpot.

Columns


Name	Type	References	Description
VID [KEY]	Long	Contacts.VID	The id of the contact on the list.
ListId [KEY]	Long	ContactLists.ListId	The static id of the list.
Email	String		The static id of the list.
TimeAddedToList	Datetime		The datetime when the contact was added to the list.

ContactPropertiesHistory

A list of the historical values of the property.

Columns


Name	Type	References	Description
VID	Long	Contacts.VID	The unique id for the contact.
PropertyName	String		The name of the contact property.
Value	String		The historical value of the property.
Timestamp	Datetime		Datetime when the property was updated
SourceType	String		The method by which the property was changed
SourceId	String		Additional data realted to the source-type. May not be populated for all source-types.
SourceLabel	String		Additional data realted to the source-type. May not be populated for all source-types.

ContactStatistics

Basic contact statistics that can be retrieved from HubSpot such as the total number and when the last new contact was created.

Columns


Name	Type	References	Description
LastNewContactAt	String		A datetime detailing when the last new contact was added.
Contacts	String		The total number of contacts.

DealPipelines

Deal pipelines may be used to organize what stages a given deal is on.

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		The id of the pipeline.
PipelineName	String		The name of the pipeline.
IsActive	Boolean		A boolean indicating if the pipeline is active or not.
StagesAggregate	String		The stages in the pipeline.

DealPipelineStages

The stages for a given Deal Pipeline.

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	The id of the pipeline.
StageId [KEY]	String		The id of the stage.
PipelineName	String		The name of the pipeline.
PipelineIsActive	Boolean		A boolean indicating if the pipeline is active or not.
StageName	String		The name of the stage.
StageIsActive	Boolean		A boolean indicating if the stage is active or not.
StageClosedWon	Boolean		A boolean indicating if the stage indicates that the deal was closed and won.
StageDisplayOrder	Integer		The display order of the stage in the deal.
StageProbability	Double		The estimated probability of closing the deal at this stage.

DealPropertiesHistory

A list of the historical values of the property.

Columns


Name	Type	References	Description
SourceId	String		Additional data realted to the source-type. May not be populated for all source-types.
SourceVid	String		A list of vids for related contacts. Only populated if related contacts caused the value to change.
PropertyName	String		The name of the deal property.
Value	String		The historical value of the property.
Timestamp	Datetime		Datetime when the property was updated
Source	String		The method by which the property was changed
DealId	Long		The Deal Id of the property.

DealStages

The stages for a given Deal.

Columns


Name	Type	References	Description
DealId [KEY]	Long	Deals.DealId	The id of the deal.
StageCreated [KEY]	Datetime		When the deal stage was created.
StageName	String		The name of the deal stage.
StageValue	String		The value of the deal stage.
StageSource	String		The source of the deal stage.
StageSourceId	String		The source id of the deal stage.

Domains

Retrieve the available domains in HubSpot.

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		The id of the domain.
CreatedAt	Datetime		When the domain was first created.
Domain	String		The actual domain or subdomain.
IsAnyPrimary	Boolean		True if this domain is primary for any category.
IsDNSCorrect	Boolean		True if DNS for this domain is optimally configured for use with HubSpot.
IsLegacyDomain	Boolean		True is this domain is setup for use with the classic CMS.
IsResolving	Boolean		True if this domain is pointing to HubSpot servers.
ManuallyMarkedAsResolving	Boolean		True if a user manually marked this domain as resolving. This is needed when their is some unique setup or proxy server involved, and the COS can not automatically detect if the domain is properly resolving.
PrimaryBlogPost	Boolean		True if this domain is primary for COS blog posts.
PrimaryEmail	Boolean		True if this domain is primary for viewing emails as web page.
PrimaryLandingPage	Boolean		True if this domain is primary for COS landing pages.
PrimaryLegacyPage	Boolean		True if this domain is primary for the classic CMS.
PrimarySitePage	Boolean		True if this domain is primary for COS site pages.
SecondaryToDomain	String		The name of the domain that this domain redirects to. Only set for non-primary domains.
UpdatedAt	Datetime		When the domain was last updated.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

EcommerceSyncErrors

Get errors from previously processed sync messages.

Table Specific Information

Because sync messages are processed asynchronously, problems with processing are not surfaced at the time of submission. Instead, you can use the sync errors endpoint to retrieve all errors related to the processing of ecommerce data.

SELECT

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

SELECT * FROM EcommerceSyncErrors

SELECT * FROM EcommerceSyncErrors WHERE AppId = '123456'

Columns


Name	Type	References	Description
PortalId	Long		The Id of the portal for this sync error.
ObjectType	String		The specific object type.
IntegratorObjectId	String		The ID, from your system, of the object that is being created or updated.
ChangeOccurredTimestamp	Datetime		The timestamp of the last change occurred.
ErrorTimestamp	Datetime		The timestamp of the error when occurred.
Type	String		The type of the error which classifies the error.
Details	String		Detailed description of the error.
Status	String		Status of the sync error.
AppId	String		The app ID in which the error occurred.

EmailCampaignEvents

The events associated with an email campaign or a recipient.

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		The Id of the email campaign event.
CampaignId	String	EmailCampaigns.Id	Campaign id of the email campaign associated with the event.
Type	String		The type of event. 使用できる値は次のとおりです。SENT, DROPPED, PROCESSED, DELIVERED, DEFERRED, BOUNCE, OPEN, CLICK, PRINT, FORWARD, STATUSCHANGE, SPAMREPORT
RecipientEmail	String		Email address of the recipient associated with the event.
PortalId	Long		An ID referencing the HubSpot account that sent the email message. This will correspond to your account.
AppId	Long		An Id referencing the HubSpot Application which sent the email message.
AppName	String		The name of the HubSpot Application which sent the email message. Note that this is a derived value, and may be modified at any time.
CreatedAt	Datetime		When this event was created.
SentById	String		The Event Id which uniquely identifies the email message's SENT event.
SentByCreatedAt	Datetime		When the email message's SENT event. wich created.
ObsoletedById	String		The EventId which uniquely identifies the follow-on event which makes this current event obsolete.
ObsoletedByCreatedAt	Datetime		When the event which obsoleted the current event was created.
CausedById	String		The EventId which uniquely identifies the event which directly caused this event.
CausedByCreatedAt	Datetime		When the event which caused the current event was created.
Subject	String		The subject line of the email message.
From	String		The 'from' field of the email message.
ReplyTo	String		The 'reply-to' field of the email message.
Cc	String		The 'cc' field of the email message.
Bcc	String		The 'bcc' field of the email message.
DropReason	String		The reason 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		The raw message describing why the email message was dropped. This will usually provide additional details beyond 'dropReason'.
Category	String		The best-guess of the type of bounce encountered. If an appropriate category couldn't be determined, this property is omitted. 使用できる値は次のとおりです。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		The full response from the recipient's email server.
SmtpId	String		An ID attached to the message by HubSpot.
Attempt	Integer		The delivery attempt number.
Status	String		The status code returned from the recipient's email server.
DeviceType	String		The type of device used that triggered the event if avialable.
HMID	String		A randomly-generated Id which corresponds to the header 'X-HubSpot-MID' in the email message.
Referer	String		The URL of the webpage that linked to the URL clicked. Whether this is provided, and what its value is, is determined by the recipient's email client.
Url	String		The URL within the message that the recipient clicked.
UserAgent	String		The user agent responsible for the event.
BrowserFamily	String		The family of the browser that serviced the event.
BrowserName	String		The name of browser that serviced the event.
BrowserProducer	String		The producer of browser that serviced the event.
BrowserProducerUrl	String		A url to the producer of the browser if available.
BrowserType	String		The type of browser that produced the event.
BrowserUrl	String		A url to an entry describing the browser if available.
BrowserVersion	String		The versionof browser used.
LocationCity	String		The city where the event occurred.
LocationCountry	String		The country where the event occurred.
LocationState	String		The state where the event occurred.
FilteredEvent	Boolean		A boolean representing whether the event has been filtered out of reporting based on customer reports settings or not.
Source	String		The source of the subscription change. 使用できる値は次のとおりです。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		The email address of the person requesting the change on behalf of the recipient.
Subscriptions	String		The status of subscriptions for the recipient.
PortalSubscriptionStatus	String		The recipient's portal subscription status. 使用できる値は次のとおりです。SUBSCRIBED, UNSUBSCRIBED
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

EmailCampaigns

Email campaigns in HubSpot allow you to keep track of email marketing campaigns.

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		The Id of the email campaign.
AppName	String		The name of the app associated with the email campaign.
AppId	Long		The Id of the app associated with the email campaign.
LastUpdatedTime	Datetime		When the email campaign was lasted updated.
Name	String		The name of the campaign.
ContentId	Long		The ContentId of the email campaign.
NumberBounced	Long		The number bounced.
NumberClick	Long		The number of clicks.
NumberDeferred	Long		The number deferred.
NumberDelivered	Long		The number delivered.
NumberDropped	Long		The number dropped.
NumberIncluded	Long		The number included.
NumberMTADropped	Long		The number mta dropped.
NumberOpen	Long		The number open.
NumberProcessed	Long		The number processed.
NumberQueued	Long		The number queued.
NumberSent	Long		The number sent.
NumberStatusChanged	Long		The number where the status was changed.
NumberUnsubscribed	Long		The number unsubscribed.
ProcessingState	String		The processing state of the email campaign.
Type	String		The type of email campaign.
SubType	String		The subtype of the email campaign.
Subject	String		The subject of the email campaign.
LastProcessingStartedAt	Datetime		Last date the email campaign last began processing at.
LastProcessingFinishedAt	Datetime		When the email campaign last finished processing at.
LastProcessingStateChangeAt	Datetime		The last time the email campaign's processing state changed.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

EmailSubscriptionTypes

A list of email subscription types for a HubSpot hub.

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		The Id of the email subscription type.
Name	String		The name of the email subscription type.
IsActive	Boolean		Whether or not the email subscription type is active.
Description	String		A description for the email subscription type.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

EngagementScheduledTasks

List of tasks scheduled for an engagement.

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		The id of the engagement.
UUID	String		The scheduled task's uniqe Id.
PortalId	Long		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.

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.

Events

Returns all of the event definitions in a given portal.

Columns


Name	Type	References	Description
Id [KEY]	String		The unique id for the event.
Name	String		The name of the evemt.
Label	String		The label of the evemt.
Status	String		The status of the evemt.

Files

Retrieves information about the available files in HubSpot.

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		The unique id of the file.
Name	String		The internal name of the file.
FriendlyUrl	String		A full url to the file that can be used from a web browser to view or download the file.
AltKey	String		An alternative file key. This is used for creationg the 'alt_url', which is a url for the file that does not include the file id. This is useful if you need to upload a collection of files where their relative location needs to preserved.
AltUrl	String		The alternative file URL, without the auto-generated file id in it. This is generated by concatenating the alt_key to the base CDN url.
IsArchived	Boolean		If True, the file will not show up in your dashboard, although the file will still be live.
CreatedAt	Datetime		When the file was first created.
DeletedAt	Datetime		When the file was deleted.
Extension	String		The extension of the file.
FolderId	Long	Folders.Id	The id of the folder this file is in.
RSUploadedAt	Datetime		When the file was uploaded via RS.
S3UploadedAt	Datetime		When the file was uploaded via S3.
Size	Long		The size in bytes of the file.
IsSynced	Boolean		A boolean indicating if this is a CTA image.
Title	String		The title of the file.
Type	String		A string enum for type of the file. 使用できる値は次のとおりです。IMG, TEXT, DOCUMENT, OTHER
UpdatedAt	Datetime		When the file was last updated.
Version	Double		The version of the file.
Height	Integer		For images only, the height in pixels of the image.
Width	Integer		For images only, the width in pixels of the image.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Folders

Retrieves information about the available folders in HubSpot.

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		The id of the folder.
Category	Integer		The category of the folder.
CreatedAt	Datetime		When the folder was created.
DeletedAt	Datetime		When the folder was deleted.
FullPath	String		The full path to the folder.
Name	String		The name of the folder.
ParentFolderId	Long	Folders.Id	The id of the parent folder for this folder if available.
UpdatedAt	Datetime		When the folder was last updated.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

FormFields

Get fields of HubSpot Forms.

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		The unique key for the form.
Name	String		The name of the field.
DefaultValue	String		The default value of the field.
Required	Boolean		Boolean indicating wether the field is required in the form.
Enabled	Boolean		Boolean indicating wether the field is enabled.
IsSmartField	Boolean		Boolean indicating wether this is a smart field.
Label	String		Label of the field.
GroupName	String		Name of the group the field belongs to.
SelectedOptions	String		The selected options for the field.
FieldType	String		Type of the field.
Hidden	Boolean		Boolean indicating wether the field is hidden.
Validation	String
Type	String		Value type of the field.
Options	String		Field options
DisplayOrder	Int		Display order of the field

FormSubmissions

Get the submissions for the specified form.

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		The unique key for the form.
PageUrl	String		Url of the page.
SubmittedAt	Datetime		Submitted time.
Name	String		Name of the submission.
Value	String		Value of the submission.

Owners

Retrieve the owners in HubSpot.

Columns


Name	Type	References	Description
OwnerId [KEY]	Long		The id of the owner.
PortalId	Long		The portal id the owner is associated with.
Type	String		The type of user.
FirstName	String		The first name of the owner.
LastName	String		The last name of the owner.
Email	String		The email address for the owner.
CreatedAt	Datetime		The when the owner was created.
UpdatedAt	Datetime		The when the owner was last updated.
RemoteListAggregate	String		Remote list information for the owner.
IncludeInactive	Boolean		If specified as true, include inactive owners.

Pages

Retrieve the available pages in HubSpot.

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		The id of the page.
ArchivedInDashboard	Boolean		If True, the page will not show up in your dashboard, although the page will still be live.
CampaignId	String	EmailCampaigns.Id	The guid of the marketing campaign this page is associated with.
CampaignName	String	EmailCampaigns.Name	The name of the marketing campaign this page is associated with.
CreatedAt	Datetime		When the page was created.
CurrentLiveDomain	String		The domain this page is currently located on.
ArchivedAt	Datetime		When the page was deleted
FooterHTML	String		Custom HTML for embed codes, javascript that should be placed before the body tag of the page
HeaderHTML	String		Custom HTML for embed codes, javascript, etc. that goes in the head tag of the page
IsDraft	Boolean		True if the post is still a draft, invisible to the public. Gets changed when the /publish-action API endpoint is called.
MetaDescription	String		A description that goes in meta tag on the page
MetaKeywords	String		Keywords for the meta tag.
Name	String		The internal name of the page.
Password	String		Set this to create a password protected page. Entering the password will be required to view the page.
PublishDate	Datetime		The date the page is to be published at in milliseconds since the unix epoch.
Slug	String		The path of the URL on which the page will live. Changing this will change the URL.
StyleOverrideId	String		The ID of the style to use for this page, set this to use a different style than the default style for the site.
Subcategory	String		This is set to empty or to
UpdatedAt	Datetime		When the page was last updated.
Url	String		The full URL with domain and scheme to the page. Will return a 404 if the page is not yet published.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

SocialMediaChannels

List available social media channels in HubSpot

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		The social media channel GUID.
AccountGUID	String		The account GUID associated with the social media channel.
AccountSlug	String		The account slug.
AccountType	String		The type of account.
IsActive	Boolean		A boolean indicating if the channel is active.
AutoPublish	Boolean		A boolean indicating if messages should be automatically published to the channel.
AvatarUrl	String		A url to the avatar for your account on the social medial channel.
ChannelId	String		The id for the channel on the social media site.
ChannelKey	String		A HubSpot key associated with the channel.
ChannelSlug	String		The slug associated with the channel.
CreatedAt	Datetime		When the channel was created.
FollowMe	Boolean		A boolean indicating if the channel should be followed.
IsHidden	Boolean		A boolean indicating if the channel is hidden.
Monitoring	Boolean		A boolean indicating if the channel should be monitored.
Reach	Boolean		A boolean indicating if tracking the growth of followers on this account over time should be enabled.
ReachType	String		The type of reach for this social media channel.
IsShared	Boolean		A boolean indicating if this social media channel is shared.
Type	String		The type of social media channel.
UpdatedAt	Datetime		When this social media channel was last updated.
UserName	String		The user name for the social media channel.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

Templates

Retrieve the available templates in HubSpot.

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		The id of the template.
CategoryId	Long		The category of content this template can be used for. 1 for landing page, 2 for email, 3 for site page.
CDNMinifiedUrl	String		For javascript and css, this is the URL of the version of the content that has been rendered, minified, and uploaded to our Content Delivery Network.
CDNUrl	String		For non-html templates, the URL to the version of the template that has been rendered and uploaded to the HubSpot CDN.
DeletedAt	Datetime		When the template was deleted.
Folder	String		The folder this template lives in.
GeneratedFromLayoutId	String		The id of the layout that generated this template.
IsAvailableForNewContent	Boolean		True if this template will show up in the content creation screen.
IsFromLayout	Boolean		True if template was generated by publishing a layout.
IsReadOnly	Boolean		True if the template can only be read.
Label	String		The label of the template as it shows up in the template builder.
Path	String		The path of the template, as should be used for HubL include statements.
Source	String		The markup of the template.
ThumbnailPath	String		The thumbnail image of the template.
UpdatedAt	Datetime		When the template was last updated.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

UrlMappings

Retrieve the available url mappings in HubSpot.

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 id of the url mapping.
CreatedAt	Datetime		When the url mapping was created.
DeletedAt	Datetime		When the url mapping was deleted.
Destination	String		The URL to redirect to.
IsMatchFullUrl	Boolean		If true, the 'route_prefix' should match on the entire URL including the domain.
IsMatchQueryString	Boolean		If true, the 'route_prefix' should match on the entire URL path including the query string.
IsOnlyAfterNotFound	Boolean		If True, the URL mapping will only be applied if a live page matching the URL is not found. If False, the URL mapping will take precedence over any existing page.
Precedence	Integer		If a URL matches more than one mapping, the one with the lower precedence applies.
RoutePrefix	String		The incoming URL to match.
UpdatedAt	Datetime		When the url mapping was last updated.
ExtraUrlParameters	String		An input only property for specifying additional parameters when selecting data from HubSpot. Specify the parameters as name=value pairs in a comma separated list. For instance, 'param1=value1,param2=value2,param3=value3'.

HubSpot V3 データモデル

CData Sync App は、HubSpot CRM API v3 オブジェクトをリレーショナルテーブル、ビュー、およびストアドプロシージャにモデル化します。このセクションでは、API の制限および要件について説明します。既定の SupportEnhancedSQL 機能を使って、これらの制限の大半を回避できます。

テーブル

テーブル 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, add new associated records and remove existing ones.

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

ストアドプロシージャ

ストアドプロシージャは、データソースのファンクションライクなインターフェースです。これらを使用して、データソース内の情報を検索、更新、および変更できます。

CRM API V3 の改善（V1 およびV2 との比較）

最も重要なテーブルのフィルタリング機能。次の演算子がサポートされています：=、!=、>、<、<=、>=。
Filtering using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them.
最も重要なテーブルのソート機能。API によるソートがサポートされているのは1カラムのみです。
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 の制限

PageSize を100より大きくすることはできません。
フィルタリングは、返される行数が10,000 より小さい場合にのみ使用可能です。クエリに対して返される行がさらにある場合は、すべての行が先に取得され、Sync App によってフィルタリングが適用されます。
フィルタリングリクエストまたはソートリクエストのいずれかを発行する場合、1秒あたり1リクエストまで許可されます。
いくつかのカラム（"CreatedAt" や"UpdatedAt" など）はフィルタをサポートしていません。
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.

テーブル

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

HubSpot Connector for CData Sync テーブル


Name	Description
CallProperties	Retrieve the available Quote properties in HubSpot.
CommunicationProperties	Retrieve the available Communications properties in HubSpot.
Companies	Retrieve the available Companies in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
CompanyAssociations	Retrieve the IDs of all the objects associated to specific Companies objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
CompanyPipelines	Pipelines of companies in HubSpot.
CompanyPipelineStages	Pipeline stages of companies in HubSpot.
ContactAssociations	Retrieve the IDs of all the objects associated to specific Contacts objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
ContactPipelines	Pipelines of contacts in HubSpot.
ContactPipelineStages	Pipeline stages of deals in HubSpot.
Contacts	Retrieve the available Contacts in HubSpot. his table supports both OAuth and PrivateAppToken authentications.
ContactsToDealsAssociations	Retrieve the IDs of all the Deals objects associated to specific Contacts objects in HubSpot. his table supports both OAuth and PrivateAppToken authentications.
CustomObjectAssociations	Retrieve and manage associations between Custom object types in HubSpot.
DealAssociations	Retrieve the IDs of all the objects associated to specific Deals objects in HubSpot. his table supports both OAuth and PrivateAppToken authentications.
DealPipelines	Pipelines of deals in HubSpot.
DealPipelineStages	Pipeline stages of deals in HubSpot.
Deals	Retrieve the available Deals in HubSpot. his table supports both OAuth and PrivateAppToken authentications.
EmailProperties	Retrieve the available Quote properties in HubSpot.
EngagementsCalls	Retrieve the available Calls in HubSpot.
EngagementsEmails	Retrieve the available Emails in HubSpot.
EngagementsMeetings	Retrieve the available Meetings in HubSpot.
EngagementsNotes	Retrieve the available Notes in HubSpot.
EngagementsTasks	Retrieve the available Tasks in HubSpot.
FeedbackSubmissionAssociations	Retrieve the IDs of all the objects associated to specific Feedbacksubmissions objects in HubSpot.
FeedbackSubmissionProperties	Retrieve the available Quote properties in HubSpot.
Feedbacksubmissions	Retrieve the available Feedbacksubmissions in HubSpot.
Forms	Retrieve HubSpot forms used to collect lead information about your visitors and contacts.
LineitemAssociations	Retrieve the IDs of all the objects associated to specific Lineitems objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
LineItemProperties	Retrieve the available Quote properties in HubSpot.
Lineitems	Retrieve the available Lineitems in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
MeetingProperties	Retrieve the available Quote properties in HubSpot.
NoteProperties	Retrieve the available Quote properties in HubSpot.
PostalEmailProperties	Retrieve the available PostalEmails properties in HubSpot.
ProductProperties	Retrieve the available Quote properties in HubSpot.
Products	Retrieve the available Products in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
QuoteAssociations	Retrieve the IDs of all the objects associated to specific Quotes objects in HubSpot. table supports only PrivateAppToken authentication.
Quotes	Retrieve the available Quotes in HubSpot. This table supports only PrivateAppToken authentication.
TaskProperties	Retrieve the available Quote properties in HubSpot.
Threads	Retrieve the available Threads in a Conversation in HubSpot.
TicketAssociations	Retrieve the IDs of all the objects associated to specific Tickets objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
TicketPipelines	Discover pipelines that a ticket goes through in HubSpot.
TicketPipelineStages	Pipeline stages of tickets in HubSpot.
Tickets	Retrieve the available Tickets in HubSpot. This table supports both OAuth and PrivateAppToken authentications.

CallProperties

Retrieve the available Quote properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

CommunicationProperties

Retrieve the available Communications properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

Companies

Retrieve the available Companies in HubSpot. This table supports both OAuth and PrivateAppToken authentications.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 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}
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	False		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.
About Us	String	False		True	Short about_company
ClosedateTimestampEarliestValueA2a17e6e	Datetime	True		True	Calculation context property providing timestamp for rollup property closedate calculated as EARLIEST_VALUE via values of closedate on object type ObjectTypeId_legacyObjectType_CONTACT_
Facebook Fans	Decimal	False		True	Number of facebook fans
FirstContactCreatedateTimestampEarliestValue78b50eea	Datetime	True		True	Calculation context property providing timestamp for rollup property first_contact_createdate calculated as EARLIEST_VALUE via values of createdate on object type ObjectTypeId_legacyObjectType_CONTACT_
First Conversion Date	Datetime	True		True	The first conversion date across all contacts associated this company or organization
FirstConversionDateTimestampEarliestValue61f58f2c	Datetime	True		True	Calculation context property providing timestamp for rollup property first_conversion_date calculated as EARLIEST_VALUE via values of first_conversion_date on object type ObjectTypeId_legacyObjectType_CONTACT_
First Conversion	String	True		True	The first form submitted across all contacts associated this company or organization
FirstConversionEventNameTimestampEarliestValue68ddae0a	Datetime	True		True	Calculation context property providing timestamp for rollup property first_conversion_event_name calculated as EARLIEST_VALUE via values of first_conversion_event_name on object type ObjectTypeId_legacyObjectType_CONTACT_
First Deal Created Date	Datetime	True		True	Date the first deal was associated with this company record.
Year Founded	String	False		True	The year the company was created. Powered by HubSpot Insights.
Additional Domains	String	False		True	Additional domains belonging to this company
Business units	String	False		True	The business units this record is assigned to.
Time First Seen	Datetime	True		True	The first activity for any contact associated with this company or organization
HsAnalyticsFirstTimestampTimestampEarliestValue11e3a63a	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_first_timestamp calculated as EARLIEST_VALUE via values of hs_analytics_first_timestamp on object type ObjectTypeId_legacyObjectType_CONTACT_
First Touch Converting Campaign	String	True		True	The campaign responsible for the first touch creation of the first contact associated with this company
HsAnalyticsFirstTouchConvertingCampaignTimestampEarliestValue4757fe10	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_first_touch_converting_campaign calculated as EARLIEST_VALUE via values of hs_analytics_first_touch_converting_campaign on object type ObjectTypeId_legacyObjectType_CONTACT_
Time of First Session	Datetime	True		True	Time of first session across all contacts associated with this company or organization
HsAnalyticsFirstVisitTimestampTimestampEarliestValueAccc17ae	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_first_visit_timestamp calculated as EARLIEST_VALUE via values of hs_analytics_first_visit_timestamp on object type ObjectTypeId_legacyObjectType_CONTACT_
Time Last Seen	Datetime	True		True	Time last seen across all contacts associated with this company or organization
HsAnalyticsLastTimestampTimestampLatestValue4e16365a	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_last_timestamp calculated as LATEST_VALUE via values of hs_analytics_last_timestamp on object type ObjectTypeId_legacyObjectType_CONTACT_
Last Touch Converting Campaign	String	True		True	The campaign responsible for the last touch creation of the first contact associated with this company
HsAnalyticsLastTouchConvertingCampaignTimestampLatestValue81a64e30	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_last_touch_converting_campaign calculated as LATEST_VALUE via values of hs_analytics_last_touch_converting_campaign on object type ObjectTypeId_legacyObjectType_CONTACT_
Time of Last Session	Datetime	True		True	Time of the last session attributed to any contacts that are associated with this company record.
HsAnalyticsLastVisitTimestampTimestampLatestValue999a0fce	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_last_visit_timestamp calculated as LATEST_VALUE via values of hs_analytics_last_visit_timestamp on object type ObjectTypeId_legacyObjectType_CONTACT_
Latest Source	String	True		True	Source of the last session attributed to any contacts that are associated with this company
Latest Source Data 1	String	True		True	Additional source details of the last session attributed to any contacts that are associated with this company
Latest Source Data 2	String	True		True	Additional source details of the last session attributed to any contacts that are associated with this company
Latest Source Timestamp	Datetime	True		True	Timestamp of when latest source occurred
Number of Pageviews	Decimal	True		True	Total number of page views across all contacts associated with this company or organization
HsAnalyticsNumPageViewsCardinalitySumE46e85b0	Decimal	True		True	Calculation context property providing cardinality for rollup property hs_analytics_num_page_views calculated as SUM via values of hs_analytics_num_page_views on object type ObjectTypeId_legacyObjectType_CONTACT_
Number of Sessions	Decimal	True		True	Total number of sessions across all contacts associated with this company or organization
HsAnalyticsNumVisitsCardinalitySum53d952a6	Decimal	True		True	Calculation context property providing cardinality for rollup property hs_analytics_num_visits calculated as SUM via values of hs_analytics_num_visits on object type ObjectTypeId_legacyObjectType_CONTACT_
Original Source Type	String	False		True	Original source for the contact with the earliest activity for this company or organization
Original Source Data 1	String	True		True	Additional information about the original source for the contact with the earliest activity for this company or organization
HsAnalyticsSourceData1TimestampEarliestValue9b2f1fa1	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_source_data_1 calculated as EARLIEST_VALUE via values of hs_analytics_source_data_1 on object type ObjectTypeId_legacyObjectType_CONTACT_
Original Source Data 2	String	True		True	Additional information about the original source for the contact with the earliest activity for this company or organization
HsAnalyticsSourceData2TimestampEarliestValue9b2f9400	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_source_data_2 calculated as EARLIEST_VALUE via values of hs_analytics_source_data_2 on object type ObjectTypeId_legacyObjectType_CONTACT_
HsAnalyticsSourceTimestampEarliestValue25a3a52c	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_source calculated as EARLIEST_VALUE via values of hs_analytics_source on object type ObjectTypeId_legacyObjectType_CONTACT_
Avatar FileManager key	String	True		True	The path in the FileManager CDN for this company's avatar override image. Automatically set by HubSpot.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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 'Customer _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Evangelist _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Opportunity _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Other _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Subscriber _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Customer _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Evangelist _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Opportunity _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Other _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Subscriber _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Ideal Customer Profile Tier	String	False		True	How well this company matches your Ideal Customer Profile. Tier 1 means a great fit for your products_services_ Tier 3 might be acceptable_ but low priority.
Target Account	Bool	False		True	Identifies whether this company is being marketed and sold to as part of your account_based strategy.
Last Booked Meeting Date	Datetime	True		True	The last date of booked meetings associated with the company
Last Logged Call Date	Datetime	True		True	The last date of logged calls associated with the company
Last Open Task Date	Datetime	True		True	The last due date of open tasks associated with the company
last sales activity date old	Datetime	True		True	The date of the last sales activity with the company in seconds.
Last Engagement Date	Datetime	True		True	The last time a contact engaged with your site or a form_ document_ meetings link_ or tracked email. This doesn't include marketing emails or emails to multiple contacts.
Last Engagement Type	String	True		True	The type of the last engagement a company performed. This doesn't include marketing emails or emails to multiple contacts.
Last Modified Date	Datetime	True		True	Most recent timestamp of any property update for this company. This includes HubSpot internal properties_ which can be visible or hidden. This property is updated automatically.
Latest create date of active subscriptions	Datetime	True		True	Latest created date of all associated active Subscriptions
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Number of blockers	Decimal	True		True	The number of contacts associated with this company with the role of blocker.
Number of contacts with a buying role	Decimal	True		True	The number of contacts associated with this company with a buying role.
Number of decision makers	Decimal	True		True	The number of contacts associated with this company with the role of decision maker.
Number of open deals	Decimal	True		True	The number of open deals associated with this company.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Pinned Engagement ID	Decimal	True		True	The object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified.
Pipeline	String	False		True	The pipeline with which this company is currently associated
Likelihood to close	Decimal	True		True	The highest probability that a contact associated with this company will become a customer within the next 90 days. This score is based on standard contact properties and behavior.
HsPredictivecontactscoreV2NextMaxMaxD4e58c1e	Decimal	True		True	Calculation context property providing next_max for rollup property hs_predictivecontactscore_v2 calculated as MAX via values of hs_predictivecontactscore_v2 on object type ObjectTypeId_legacyObjectType_CONTACT_
Read Only Object	Bool	True		True	Is the object read only
Target Account2	String	False		True	The Target Account property is a means to flag high priority companies if you are following an account based strategy
Target Account Probability	Decimal	True		True	The probability a company is marked as a target account
Target Account Recommendation Snooze Time	Datetime	False		True	The date when the target account recommendation is snoozed.
Target Account Recommendation State	String	False		True	The state of the target account recommendation
Time in 'Customer _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Evangelist _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Opportunity _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Other _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Subscriber _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Total open deal value	Decimal	True		True	The total value_ in your company's currency_ of all open deals associated with this company
Unique creation key	String	True		True	Unique property used for idempotent creates
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this company
Is Public	Bool	False		True	Indicates if the company is publicly traded. Powered by HubSpot Insights.
Number of Associated Contacts	Decimal	True		True	The number of contacts associated with this company
Number of Associated Deals	Decimal	True		True	The number of deals associated with this company
Number of Form Submissions	Decimal	True		True	The number of forms submission for all contacts associated with this company or organization
NumConversionEventsCardinalitySumD095f14b	Decimal	True		True	Calculation context property providing cardinality for rollup property num_conversion_events calculated as SUM via values of num_conversion_events on object type ObjectTypeId_legacyObjectType_CONTACT_
Recent Conversion Date	Datetime	True		True	The most recent conversion date across all contacts associated this company or organization
RecentConversionDateTimestampLatestValue72856da1	Datetime	True		True	Calculation context property providing timestamp for rollup property recent_conversion_date calculated as LATEST_VALUE via values of recent_conversion_date on object type ObjectTypeId_legacyObjectType_CONTACT_
Recent Conversion	String	True		True	The last form submitted across all contacts associated this company or organization
RecentConversionEventNameTimestampLatestValue66c820bf	Datetime	True		True	Calculation context property providing timestamp for rollup property recent_conversion_event_name calculated as LATEST_VALUE via values of recent_conversion_event_name on object type ObjectTypeId_legacyObjectType_CONTACT_
Recent Deal Amount	Decimal	True		True	The amount of the last deal closed
Recent Deal Close Date	Datetime	True		True	Date of the last
Time Zone	String	False		True	Time zone where the company or organization is located. Powered by HubSpot Insights.
Total Money Raised	String	False		True	The total amount of money raised by the company. Powered by HubSpot Insights.
Total Revenue	Decimal	True		True	The total amount of closed won deals
Company name	String	False		True	The name of the company or organization. Powered by HubSpot Insights.
HubSpot Owner Email	String	False		True	HubSpot owner email for this company or organization
Twitter Handle	String	False		True	The main twitter account of the company or organization
HubSpot Owner Name	String	False		True	HubSpot owner name for this company or organization
Phone Number	String	False		True	Company primary phone number. Powered by HubSpot Insights.
Twitter Bio	String	False		True	The Twitter bio of the company or organization
Twitter Followers	Decimal	False		True	The number of Twitter followers of the company or organization
Street Address	String	False		True	Street address of the company or organization_ including unit number. Powered by HubSpot Insights.
Street Address 2	String	False		True	Additional address of the company or organization. Powered by HubSpot Insights.
Facebook Company Page	String	False		True	The URL of the Facebook company page for the company or organization
City	String	False		True	City where the company is located. Powered by HubSpot Insights.
LinkedIn Company Page	String	False		True	The URL of the LinkedIn company page for the company or organization
LinkedIn Bio	String	False		True	The LinkedIn bio for the company or organization
State_Region	String	False		True	State or region in which the company or organization is located. Powered by HubSpot Insights.
Google Plus Page	String	False		True	The URL of the Google Plus page for the company or organization
Date of last meeting booked in meetings tool	Datetime	True		True	Last Meeting Booked for any contact associated with this Company_Organization.
Campaign of last booking in meetings tool	String	True		True	This UTM parameter shows which marketing campaign _e.g. a specific email_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Medium of last booking in meetings tool	String	True		True	This UTM parameter shows which channel _e.g. email_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Source of last booking in meetings tool	String	True		True	This UTM parameter shows which site _e.g. Twitter_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Latest meeting activity	Datetime	True		True	The date of the most recent meeting _past or upcoming_ logged for_ scheduled with_ or booked by a contact associated with this company.
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to by this company
Company owner	String	False		True	The owner of the company
Last Contacted	Datetime	True		True	Timestamp of the last call_ email_ or meeting that was logged for a contact at this company.
Last Activity Date	Datetime	True		True	The last time a note_ call_ meeting_ or task was logged for a company. This is set automatically by HubSpot based on user actions in the company record.
Next Activity Date	Datetime	True		True	Date of the next upcoming scheduled sales activity for this company record.
Number of times contacted	Decimal	True		True	The number of times a call_ email or meeting was logged for this company
Number of Sales Activities	Decimal	True		True	Number of sales activities for this company. For example_ a call_ email or meeting logged.
Postal Code	String	False		True	Postal or zip code of the company or organization. Powered by HubSpot Insights.
Country_Region	String	False		True	Country in which the company or organization is located. Powered by HubSpot Insights.
HubSpot Team	String	True		True	The team of the owner of the company.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
Website URL	String	False		True	The main website of the company or organization. This property is used to identify unique companies. Powered by HubSpot Insights.
Company Domain Name	String	False		True	The domain name of the company or organization
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom
Number of Employees	Decimal	False		True	The total number of employees who work for the company or organization. Powered by HubSpot Insights.
Industry	String	False		True	The type of business the company performs. By default_ this property has approximately 150 pre_defined options to select from. While these options cannot be deleted as they used by HubSpot Insights_ you can add new custom options to meet your needs.
Annual Revenue	Decimal	False		True	The actual or estimated annual revenue of the company. Powered by HubSpot Insights.
Lifecycle Stage	String	False		True	The most advanced lifecycle stage across all contacts associated with this company or organization
Lead Status	String	False		True	The company's sales_ prospecting or outreach status
Parent Company	Decimal	True		True	The parent company of this company
Type	String	False		True	The optional classification of this company record _ prospect_ partner_ etc.
Description	String	False		True	A short statement about the company's mission and goals. Powered by HubSpot Insights.
Number of child companies	Decimal	True		True	The number of child companies of this company
HubSpot Score	Decimal	True		True	The sales and marketing score for the company or organization
Create Date	Datetime	True		True	The date the company or organization was added to the database
Close Date	Datetime	False		True	The date the company or organization was closed as a customer
First Contact Create Date	Datetime	True		True	The date that the first contact from this company entered the system_ which could pre_date the company's create date
Days to Close	Decimal	True		True	The number of days between when the company record was created and when they closed as a customer.
Web Technologies	String	False		True	The web technologies used by the company or organization. Powered by HubSpot Insights.

CompanyAssociations

Retrieve the IDs of all the objects associated to specific Companies objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Companies.Id	False	Companies ID
AssociationId [KEY]	Long	False		False	ID of the object that this Companies 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	AssociationsTypes.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
TypeName [KEY]	String	True	AssociationsTypes.Type	False	The name of the association type for the specified object pair. This column is empty for more specific associations queries.

CompanyPipelines

Pipelines of companies in HubSpot.

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 CompanyPipelineStages table.

CompanyPipelineStages

Pipeline stages of companies in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	False		False	Unique identifier of the stage in the pipeline.
PipelineId [KEY]	String	False	CompanyPipelines.Id	False	Unique identifier of the pipeline.
Label	String	False		False	Label _name_ of the pipeline stage.
PipelineLabel	String	True	CompanyPipelines.Label	False	The label _name_ of the pipeline.
IsClosed	Bool	False		False	Whether this stage is open or closed.
Probability	Decimal	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.

ContactAssociations

Retrieve the IDs of all the objects associated to specific Contacts objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.

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

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')

DELETE

To delete an existing association between a Contacts record and a Deals one, you need to specify the Id-s of the two associated records and the associated deal object Type. Note for custom objects, you will need to specify the FullyQualifiedName as the Type.

DELETE [ContactAssociations] WHERE Id = '3432' AND AssociationId = '34654' AND Type = 'Deal'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Contacts.Id	False	Contacts ID
AssociationId [KEY]	Long	False		False	ID of the object that this Contacts 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	AssociationsTypes.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
TypeName [KEY]	String	True	AssociationsTypes.Type	False	The name of the association type for the specified object pair. This column is empty for more specific associations queries.

ContactPipelines

Pipelines of contacts in HubSpot.

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 ContactPipelineStages table.

ContactPipelineStages

Pipeline stages of deals in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	False		False	Unique identifier of the stage in the pipeline.
PipelineId [KEY]	String	False	ContactPipelines.Id	False	Unique identifier of the pipeline.
Label	String	False		False	Label _name_ of the pipeline stage.
PipelineLabel	String	True	ContactPipelines.Label	False	The label _name_ of the pipeline.
IsClosed	Bool	False		False	Whether this stage is open or closed.
Probability	Decimal	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.

Contacts

Retrieve the available Contacts in HubSpot. his table supports both OAuth and PrivateAppToken authentications.

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, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them. For example:

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

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 Contacts WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Contacts WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Contacts WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Contacts 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 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 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.
Company size	String	False		True	Contact's company size. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Date of birth	String	False		True	Contact's date of birth. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Days To Close	Decimal	True		True	Count of days elapsed between creation and being closed as a customer. Set automatically.
Degree	String	False		True	Contact's degree. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Field of study	String	False		True	Contact's field of study. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
First Conversion Date	Datetime	True		True	Date this contact first submitted a form.
First Conversion	String	True		True	First form this contact submitted.
First Deal Created Date	Datetime	True		True	Date first deal was created for contact. Set automatically.
Gender	String	False		True	Contact's gender. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Graduation date	String	False		True	Contact's graduation date. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Additional email addresses	String	True		True	A set of additional email addresses for a contact
Business units	String	False		True	The business units this record is assigned to.
All vids for a contact	String	True		True	A set of all vids_ canonical or otherwise_ for a contact
First Touch Converting Campaign	String	True		True	Campaign responsible for the first touch creation of this contact.
Last Touch Converting Campaign	String	True		True	Campaign responsible for the last touch creation of this contact.
Avatar FileManager key	String	True		True	The path in the FileManager CDN for this contact's avatar override image. Automatically set by HubSpot.
Buying Role	String	False		True	Role the contact plays during the sales process. Contacts can have multiple roles_ and can share roles with others.
All form submissions for a contact	String	True		True	A set of all form submissions for a contact
Merged vids with timestamps of a contact	String	True		True	Merged vids with timestamps of a contact
Calculated Mobile Number in International Format	String	True		True	Mobile number in international format
Calculated Phone Number in International Format	String	True		True	Phone number in international format
Calculated Phone Number Area Code	String	True		True	Area Code of the calculated phone number
Calculated Phone Number Country Code	String	True		True	Country code of the calculated phone number
Calculated Phone Number Region	String	True		True	ISO2 Country code for the derived phone number
Clicked on a LinkedIn Ad	String	False		True	Whether contact has clicked on a LinkedIn Ad
Email Confirmed	Bool	True		True	Email Confirmation status of user of Content Membership
Registration Follow Up Email Enqueued At	Datetime	False		True	The time when the first registration follow up email was enqueued
Membership Notes	String	False		True	Notes relating to the contact's content membership.
Registered At	Datetime	True		True	Datetime at which this user was set up for Content Membership
Domain to which registration email was sent	String	True		True	Domain to which the registration invitation email for Content Membership was sent to
Time registration email was sent	Datetime	True		True	Datetime at which this user was sent a registration invitation email for Content Membership
Status	String	False		True	Status of the contact's content membership.
Conversations visitor email	String	True		True	A Conversations visitor's email address
Count of unengaged contacts	Decimal	True		True	if contact is assigned and unworked_ set to 1. if contact is assigned and worked_ set to 0.
Count of engaged contacts	Decimal	True		True	if contact is assigned and worked_ set to 1. if contact is assigned and unworked_ set to 0.
Created By Conversations	Bool	True		True	Flag indicating this contact was created by the Conversations API
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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 'Customer _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Evangelist _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Opportunity _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Other _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Subscriber _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Customer _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Evangelist _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Opportunity _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Other _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Subscriber _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Recent Document Revisit Date	Datetime	True		True	The last time a shared document _presentation_ was accessed by this contact
Invalid email address	Bool	True		True	The email address associated with this contact is invalid.
Email address quarantine reason	String	False		True	The reason why the email address has been quarantined.
Email Domain	String	True		True	A contact's email address domain
Email hard bounce reason	String	True		True	The issue that caused a contact to hard bounce from your emails. If this is an error or a temporary issue_ you can unbounce this contact from the contact record.
Email hard bounce reason2	String	True		True	The issue that caused a contact to hard bounce from your emails. If this is an error or a temporary issue_ you can unbounce this contact from the contact record.
Email Address Quarantined	Bool	True		True	Indicates that the current email address has been quarantined for anti_abuse reasons and any marketing email sends to it will be blocked. This is automatically set by HubSpot.
Email address automated quarantine reason	String	True		True	The automated reason why the email address has been quarantined.
Email Address Recipient Fatigue Next Available Sending Time	Datetime	True		True	When this recipient has reached the limit of email sends per time period_ this property indicates the next available time to send. This is automatically set by HubSpot.
Sends Since Last Engagement	Decimal	True		True	The number of marketing emails that have been sent to the current email address since the last engagement _open or link click_. This is automatically set by HubSpot.
Marketing email confirmation status	String	True		True	The status of a contact's eligibility to receive marketing email. This is automatically set by HubSpot.
Clicked Facebook ad	Bool	False		True	Whether contact has clicked a Facebook ad
Facebook click id	String	False		True
Facebook ID	String	False		True	A contact's facebook id
Last NPS survey comment	String	True		True	Last NPS survey comment that this contact gave
Last NPS survey rating	String	True		True	Last NPS survey rating that this contact gave
Last NPS survey date	Datetime	True		True	The time that this contact last submitted a NPS survey response. This is automatically set by HubSpot.
Should be shown an NPS web survey	Bool	False		True	Whether or not a contact should be shown an NPS web survey. This is automatically set by HubSpot.
ID of first engagement	Decimal	True		True	The object id of the current contact owner's first engagement with the contact. Used in Sales Analytics app.
First subscription create date	Datetime	True		True	The create date of the first subscription by the contact.
Google ad click id	String	False		True
googleplus ID	String	False		True	A contact's googleplus id
Contact has an active subscription	Decimal	True		True	The rollup property value is 1 when the contact has an active Subscription or 0 otherwise.
IP Timezone	String	True		True	The timezone reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
Is a contact	Bool	True		True	Is a contact_ has not been deleted and is not a visitor
Contact unworked	Bool	True		True	Contact has not been assigned or has not been engaged after last owner assignment_re_assignment
last sales activity date old	Datetime	True		True	The date of the last sales activity with the contact. This property is set automatically by HubSpot. Note_ This field is only updated for contacts with an owner.
Last Engagement Date	Datetime	True		True	The last time a contact engaged with your site or a form_ document_ meetings link_ or tracked email. This doesn't include marketing emails or emails to multiple contacts.
Last Engagement Type	String	True		True	The type of the last engagement a contact performed. This doesn't include marketing emails or emails to multiple contacts.
Object last modified date_time	Datetime	True		True	Most recent timestamp of any property update for this contact. This includes HubSpot internal properties_ which can be visible or hidden. This property is updated automatically.
Last sequence ended date	Datetime	True		True	The last sequence ended date.
Last sequence enrolled	Decimal	True		True	The last sequence enrolled.
Last sequence enrolled date	Datetime	True		True	The last sequence enrolled date.
Last sequence finished date	Datetime	True		True	The last sequence finished date.
Last sequence unenrolled date	Datetime	True		True	The last sequence unenrolled date.
Latest Source Date	Date	False		True	The time of the latest session for a contact
Latest subscription create date	Datetime	True		True	The create date of the latest subscription by the contact.
Lead Status	String	False		True	The contact's sales_ prospecting or outreach status
Legal basis for processing contact's data	String	False		True	Legal basis for processing contact's data_ 'Not applicable' will exempt the contact from GDPR protections
Clicked LinkedIn Ad	String	False		True
Linkedin ID	String	False		True	A contact's linkedin id
Marketing contact status source name	String	True		True	The ID of the activity that set the contact as a marketing contact
Marketing contact status source type	String	True		True	The type of the activity that set the contact as a marketing contact
Marketing contact status	String	True		True	The marketing status of a contact
Marketing contact until next update	String	True		True	Specifies if this contact will be set as non_marketing on renewal
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Pinned engagement ID	Decimal	True		True
Pipeline	String	False		True	The pipeline with which this contact is currently associated
Likelihood to close	Decimal	True		True	The probability that a contact will become a customer within the next 90 days. This score is based on standard contact properties and behavior.
Contact priority	String	True		True	A ranking system of contacts evenly assigned into four tiers. Contacts in tier one are more likely to become customers than contacts in tier four.
Read Only Object	Bool	True		True	Is the object read only
Date of first engagement	Datetime	True		True	The date the current contact owner first engaged with the contact. Used in Sales Analytics app.
Description of first engagement	String	True		True	A description of the current contact owner's first engagement with the contact. Used in the Sales Analytics app.
Type of first engagement	String	True		True	The object type of the current contact owner's first engagement with the contact. Used in the Sales Analytics app.
Recent Sales Email Clicked Date	Datetime	True		True	The last time a tracked sales email was clicked by this user
Recent Sales Email Opened Date	Datetime	True		True	The last time a tracked sales email was opened by this contact. This property does not update for emails that were sent to more than one contact.
Calculated Mobile Number with country code	String	True		True	Mobile number with country code
Calculated Phone Number with country code	String	True		True	Phone number with country code
Calculated Mobile Number without country code	String	True		True	Mobile number without country code
Calculated Phone Number without country code	String	True		True	Phone number without country code
Number of sequences actively enrolled	Decimal	True		True	The number of sequences actively enrolled.
Number of sequences enrolled	Decimal	True		True	The number of sequences enrolled.
Currently in Sequence	Bool	True		True	A yes_no field that indicates whether the contact is currently in a Sequence.
testpurge	String	True		True	testing purge
testrollback	String	True		True	testing rollback
Time between contact creation and deal close	Decimal	False		True
Time between contact creation and deal creation	Decimal	False		True
Time in 'Customer _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Evangelist _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Opportunity _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Other _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Subscriber _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Lead response time	Decimal	True		True	Time it took current owner to do first qualifying engagement _ms_. Used in Sales Analytics app.
Time to move from lead to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot lead stage to the HubSpot customer stage.
Time to move from marketing qualified lead to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot marketing qualified lead stage to the HubSpot customer stage.
Time to move from opportunity to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot opportunity stage to the HubSpot customer stage.
Time to move from sales qualified lead to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot sales qualified lead stage to the HubSpot customer stage.
Time to move from subscriber to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot subscriber stage to the HubSpot customer stage.
Time Zone	String	False		True	The contact_s time zone. This can be set automatically by HubSpot based on other contact properties. It can also be set manually for each contact.
Twitter ID	String	False		True	A contact's twitter id
Unique creation key	String	True		True	Unique property used for idempotent creates
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
WhatsApp Phone Number	String	False		True	The phone number associated with the contact_s WhatsApp account.
Owner Assigned Date	Datetime	True		True	The most recent date a HubSpot Owner was assigned to a contact. This is set automatically by HubSpot and can be used for segmentation and reporting.
IP City	String	True		True	The city reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP Country	String	True		True	The country reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP Country Code	String	True		True	The country code reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP Latitude _ Longitude	String	True		True
IP State_Region	String	True		True	The state or region reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP State Code_Region Code	String	True		True	The state code or region code reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP Zipcode	String	True		True	The zipcode reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
Job function	String	False		True	Contact's job function. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Last Modified Date	Datetime	True		True	The date any property on this contact was modified
Marital Status	String	False		True	Contact's marital status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Military status	String	False		True	Contact's military status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Number of Associated Deals	Decimal	True		True	Count of deals associated with this contact. Set automatically by HubSpot.
Number of Form Submissions	Decimal	True		True	The number of forms this contact has submitted
Number of Unique Forms Submitted	Decimal	True		True	The number of different forms this contact has submitted
Recent Conversion Date	Datetime	True		True	The date this contact last submitted a form
Recent Conversion	String	True		True	The last form this contact submitted
Recent Deal Amount	Decimal	True		True	Amount of last closed won deal associated with a contact. Set automatically.
Recent Deal Close Date	Datetime	True		True	Date last deal associated with contact was closed_won. Set automatically.
Relationship Status	String	False		True	Contact's relationship status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
School	String	False		True	Contact's school. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Seniority	String	False		True	Contact's seniority. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Start date	String	False		True	Contact's start date. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Total Revenue	Decimal	True		True	Sum of all closed_won deal revenue associated with the contact. Set automatically.
Work email	String	False		True	Contact's work email. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
First Name	String	False		True	A contact's first name
First Page Seen	String	True		True	First page the contact visited on your website. Set automatically.
Marketing emails delivered	Decimal	True		True	The number of marketing emails delivered for the current email address. This is automatically set by HubSpot.
Opted out of emailCustomer Service Communication	String	True		True	Indicates that the current email address has opted out of this email type.
Opted out of emailOne to One	String	True		True	This column is a custom field. Indicates that the current email address has opted out of this email type.
Twitter Username	String	False		True	The contact's Twitter handle.
Currently in workflow	String	True		True	True when contact is enrolled in a workflow.
Follower Count	Decimal	False		True	The number of Twitter followers a contact has
Last Page Seen	String	True		True	Last page the contact visited on your website. Set automatically.
Marketing emails opened	Decimal	True		True	The number of marketing emails opened for the current email address. This is automatically set by HubSpot.
Last Name	String	False		True	A contact's last name
Number of Pageviews	Decimal	True		True	Total number of page views this contact has had on your website. Set automatically.
Marketing emails clicked	Decimal	True		True	The number of marketing emails which have had link clicks for the current email address. This is automatically set by HubSpot.
Salutation	String	False		True	The title used to address a contact
Twitter Profile Photo	String	False		True	The contact's Twitter profile photo. This is set by HubSpot using the contact's email address.
Email	String	False		True	A contact's email address
Number of Sessions	Decimal	True		True	Number of times a contact has come to your website. Set automatically.
Marketing emails bounced	Decimal	True		True	The number of marketing emails that bounced for the current email address. This is automatically set by HubSpot.
Persona	String	False		True	A contact's persona
Most Recent Social Click	Datetime	True		True	The date of the most recent click on a published social message. This is set automatically by HubSpot for each contact.
Number of event completions	Decimal	True		True	Total number of events for this contact. Set automatically.
Unsubscribed from all email	Bool	True		True	Indicates that the current email address has opted out of all email.
Twitter Clicks	Decimal	True		True	The number of times a contact clicked on links you shared on Twitter through HubSpot. This is set automatically by HubSpot and can be used for segmentation.
Mobile Phone Number	String	False		True	A contact's mobile phone number
Phone Number	String	False		True	A contact's primary phone number
Fax Number	String	False		True	A contact's primary fax number
Time First Seen	Datetime	True		True	First time the contact has been seen. Set automatically.
Last marketing email name	String	True		True	The name of the last marketing email sent to the current email address. This is automatically set by HubSpot.
Last marketing email send date	Datetime	True		True	The date of the most recent delivery for any marketing email to the current email address. This is automatically set by HubSpot.
Facebook Clicks	Decimal	True		True	The number clicks on links shared on Facebook
Street Address	String	False		True	Contact's street address_ including apartment or unit number.
Date of last meeting booked in meetings tool	Datetime	True		True	The date of the last meeting that has been scheduled by a contact through the meetings tool. If multiple meetings have been scheduled_ the date of the last chronological meeting in the timeline is shown.
Campaign of last booking in meetings tool	String	True		True	UTM parameter for marketing campaign _e.g. a specific email_ responsible for recent meeting booking. Only populated when tracking parameters are included in meeting link.
Medium of last booking in meetings tool	String	True		True	UTM parameter for the channel _e.g. email_ responsible for most recent meeting booking. Only populated when tracking parameters are included in meeting link.
Source of last booking in meetings tool	String	True		True	UTM parameter for the site _e.g. Twitter_ responsible for most recent meeting booking. Only populated when tracking parameters are included in meeting link.
Time of First Session	Datetime	True		True	First time the contact visited your website. Set automatically.
Last marketing email open date	Datetime	True		True	The date of the most recent open for any marketing email to the current email address. This is automatically set by HubSpot.
Latest meeting activity	Datetime	True		True	The date of the most recent meeting _past or upcoming_ logged for_ scheduled with_ or booked by this contact.
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to by this user. This is set automatically by HubSpot based on user actions in the contact record.
LinkedIn Clicks	Decimal	True		True	The number clicks on links shared on LinkedIn
Contact owner	String	False		True	The owner of a contact. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
Last Contacted	Datetime	True		True	The last time a call_ email_ or meeting was logged for a contact. This is set automatically by HubSpot based on user actions in the contact record.
Last Activity Date	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a contact. This is set automatically by HubSpot based on user actions in the contact record.
Next Activity Date	Datetime	True		True	The date of the next upcoming activity for a contact. This is set automatically by HubSpot based on user actions in the contact record.
Number of times contacted	Decimal	True		True	The number of times a call_ email_ or meeting was logged for a contact. This is set automatically by HubSpot based on user actions in the contact record.
Number of Sales Activities	Decimal	True		True	The number of sales activities for a contact. This is set automatically by HubSpot based on user actions in the contact record.
HubSpot Owner Email _legacy_	String	False		True	A legacy property used to identify the email address of the owner of the contact. This property is no longer in use.
HubSpot Owner Name _legacy_	String	False		True	A legacy property used to identify the name of the owner of the contact. This property is no longer in use.
SurveyMonkey Event Last Updated	Decimal	True		True	This field is meaningless on its own_ and is solely used for triggering dynamic list updates when SurveyMonkey information is updated
Webinar Event Last Updated	Decimal	True		True	This field is meaningless on its own_ and is solely used for triggering dynamic list updates when webinar information is updated
City	String	False		True	A contact's city of residence
Time Last Seen	Datetime	True		True	Timestamp for most recent webpage view on your website.
Last marketing email click date	Datetime	True		True	The date of the most recent link click for any marketing email to the current email address. This is automatically set by HubSpot.
Google Plus Clicks	Decimal	True		True	The number clicks on links shared on Google Plus
HubSpot Team	String	True		True	The team of the owner of a contact.
LinkedIn Bio	String	False		True	A contact's LinkedIn bio
Twitter Bio	String	False		True	The contact's Twitter bio. This is set by HubSpot using the contact's email address.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
Time of Last Session	Datetime	True		True	Timestamp for start of the most recent session for this contact to your website.
First marketing email send date	Datetime	True		True	The date of the earliest delivery for any marketing email to the current email address. This is automatically set by HubSpot.
Broadcast Clicks	Decimal	True		True	The number of clicks on published social messages. This is set automatically by HubSpot for each contact.
State_Region	String	False		True	The contact's state of residence. This might be set via import_ form_ or integration.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom
Original Source	String	False		True	First known source the contact used to find your website. Set automatically_ but may be updated manually.
First marketing email open date	Datetime	True		True	The date of the earliest open for any marketing email to the current email address. This is automatically set by HubSpot.
Latest Source	String	False		True	The source of the latest session for a contact
Postal Code	String	False		True	The contact's zip code. This might be set via import_ form_ or integration.
Country_Region	String	False		True	The contact's country_region of residence. This might be set via import_ form_ or integration.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom
Original Source DrillDown 1	String	True		True	Additional information about the source the contact used to find your website. Set automatically.
First marketing email click date	Datetime	True		True	The date of the earliest link click for any marketing email to the current email address. This is automatically set by HubSpot.
Latest Source DrillDown 1	String	True		True	Additional information about the latest source for the last session the contact used to find your website. Set automatically.
LinkedIn Connections	Decimal	False		True	How many LinkedIn connections they have
Original Source DrillDown 2	String	True		True	Additional information about the source the contact used to find your website. Set automatically.
Is globally ineligible	Bool	True		True	Indicates the contact is globally ineligible for email.
Preferred language	String	False		True	Set your contact's preferred language for communications. This property can be changed from an import_ form_ or integration.
Latest Source DrillDown 2	String	True		True	Additional information about the source for the last session the contact used to find your website. Set automatically.
Klout Score	Decimal	False		True	A contact's Klout score_ a measure of Internet influence
First Referring Site	String	True		True	URL that referred the contact to your website. Set automatically.
First marketing email reply date	Datetime	True		True	The date of the earliest reply for any marketing email to the current email address. This is automatically set by HubSpot.
Job Title	String	False		True	A contact's job title
Photo	String	False		True	Social Media photo
Last Referring Site	String	True		True	Last URL that referred contact to your website. Set automatically.
Last marketing email reply date	Datetime	True		True	The date of the latest reply for any marketing email to the current email address. This is automatically set by HubSpot.
Message	String	False		True	A default property to be used for any message or comments a contact may want to leave on a form.
Close Date	Datetime	False		True	Date the contact became a customer. Set automatically when a deal or opportunity is marked as closed_won. It can also be set manually or programmatically.
Average Pageviews	Decimal	True		True	Average number of pageviews per session for this contact. Set automatically.
Marketing emails replied	Decimal	True		True	The number of marketing emails replied to by the current email address. This is automatically set by HubSpot.
Event Revenue	Decimal	True		True	Set event revenue on a contact though the Enterprise Events feature. http___help.hubspot.com_articles_KCS_Article_Reports_How_do_I_create_Events_in_HubSpot
Became a Lead Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Lead. This is automatically set by HubSpot for each contact.
Became a Marketing Qualified Lead Date	Datetime	True		True	The date when a contact's lifecycle stage changed to MQL. This is automatically set by HubSpot for each contact.
Became an Opportunity Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Opportunity. This is automatically set by HubSpot for each contact.
Lifecycle Stage	String	False		True	The qualification of contacts to sales readiness. It can be set through imports_ forms_ workflows_ and manually on a per contact basis.
Became a Sales Qualified Lead Date	Datetime	True		True	The date when a contact's lifecycle stage changed to SQL. This is automatically set by HubSpot for each contact.
Create Date	Datetime	True		True	The date that a contact entered the system
Became an Evangelist Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Evangelist. This is automatically set by HubSpot for each contact.
Became a Customer Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Customer. This is automatically set by HubSpot for each contact.
HubSpot Score	Decimal	True		True	The number that shows qualification of contacts to sales readiness. It can be set in HubSpot's Lead Scoring app.
Company Name	String	False		True	Name of the contact's company. This can be set independently from the name property on the contact's associated company.
Became a Subscriber Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Subscriber. This is automatically set by HubSpot for each contact.
Became an Other Lifecycle Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Other. This is automatically set by HubSpot for each contact.
Website URL	String	False		True	Associated company website.
Number of Employees	String	False		True	The number of company employees
Annual Revenue	String	False		True	Annual company revenue
Industry	String	False		True	The Industry a contact is in
Primary Associated Company ID	Decimal	False		True	HubSpot defined ID of a contact's primary associated company in HubSpot.
Associated Company Last Updated	Decimal	True		True	This field is meaningless on its own_ and is solely used for triggering dynamic list updates when a company is updated
Lead Rating	String	True		True	The rating of this contact based on their predictive lead score
Predictive Lead Score	Decimal	True		True	A score calculated by HubSpot that represents a contact's likelihood to become a customer

ContactsToDealsAssociations

Retrieve the IDs of all the Deals objects associated to specific Contacts objects in HubSpot. his table supports both OAuth and PrivateAppToken authentications.

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

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')

DELETE

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

DELETE [ContactsToDealsAssociations] WHERE ContactsId = '3432' AND DealsId = '34654'

Columns


Name	Type	ReadOnly	References	Filterable	Description
ContactsId [KEY]	Long	False	Contacts.Id	False	Contacts ID
DealsId [KEY]	Long	False	Deals.Id	False	Deals ID
TypeId [KEY]	String	False	AssociationsTypes.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
TypeName [KEY]	String	True	AssociationsTypes.Type	False	The name of the association type for the specified object pair. This column is empty for more specific associations queries.

CustomObjectAssociations

Retrieve and manage associations between Custom object types in HubSpot.

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

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')

DELETE

To delete an association for a custom object, you will need to specify the ObjectFullyQualifiedName and the AssociationId.

DELETE [CustomObjectAssociations] WHERE Id = '330' AND ObjectFullyQualifiedName = 'p5692228_MachinesObject'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	True		False	A unique ID for this association.
ObjectFullyQualifiedName [KEY]	String	False		False	A unique ID for this schema's object type. It is defined as _meta_type___unique ID_.
ObjectTypeId	String	True		False	The ID of the custom object type.
ObjectId	String	True		False	An assigned unique ID for the object_ including portal ID and object name.
ObjectName	String	True		False	A unique name for the schema's object type.
ObjectLabelSingular	String	True		False	Singular label for the object. Used in CRM display.
ObjectLabelPlural	String	True		False	Plural label for the object. Used in CRM display.
Name	String	False		False	A unique name for this association.
Cardinality	String	False		False	The cardinality type.
InverseCardinality	String	False		False	The inverseCardinality type.
FromObjectTypeId	String	False		False	ID of the primary object type to link from.
ToObjectTypeId	String	False		False	ID of the target object type ID to link to.

DealAssociations

Retrieve the IDs of all the objects associated to specific Deals objects in HubSpot. his table supports both OAuth and PrivateAppToken authentications.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Deals.Id	False	Deals ID
AssociationId [KEY]	Long	False		False	ID of the object that this Deals 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	AssociationsTypes.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
TypeName [KEY]	String	True	AssociationsTypes.Type	False	The name of the association type for the specified object pair. This column is empty for more specific associations queries.

DealPipelines

Pipelines of deals in HubSpot.

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 DealPipelineStages table.

DealPipelineStages

Pipeline stages of deals in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	False		False	Unique identifier of the stage in the pipeline.
PipelineId [KEY]	String	False	DealPipelines.Id	False	Unique identifier of the pipeline.
Label	String	False		False	Label _name_ of the pipeline stage.
PipelineLabel	String	True	DealPipelines.Label	False	The label _name_ of the pipeline.
IsClosed	Bool	False		False	Whether this stage is open or closed.
Probability	Decimal	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.

Deals

Retrieve the available Deals in HubSpot. his table supports both OAuth and PrivateAppToken authentications.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 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}
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	False		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.
Amount in company currency	Decimal	True		True	The amount of the deal_ using the exchange rate_ in your company's currency
Days to close	Decimal	True		True	The number of days the deal took to close
Currency	String	False		True	Currency code for the deal.
Annual contract value	Decimal	True		True	The annual contract value _ACV_ of this deal.
Business units	String	False		True	The business units this record is assigned to.
Deal Collaborator	String	True		True	Owner ids of the users involved in closing the deal
Deal Split Users	String	True		True	The owner ids of all associated Deal Splits. This property is set automatically by HubSpot.
Latest Source	String	True		True	Source for the contact either directly or indirectly associated with the last session activity for this deal
Latest Source Company	String	True		True	Source for the company with an associated contact with the last session activity for this deal
Latest Source Contact	String	True		True	Source for the directly associated contact with the last session activity for this deal
Latest Source Data 1	String	True		True	Additional source details of the last session attributed to any contacts that are directly or indirectly associated with this deal
Latest Source Data 1 Company	String	True		True	Additional source details of the last session attributed to any contacts that are indirectly associated with this deal _via a company association_
Latest Source Data 1 Contact	String	True		True	Additional source details of the last session attributed to any contacts that are directly associated with this deal
Latest Source Data 2	String	True		True	Additional source details of the last session attributed to any contacts that are directly or indirectly associated with this deal
Latest Source Data 2 Company	String	True		True	Additional source details of the last session attributed to any contacts that are indirectly associated with this deal
Latest Source Data 2 Contact	String	True		True	Additional source details of the last session attributed to any contacts that are directly associated with this deal
Latest Source Timestamp	Datetime	True		True	Timestamp of when latest source occurred for either a directly or indirectly associated contact
Latest Source Timestamp Company	Datetime	True		True	Timestamp of when latest source occurred for an indirectly associated contact
Latest Source Timestamp Contact	Datetime	True		True	Timestamp of when latest source occurred for a directly associated contact
Original Source Type	String	False		True	Original source for the contact with the earliest activity for this deal.
Original Source Data 1	String	True		True	Additional information about the original source for the associated contact_ or associated company if there is no contact_ with the oldest value for the Time first seen property.
Original Source Data 2	String	True		True	Additional information about the original source for the associated contact_ or associated company if there is no contact_ with the oldest value for the Time first seen property.
Annual recurring revenue	Decimal	True		True	The annual recurring revenue _ARR_ of this deal.
HubSpot Campaign	String	False		True	The marketing campaign the deal is associated with
Closed Deal Amount	Decimal	True		True	Returns the amount if the deal is closed. Else_ returns 0.
Closed Deal Amount In Home Currency	Decimal	True		True	Returns the amount in home currency if the deal is closed. Else_ returns 0.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Date entered 'Appointment Scheduled _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline
Date entered 'Closed Lost _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Closed Lost' stage_ 'Sales Pipeline' pipeline
Date entered 'Closed Won _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Closed Won' stage_ 'Sales Pipeline' pipeline
Date entered 'Contract Sent _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Contract Sent' stage_ 'Sales Pipeline' pipeline
Date entered 'Decision Maker BoughtIn _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Decision Maker Bought_In' stage_ 'Sales Pipeline' pipeline
Date entered 'Presentation Scheduled _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline
Date entered 'Qualified To Buy _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline
Date exited 'Appointment Scheduled _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline
Date exited 'Closed Lost _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Closed Lost' stage_ 'Sales Pipeline' pipeline
Date exited 'Closed Won _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Closed Won' stage_ 'Sales Pipeline' pipeline
Date exited 'Contract Sent _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Contract Sent' stage_ 'Sales Pipeline' pipeline
Date exited 'Decision Maker BoughtIn _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Decision Maker Bought_In' stage_ 'Sales Pipeline' pipeline
Date exited 'Presentation Scheduled _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline
Date exited 'Qualified To Buy _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline
Deal amount calculation preference	String	False		True	Specifies how deal amount should be calculated from line items
Deal probability	Decimal	False		True	The probability a deal will close. This defaults to the deal stage probability setting.
Deal stage probability shadow	Decimal	True		True	Fall back property for calculating the deal stage when no customer override exist. Probability between 0 and 1 of deal stage. Defaults to 0 for unknown deal stages.
Exchange rate	Decimal	True		True	This is the exchange rate used to convert the deal amount into your company currency.
Forecast amount	Decimal	True		True	The custom forecasted deal value calculated by multiplying the forecast probability and deal amount in your company_s currency.
Forecast probability	Decimal	False		True	The custom percent probability a deal will close.
Is Deal Closed_	Bool	True		True	True if the deal was won or lost.
Is Closed Won	Bool	True		True	True if the deal is in the closed won state_ false otherwise
Deal Split Added	Bool	True		True	Indicates if the deal is split between multiple users.
Last Modified Date	Datetime	True		True	Most recent timestamp of any property update for this deal. This includes HubSpot internal properties_ which can be visible or hidden. This property is updated automatically.
Likelihood to close by the close date	Decimal	True		True	Hubspot predicted likelihood between 0 and 1 of the deal to close by the close date.
Global Term Line Item Discount Percentage	String	False		True	For internal HubSpot Application use only. Global term for the discount percentage applied.
Global Term Line Item Discount Percentage Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for the discount percentage is enabled.
Global Term Line Item Recurring Billing Period	String	False		True	For internal HubSpot Application use only. Global term for product recurring billing duration.
Global Term Line Item Recurring Billing Period Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for product recurring billing duration is enabled.
Global Term Line Item Recurring Billing Start Date	String	False		True	For internal HubSpot Application use only. Global term for recurring billing start date for a line item.
Global Term Line Item Recurring Billing Start Date Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for recurring billing start date for a line item is enabled.
Global Term Line Item Recurring Billing Frequency	String	False		True	For internal HubSpot Application use only. Global term for how frequently the product is billed.
Global Term Line Item Recurring Billing Frequency Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for how frequently the product is billed is enabled
Forecast category	String	False		True	The likelihood a deal will close. This property is used for manual forecasting your deals.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Monthly recurring revenue	Decimal	True		True	The monthly recurring revenue _MRR_ of this deal.
Next step	String	False		True	A short description of the next step for the deal
Number of Active Deal Registrations	Decimal	True		True	The number of active deal registrations associated with this deal. This property is set automatically by HubSpot.
Number of Deal Registrations	Decimal	True		True	The number of deal registrations associated with this deal. This property is set automatically by HubSpot.
Number of Deal Splits	Decimal	True		True	The number of deal splits associated with this deal. This property is set automatically by HubSpot.
Number of target accounts	Decimal	True		True	The number of target account companies associated with this deal. This property is set automatically by HubSpot.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Pinned Engagement ID	Decimal	True		True	The object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified.
The predicted deal amount	Decimal	True		True	Returns the multiplication of the deal amount times the predicted likelihood of the deal to close by the close date.
The predicted deal amount in your company's currency	Decimal	True		True	Returns the multiplication of the deal amount in your company's currency times the predicted likelihood of the deal to close by the close date.
Priority	String	False		True
Weighted amount	Decimal	True		True	Returns the multiplication of the amount times the probability of the deal closing.
Weighted amount in company currency	Decimal	True		True	Returns the multiplication of the amount in home currency times the probability of the deal closing.
Read Only Object	Bool	True		True	Is the object read only
Total contract value	Decimal	True		True	The total contract value _TCV_ of this deal.
Time in 'Appointment Scheduled _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline
Time in 'Closed Lost _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Closed Lost' stage_ 'Sales Pipeline' pipeline
Time in 'Closed Won _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Closed Won' stage_ 'Sales Pipeline' pipeline
Time in 'Contract Sent _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Contract Sent' stage_ 'Sales Pipeline' pipeline
Time in 'Decision Maker BoughtIn _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Decision Maker Bought_In' stage_ 'Sales Pipeline' pipeline
Time in 'Presentation Scheduled _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline
Time in 'Qualified To Buy _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline
Unique creation key	String	True		True	Unique property used for idempotent creates
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner Assigned Date	Datetime	True		True	The date the most recent deal owner was assigned to a deal. This is updated automatically by HubSpot.
Deal Name	String	False		True	The name given to this deal.
Amount	Decimal	False		True	The total amount of the deal
Deal Stage	String	False		True	The stage of the deal. Deal stages allow you to categorize and track the progress of the deals that you are working on.
Pipeline	String	False		True	The pipeline the deal is in. This determines which stages are options for the deal.
Close Date	Datetime	False		True	Date the deal was closed. This property is set automatically by HubSpot.
Create Date	Datetime	False		True	Date the deal was created. This property is set automatically by HubSpot.
Date of last meeting booked in meetings tool	Datetime	True		True	The date of the most recent meeting an associated contact has booked through the meetings tool.
Campaign of last booking in meetings tool	String	True		True	This UTM parameter shows which marketing campaign _e.g. a specific email_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Medium of last booking in meetings tool	String	True		True	This UTM parameter shows which channel _e.g. email_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Source of last booking in meetings tool	String	True		True	This UTM parameter shows which site _e.g. Twitter_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Latest meeting activity	Datetime	True		True	The date of the most recent meeting _past or upcoming_ logged for_ scheduled with_ or booked by a contact associated with this deal.
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to for this deal
Deal owner	String	False		True	User the deal is assigned to. Assign additional users to a deal record by creating a custom user property.
Last Contacted	Datetime	True		True	The last time a call_ sales email_ or meeting was logged for this deal. This is set automatically by HubSpot based on user actions.
Last Activity Date	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a deal. This is updated automatically by HubSpot.
Next Activity Date	Datetime	True		True	The date of the next upcoming activity for a deal. 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.
Number of times contacted	Decimal	True		True	The total number of sales activities _notes_ calls_ emails_ meetings_ or tasks_ logged for a deal. This is updated automatically by HubSpot.
Number of Sales Activities	Decimal	True		True	The total number of times a sales email or call has been logged for a deal. This is updated automatically by HubSpot.
HubSpot Create Date	Datetime	True		True	The date the deal was created. This property is set automatically by HubSpot.
HubSpot Team	String	True		True	Primary team of the deal owner. This property is set automatically by HubSpot.
Deal Type	String	False		True	The type of deal. By default_ categorize your deal as either a New Business or Existing Business.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
Deal Description	String	False		True	Description of the deal
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom
Number of Associated Contacts	Decimal	True		True	The number of contacts associated with this deal. This property is set automatically by HubSpot.
Closed Lost Reason	String	False		True	Reason why this deal was lost
Closed Won Reason	String	False		True	Reason why this deal was won

EmailProperties

Retrieve the available Quote properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

EngagementsCalls

Retrieve the available Calls in HubSpot.

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	False		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.
Call and meeting type	String	False		True	The activity type of the engagement
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement
Call notes preview	String	True		True	A truncated preview of the call notes
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview
Body Preview Truncated	Bool	True		True	Indicates if the engagement body was truncated for the preview
Integrating App ID	Decimal	False		True	The App ID associated with the integrating app
Authenticated recording files url provider	String	True		True	URL which returns Authenticated audio_video URL of the recording
Call notes	String	False		True	The body of the call
Callee object id	Decimal	False		True	The id of the callee
Callee object type	String	False		True	The type of callee
Call direction	String	False		True	The direction of a call
Call outcome	String	False		True	The outcome of the call
Call duration	Decimal	False		True	The duration of the call_ in milliseconds
External Account ID	String	False		True	External Account ID
External ID	String	False		True	The external ID of the call
From Number	String	False		True	The phone number of the person that initiated the call
From Number Name	String	True		True	The name of the phone number that initiated the call
Transcript Available	Bool	False		True	Flag to indicate if the call has an associated transcript
Voicemail Available	String	True		True	Flag to indicate if the call has an associated voicemail
Recording URL	String	False		True	The URL of the recorded call audio
Call Source	String	False		True	The source of the call to differentiate VoIP vs Video Conferencing Apps
Call status	String	False		True	The status of the call
Call Title	String	False		True	The title of the call
To Number	String	False		True	The phone number of the person that was called
To Number Name	String	True		True	The name of the phone number that was called
Tracked terms	String	True		True	A list of any tracked terms contained in the call transcript
Call transcription id	Decimal	False		True	The id of the transcription
Video url	String	False		True	Video URL of the recording
Unique Zoom Meeting ID	String	False		True	The Zoom meeting unique identifier of the call
Calls Service Call ID	Decimal	True		True	The Calls Service specific global unique identifier for a call
Activity created by	Decimal	True		True	The user who created the engagement
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date that an engagement was created
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
Follow up action	String	False		True	What action should be performed during follow up
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request
Last modified date	Datetime	True		True	The date any property on this engagement was modified
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated by	Decimal	True		True	The user who last updated the engagement
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement
Queue Memberships	String	False		True	The list of queues that contain this engagement
Read Only Object	Bool	True		True	Is the object read only
Activity date	Datetime	False		True	The date that an engagement occurred
Unique creation key	String	True		True	Unique property used for idempotent creates
Unique ID	String	False		True	The unique ID of the engagement
Unknown Visitor Conversation	Bool	False		True	Whether or not this communication was made with an unknown visitor
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement
Activity assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom

EngagementsEmails

Retrieve the available Emails in HubSpot.

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	False		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.
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement
Body preview	String	True		True	A truncated preview of the engagegement body
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview
Body Preview Truncated	Bool	True		True	Indicates if the engagement body was truncated for the preview
Activity created by	String	True		True	The user who created the engagement
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date that an engagement was created
Email direction and unique ID	String	True		True	The direction and unique ID of the email
Attached Video	String	False		True	The ID of a video optionally attached to an email
Attached Video Name	String	False		True	The name of a video optionally attached to an email
Attached Video Opened	Bool	False		True	Has the video attachment been opened
Attached Video Watched	Bool	False		True	Has the video attachement been watched
Email BCC Address	String	True		True	Email addresses of the email's BCC recipients
Email BCC First Name	String	True		True	First names of the email's BCC recipients
Email BCC Last Name	String	True		True	Last names of the email's BCC recipients
Email BCC	String	True		True	Raw header values of the email's BCC recipients
Email Bounce Error Detail Message	String	False		True	The message from the bounce error.
Email Bounce Error Detail Status Code	Decimal	False		True	The status code from the bounce error.
Email CC Address	String	True		True	Email addresses of the email's CC recipients
Email CC First Name	String	True		True	First names of the email's CC recipients
Email CC Last Name	String	True		True	Last names of the email's CC recipients
Email CC	String	True		True	Raw header values of the email's CC recipients
Email Direction	String	False		True	The direction the email was sent in
Encoded Email Associations Request	String	True		True	Encoded email associations request
Error Message	String	False		True	The error that occurred while sending the email
Email Send Id	String	True		True	The ID of the email send event sent through Facsimile
Email From Address	String	True		True	Email address of the email's sender
Email From First Name	String	True		True	First name of the email's sender
Email From Last Name	String	True		True	Last name of the email's sender
Email From	String	True		True	Raw header value of the email's sender
Email Headers	String	False		True	The sender and receivers of the email
Email body	String	False		True	This is the body of any email sent from a record. It doesn't include emails received from contacts.
Logged From	String	False		True	Where the email was logged
Media Processing Status	String	False		True	Processing status for this email's images and attachments
Email is member of forwarded subthread	Bool	False		True	Whether this email is a member of a forwarded subthread
Message ID	String	False		True	The ID of the message
EmailMigratedViaPortalDataMigration	String	False		True	Indicates that the email was migrated from another portal using DataMigration tool
Email pending inline image file IDs	String	False		True	File IDs of pending inline images in the email's HTML
PostSend Status	String	False		True	A description of what happened to the email _successful send_ bounced_ dropped_ and why
RecipientDrop Reasons	String	False		True	A list of the dropped recipients paired with the reason each was dropped
Email Send Event Id	String	False		True	The ID of the email send event
Email Send Event Id Created	Datetime	False		True	The date when the email send event ID was created
Email Sender Address	String	True		True	Email address of the email's sender
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 of the email's sender
Sent Via	String	False		True	How the email was sent
Email send status	String	False		True	The send status of the email
Email subject	String	False		True	The subject of the email
Text	String	False		True	The plaintext of the email
Thread ID	String	False		True	The thread that the email belongs to
Email To Address	String	True		True	Email addresses of the email's recipients
Email To First Name	String	True		True	First names of the email's recipients
Email To Last Name	String	True		True	Last names of the email's recipients
Email To	String	True		True	Raw header values of the email's recipients
Tracker Key	String	False		True	The tracker key of the email
Validation Skipped	String	False		True	Validation skipped that would have otherwise rejected logging
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
Follow up action	String	False		True	What action should be performed during follow up
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request
Last modified date	Datetime	True		True	The date any property on this engagement was modified
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated by	String	True		True	The user who last updated the engagement
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement
Queue Memberships	String	False		True	The list of queues that contain this engagement
Read Only Object	Bool	True		True	Is the object read only
Activity date	Datetime	False		True	The date that an engagement occurred
Unique creation key	String	True		True	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 that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement
Activity assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom

EngagementsMeetings

Retrieve the available Meetings in 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	False		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.
Call and meeting type	String	False		True	The activity type of the engagement
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement
HubSpot attendee owner IDs	String	False		True	List of HubSpot owner IDs for additional attendees
Body preview	String	True		True	A truncated preview of the engagegement body
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview
Body Preview Truncated	Bool	True		True	Indicates if the engagement body was truncated for the preview
Activity created by	Decimal	True		True	The user who created the engagement
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date that an engagement was created
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
Follow up action	String	False		True	What action should be performed during follow up
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request
iCalUid	String	True		True	The iCalUid of the synced event
Internal Meeting Notes	String	False		True
Last modified date	Datetime	True		True	The date any property on this engagement was modified
Meeting description	String	False		True	The text description of the meeting
Meeting calendar event hash	String	False		True	The unique hash for the meeting
Meeting change id	String	False		True	The unique change id for the meeting
Created From Link ID	String	False		True	Created From Link ID
Meeting end time	Datetime	False		True	The date when the meeting ends
External URL	String	False		True	The external URL for the meeting
Meeting location	String	False		True	Where the meeting takes place
Location type	String	False		True	The type of location for the meeting event
Meeting outcome	String	False		True	The outcome of this meeting
Payments session id	String	False		True	The payments session id for the meeting
PreMeeting prospect reminders	String	False		True	A list of dates when meeting reminders should be sent to prospects
Meeting source	String	True		True	The source where the meeting was booked
Source ID	String	False		True	The source ID of the meeting
Meeting start time	Datetime	False		True	The date when the meeting starts
Meeting name	String	False		True	The title of the meeting
Web conference meeting ID	String	False		True	The meeting ID of the web conference
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated by	Decimal	True		True	The user who last updated the engagement
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement
Queue Memberships	String	False		True	The list of queues that contain this engagement
Read Only Object	Bool	True		True	Is the object read only
Scheduled tasks	String	True		True
Activity date	Datetime	False		True	The date that an engagement occurred
Unique creation key	String	True		True	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 that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement
Activity assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom

EngagementsNotes

Retrieve the available Notes in HubSpot.

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	False		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.
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement
Body preview	String	True		True	A truncated preview of the engagegement body
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview
Body Preview Truncated	Bool	True		True	Indicates if the engagement body was truncated for the preview
Activity created by	Decimal	True		True	The user who created the engagement
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date that an engagement was created
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
Follow up action	String	False		True	What action should be performed during follow up
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request
Last modified date	Datetime	True		True	The date any property on this engagement was modified
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated by	Decimal	True		True	The user who last updated the engagement
Note body	String	False		True	The body of the note
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement
Queue Memberships	String	False		True	The list of queues that contain this engagement
Read Only Object	Bool	True		True	Is the object read only
Activity date	Datetime	False		True	The date that an engagement occurred
Unique creation key	String	True		True	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 that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement
Activity assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom

EngagementsTasks

Retrieve the available Tasks in HubSpot.

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	False		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.
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement
Notes _preview_	String	True		True	A plain_text preview of the notes field on a task
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview
Body Preview Truncated	Bool	True		True	Indicates if the engagement body was truncated for the preview
Calendar Event ID	String	True		True	The event ID for the synced task.
Created by	Decimal	True		True	The user who created the engagement
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Created at	Datetime	True		True	The date that an engagement was created
Source	String	False		True	The source that created this engagement
Source ID	String	False		True	The specific ID of the process that created this engagement
Follow up action	String	False		True	What action should be performed during follow up
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request
Last modified at	Datetime	True		True	The date any property on this engagement was modified
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Last modified by	Decimal	True		True	The user who last updated the engagement
MS Teams message ID	String	True		True	The message ID for the created task.
Associated Companies	Decimal	True		True	The number of companies associated with this task
Associated Contacts	Decimal	True		True	The number of contacts associated with this task
Associated Deals	Decimal	True		True	The number of deals associated with this task
Associated Queue Objects	Decimal	True		True	The number of objects associated with this task that support task queues
Associated Tickets	Decimal	True		True	The number of tickets associated with this task
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement
Queue	String	False		True	The list of queues that contain this engagement
Read Only Object	Bool	True		True	Is the object read only
Task repeat status	String	True		True	Indicates whether the task is currently repeating
Scheduled tasks	String	True		True
Notes	String	False		True	The content in the notes field on a task
Completed at	Datetime	True		True	The date that the task was completed
Contact Time Zone	String	True		True	The time zone of the associated contact
For Object Type	String	False		True	The object type for the task
Task is all day	Bool	False		True	Determines if the task is due all day or at a specific time
Last contacted	Datetime	True		True	The last time a call_ email_ or meeting was logged for the associated contact. This is set automatically by HubSpot based on user actions in the contact record
Last engagement	Datetime	True		True	The date of the last sales activity with the associated contact. This is set automatically by HubSpot based on user actions in the contact record
Priority	String	False		True	The priority of the task
Task probability to complete	Decimal	True		True	The probability the task will be completed
Relative Task Reminders	String	False		True	The dates _relative to the due date_ when reminders will be sent
Reminder	String	False		True	The dates when reminders will be sent
Interval	String	True		True	How often the task should repeat
Send Default Reminder	Bool	False		True	Whether or not a reminder should be sent when the task is due
Sequence Enrollment Is Active	Bool	True		True	Whether the sequence enrollment this task is a part of is currently active
Sequence step enrollment Id	String	True		True	The id of the sequence step that created the task
Sequence step number	Decimal	True		True	The order of this task in the sequence at time of enrollment
Task Status	String	False		True	The status of the task
Task Title	String	False		True	The subject text for the task
Task template id	Decimal	True		True	The id of template the task was created from
Task Type	String	False		True	The type of task
Due date	Datetime	False		True	The date that an engagement occurred
Unique creation key	String	True		True	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 that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement
Assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom

FeedbackSubmissionAssociations

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

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

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Feedbacksubmissions.Id	False	Feedbacksubmissions ID
AssociationId [KEY]	Long	False		False	ID of the object that this Feedbacksubmissions 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	AssociationsTypes.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
TypeName [KEY]	String	True	AssociationsTypes.Type	False	The name of the association type for the specified object pair. This column is empty for more specific associations queries.

FeedbackSubmissionProperties

Retrieve the available Quote properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

Feedbacksubmissions

Retrieve the available Feedbacksubmissions in HubSpot.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 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 Contacts WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Contacts WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Contacts WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Contacts 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	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		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.
Agent email	String	True		True	Conversation agent's email
Agent responsible for the conversation	Decimal	True		True	Agent responsible for the conversation which led to the feedback
Agent name	String	True		True	Conversation agent's full name
All accessible team IDs	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom
Business units	String	False		True	The business units this record is assigned to.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
Chatflow ID	Decimal	True		True	Chatflow ID of the conversation associated to the submission
Chatflow name	String	True		True	The name of the chatflow associated to the submission
Chatflow object id	Decimal	True		True	Chatflow object id of the conversation associated to the submission
Contact first name	String	True		True	First name of the contact associated with the submission
Contact Id	Decimal	True		True	The id of the contact most recently associated with this submission
Contact last name	String	True		True	Last name of the contact associated with the submission
Conversation thread id	Decimal	True		True	Thread id of the conversation associated to the submission
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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.
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 object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Read Only Object	Bool	True		True	Is the object read only
Tag IDs	String	True		True	Tag IDs assigned to this submission.
Tags	String	True		True	Tags assigned to this submission.
Ticket id	Decimal	True		True	ID of the ticket associated with the submission
Ticket owner avatar uri	String	True		True	Avatar URI of the ticket associated to the feedback's owner
Ticket owner	Decimal	True		True	User the ticket is assigned to which is associated to feedback submission
Ticket name	String	True		True	Short summary of ticket associated with the submission
Unique creation key	String	True		True	Unique property used for idempotent creates
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner Assigned Date	Datetime	True		True	The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
Owner	String	False		True	The owner of the object.
HubSpot Team	String	True		True	The primary team of the owner.
Industry Standard Question Type	String	True		True	Industry standard question type for custom surveys
Sentiment	String	True		True	This column is a custom field. Sentiment of feedback submission based on survey type
Survey ID	Decimal	True		True	The survey id that the feedback submission is linked with
Survey Type	String	True		True	The type of the survey
Source	String	True		True	The channel of the survey when the feedback submission occurred
Date	Datetime	True		True	The timestamp of the feedback submission
Rating	Decimal	True		True	The value of the feedback submission
Feedback sentiment	String	True		True	The sentiment of the feedback submission
Response	String	False		True	The follow_up response of the feedback submission
Ingestion id	String	True		True	The identifier we use when we initially capture a feedback submission
Knowledge article id	Decimal	True		True	The id of the knowledge article this submission was for
Visitor id	Decimal	True		True	The id of the visitor who submitted this feedback
Engagement id	Decimal	True		True	The id of the equivalent engagement object
Submission URL	String	True		True	The URL of the page the submission was made from
Survey Name	String	True		True	The name of the feedback survey the submission is linked with
Form guid	String	True		True	The form guid that the feedback submission is linked with
Email	String	True		True	The email of the contact associated with a feedback submission
Submission Name	String	True		True	The email of the contact associated with a feedback submission

Forms

Retrieve HubSpot forms used to collect lead information about your visitors and contacts.

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	ID of Marketing Form.
Name	String	False		False	The title of the Form.
FormType	String	False		False	Form Type.
FieldGroups	String	False		False	Field Groups aggregate.
Language	String	False		False	Language.
Cloneable	Bool	False		False	Cloneable.
Editable	Bool	False		False	Editable.
Archivable	Bool	False		False	Archivable.
RecaptchaEnabled	Bool	False		False	Recaptcha Enabled.
NotifyContactOwner	Bool	False		False	Notify Contact Owner.
NewContactNewEmail	Bool	False		False	Create new contact for new email.
PrePopulate	Bool	False		False	Prepopulate known values.
AllowLinkToReset	Bool	False		False	Allow link to reset known values.
RenderRawHtml	Bool	False		False	Render raw HTML.
Theme	String	False		False	Theme.
SubmitButtonText	String	False		False	Submit Button Text.
CssClass	String	False		False	CSS Class.
Style	String	False		False	Form Type.
CreatedAt	Datetime	False		False	When the meeting was created.
UpdatedAt	Datetime	False		False	When the meeting was last updated.
Archived	Bool	True		False	Determines whether the meeting is archived.

LineitemAssociations

Retrieve the IDs of all the objects associated to specific Lineitems objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Lineitems.Id	False	Lineitems ID
AssociationId [KEY]	Long	False		False	ID of the object that this Lineitems 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	AssociationsTypes.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
TypeName [KEY]	String	True	AssociationsTypes.Type	False	The name of the association type for the specified object pair. This column is empty for more specific associations queries.

LineItemProperties

Retrieve the available Quote properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

Lineitems

Retrieve the available Lineitems in HubSpot. This table supports both OAuth and PrivateAppToken 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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them. For example:

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}
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	False		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.
Net price	Decimal	True		True	The amount of a line item
Create Date	Datetime	False		True	The date the line item was created
Description	String	False		True	Full description of product
Unit discount	Decimal	False		True	The discount amount applied
Annual contract value	Decimal	True		True	The annual contract value _ACV_ of this product
All accessible team IDs	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom
Business units	String	False		True	The business units this record is assigned to.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
Allow buyer selected quantity	String	True		True	Whether buyer selected quantity is to be enabled or not for a LineItem
Annual recurring revenue	Decimal	True		True	The annual recurring revenue _ARR_ of this product
Delayed billing start by days	Decimal	False		True	Number of days billing should be delayed by. It allows the customers to start billing sometime in the future
Delayed billing start by months	Decimal	False		True	Number of months billing should be delayed by. It allows the customers to start billing sometime in the future.
Start billing terms	String	True		True	The type of billing start delay. It can be a fixed date in the future_ relative delay in number of days or months
Unit cost	Decimal	False		True	The amount that sold goods cost the HubSpot customer
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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.
Discount Percentage	Decimal	False		True	The discount percentage applied
External LineItem id	Decimal	True		True	The ID of a line item
Image URL	String	False		True	Product images.
Last Modified Date	Datetime	True		True	The date any property on this product was modified
Currency	String	False		True	Currency code for the line item.
Margin	Decimal	True		True	The margin value of this product
Annual contract value margin	Decimal	True		True	The margin annual contract value of this product
Annual recurring revenue margin	Decimal	True		True	The margin annual recurring revenue of this product
Monthly recurring revenue margin	Decimal	True		True	The margin monthly recurring revenue of this product
Total contract value margin	Decimal	True		True	The margin total contract value of this product
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Monthly recurring revenue	Decimal	True		True	The monthly recurring revenue _MRR_ of this product
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Position on quote	Decimal	False		True	The order which the line item appears on the quotes
Pre Discount Amount	Decimal	True		True	The pre_discount amount of a line item
Product ID	Decimal	False		True	ID of the product this was copied from
Read Only Object	Bool	True		True	Is the object read only
End Date	Date	True		True	Recurring billing end date for a line item
Number of payments	Decimal	True		True	Number of payments for the given period on a Line Item
Term	String	False		True	Product recurring billing duration
Billing start date	Date	False		True	Recurring billing start date for a line item
Billing terms	String	True		True	If there are fixed number payments or it goes on until cancelled
SKU	String	False		True	Unique product identifier
Sync amount	Decimal	True		True	The amount set by Ecommerce sync
Total contract value	Decimal	True		True	The total contract value _TCV_ of this product
Term in months	Decimal	True		True	The number of months in the term of this product
Calculated Total Discount	Decimal	True		True	Calculated total Discount for the line item taking in consideration the flat amount and discount percentage.
Unique creation key	String	True		True	Unique property used for idempotent creates
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
URL	String	False		True	Product url.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Variant id of the product	Decimal	True		True	Varient id of the shopify product
Owner Assigned Date	Datetime	True		True	The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
Owner	String	False		True	The owner of the object.
HubSpot Team	String	True		True	The primary team of the owner.
Name	String	False		True	Product name
Unit price	Decimal	False		True	Cost of product
Quantity	Decimal	False		True	How many units of a product are in this line item
Billing frequency	String	False		True	How often a line item with recurring billing is billed. It informs the pricing calculation for deals and quotes. Line items with one_time billing aren_t included.
Tax	Decimal	False		True	The tax amount applied

MeetingProperties

Retrieve the available Quote properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

NoteProperties

Retrieve the available Quote properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

PostalEmailProperties

Retrieve the available PostalEmails properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

ProductProperties

Retrieve the available Quote properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

Products

Retrieve the available Products in HubSpot. This table supports both OAuth and PrivateAppToken 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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them. For example:

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}
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	False		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.
Net price	Decimal	True		True	Internal placeholder _to prevent conflicts with line item property of same name_
Create Date	Datetime	False		True	The date the product was created
Product description	String	False		True	Full description of product
Unit discount	Decimal	False		True	The discount amount applied
All accessible team IDs	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom
Business units	String	False		True	The business units this record is assigned to.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
Avatar FileManager key	String	True		True	The path in the FileManager CDN for this product's image. Automatically set by HubSpot.
Unit cost	Decimal	False		True	The amount that sold goods cost the HubSpot customer
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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.
Discount Percentage	Decimal	False		True	The discount percentage applied
Folder Id	Decimal	False		True	The ID of the folder that has this product
Image Url	String	False		True	Product images.
Last Modified Date	Datetime	True		True	The date any property on this product was modified
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product Type	String	False		True	The type of product. By default_ categorize your product as either Inventory_ Non_Inventory or Service.
Read Only Object	Bool	True		True	Is the object read only
Term	String	False		True	Product recurring billing duration
Start Date	Date	False		True	Recurring billing start date for a line item
SKU	String	False		True	Unique product identifier
Unique creation key	String	True		True	Unique property used for idempotent creates
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
URL	String	False		True	Product url.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner Assigned Date	Datetime	True		True	The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
Owner	String	False		True	The owner of the object.
HubSpot Team	String	True		True	The primary team of the owner.
Name	String	False		True	Product name
Unit price	Decimal	False		True	Cost of product
Quantity	Decimal	True		True	Internal placeholder _to prevent conflicts with line item property of same name_
Recurring billing frequency	String	False		True	How often a product with recurring billing is billed. It informs the pricing calculation for deals and quotes. Products with one_time billing aren_t included.
Tax	Decimal	False		True	The tax amount applied

QuoteAssociations

Retrieve the IDs of all the objects associated to specific Quotes objects in HubSpot. table supports only PrivateAppToken authentication.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Quotes.Id	False	Quotes ID
AssociationId [KEY]	Long	False		False	ID of the object that this Quotes 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	AssociationsTypes.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
TypeName [KEY]	String	True	AssociationsTypes.Type	False	The name of the association type for the specified object pair. This column is empty for more specific associations queries.

Quotes

Retrieve the available Quotes in HubSpot. This table supports only PrivateAppToken authentication.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them. For example:

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}
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	False		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.
Business units	String	False		True	The business units this record is assigned to.
Allowed Payment Methods	String	False		True	Accepted forms of payment if quote is using HubSpot Payment
Quote Approver	String	False		True
Collect Billing Address	Bool	False		True	Indicates if billing address should be collected with this quote
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date the quote was created
Quote Domain	String	False		True	Domain this quote should be served from
ESign Date	Datetime	True		True	The date and time the document was signed by all signers
Expiration Template Path	String	False		True	Path of the expiration template for the quote
Quote approval feedback	String	False		True	Feedback about this quote during the approval process
Language	String	False		True	The language for displaying this quote publicly
Last modified date	Datetime	True		True	The last time any property on the quote was modified
Global Term Line Item Discount Percentage	String	False		True	For internal HubSpot Application use only. Global term for the discount percentage applied.
Global Term Line Item Discount Percentage Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for the discount percentage is enabled.
Global Term Line Item Recurring Billing Period	String	False		True	For internal HubSpot Application use only. Global term for product recurring billing duration.
Global Term Line Item Recurring Billing Period Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for product recurring billing duration is enabled.
Global Term Line Item Recurring Billing Start Date	String	False		True	For internal HubSpot Application use only. Global term for recurring billing start date for a line item.
Global Term Line Item Recurring Billing Start Date Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for recurring billing start date for a line item is enabled.
Global Term Line Item Recurring Billing Frequency	String	False		True	For internal HubSpot Application use only. Global term for how frequently the product is billed.
Global Term Line Item Recurring Billing Frequency Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for how frequently the product is billed is enabled
Locale	String	False		True	The locale for displaying this quote publicly
Locked	Bool	True		True	Indicates if this quote is locked and can never be updated
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Payment date	Datetime	True		True	The date the quote was paid by the customer
Payment Status	String	True		True	Payment status for the quote
Payment Type	String	False		True	Payment type for the quote if payment is enabled
Quote PDF download link	String	True		True	The link to download a pdf of a quote
Proposal Domain	String	True		True	Domain this proposal should be served from
Proposal Slug	String	True		True	Path to serve this proposal from
Proposal Template	String	False		True	Template Path this proposal is rendered with
Public URL key	String	True		True	Key for accessing quote document URL
Quote Total Preference	String	False		True	What LineItem property will be used to calculate the Quote Amount
Read Only Object	Bool	True		True	Is the object read only
Sender image URL	String	False		True	URL to image of the sender avatar image to be set on the quote
Quote Slug	String	False		True	Path to serve this quote from
Template Type	String	False		True	Whether this Quote is rendered with the default templates
Test mode	Bool	False		True	Indicates if the quote is in test mode
Unique creation key	String	True		True	Unique property used for idempotent creates
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner assigned date	Datetime	True		True	The date an owner was assigned to the quote
Sender company name	String	False		True	The name of the company sending this quote
Sender first name	String	False		True	First name of the sender of this quote
Quote title	String	False		True	The title of this quote
Expiration date	Datetime	False		True	The date that this quote expires
Sender company domain	String	False		True	The domain of the company sending this quote
Sender last name	String	False		True	Last name of the sender of this quote
Comments to buyer	String	False		True	Comments to the buyer
Sender company street address	String	False		True	The street address of the company sending this quote
Sender email	String	False		True	Email address of the sender of this quote
Sender company street address 2	String	False		True	The second line of the street address of the company sending this quote
Sender phone number	String	False		True	Phone number of the sender of this quote
Terms	String	False		True	Any relevant information about pricing_ purchasing terms_ and_or master agreements
Logo URL	String	False		True	URL to image of the logo displayed on the quote
Sender company city	String	False		True	The city in which the company sending this quote is located
Sender job title	String	False		True	Job title of the sender of this quote
Sender company state_region	String	False		True	The state_region in which the company sending this quote is located
Space for written signature	Bool	False		True	Indicates if the quote document should have a place for a written signature
Branding color	String	False		True	Color value used on the quote document
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to for this quote
Sender company postal code	String	False		True	The zip code in which the company sending this quote is located
Space for written countersignature	Bool	False		True	Indicates if the quote document should have a place for a written countersignature
Quote owner	String	False		True	The owner of the quote
Last Contacted	Datetime	True		True	The last timestamp when a call_ email or meeting was logged for this quote
Last Activity Date	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a quote. This is set automatically by HubSpot based on user actions in the quote record.
Next Activity Date	Datetime	True		True	The date of the next upcoming activity for this quote
Number of times contacted	Decimal	True		True	The number of times a call_ email or meeting was logged for this quote
Number of Sales Activities	Decimal	True		True	Number of sales activities for this quote
Currency	String	False		True	Currency code for the quote
Sender company country	String	False		True	The country in which the company sending this quote is located
HubSpot team	String	True		True	The name of the team associated with the owner of the quote
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
Sender company image URL	String	False		True	URL to image of the sender company image to be set on the quote
Time zone	String	False		True	Timezone for displaying dates on the quote
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom
Payment enabled	Bool	False		True	Indicates if payment can be collected via the quote link
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom
ESign enabled	Bool	False		True	Indicates if esign is enabled for quote
Associated Deals	Decimal	True		True	The number of deals associated with this quote. This is set automatically by HubSpot.
ESign number of signers required	Decimal	True		True	Total number of signers required for this quote to be fully signed
Legacy Quote Template	String	False		True	The legacy quote template used to generate a quote. These templates will be sunset on Dec. 12th 2022.
ESign completed signatures	Decimal	True		True	Number of completed signatures collected so far
Quote amount	Decimal	True		True	The total due for the quote
Quote approval status	String	False		True	Approval status of the quote
Quote number	String	False		True	Reference number shown on quote document
Collect shipping address	Bool	False		True	Indicates if shipping address should be collected with this quote

TaskProperties

Retrieve the available Quote properties in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		False	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 if there are external options associate with the company property.
IsFormField	Bool	False		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool	False		False	Boolean indicating if the property is calculated.
IsHidden	Bool	False		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool	False		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool	False		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool	False		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool	False		False	Boolean indicating if 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.

Threads

Retrieve the available Threads in a Conversation in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	False		True	The unique Id of the thread.
CreatedAt	Datetime	False			Time the thread was created.
ClosedAt	Datetime	False			Time the thread was closed.
Status	String	False			The thread's status: open or closed.
LatestMessageTimestamp	Datetime	False			The time that the latest message was sent or received on the thread.
LatestMessageSentTimestamp	Datetime	False			The time that the latest message was sent on the thread.
LatestMessageReceivedTimestamp	Datetime	False			The time that the latest message was received on the thread.
AssignedTo	String	False			The Id of an actor/participant in a conversation.
Spam	Bool	False			Whether the thread is marked as spam.
InboxId	String	False			The Id of the conversations' inbox containing the thread.
AssociatedContactId	String	False			The Id of teh assoicated Contact in the CRM.
Archived	Bool	False			Whether the thread is archived.

TicketAssociations

Retrieve the IDs of all the objects associated to specific Tickets objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Tickets.Id	False	Tickets ID
AssociationId [KEY]	Long	False		False	ID of the object that this Tickets 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	AssociationsTypes.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
TypeName [KEY]	String	True	AssociationsTypes.Type	False	The name of the association type for the specified object pair. This column is empty for more specific associations queries.

TicketPipelines

Discover pipelines that a ticket goes through in HubSpot.

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.

TicketPipelineStages

Pipeline stages of tickets in HubSpot.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	String	False		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.

Tickets

Retrieve the available Tickets in HubSpot. This table supports both OAuth and PrivateAppToken authentications.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 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}
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	False		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.
Close date	Datetime	False		True	The date the ticket was closed
Created by	Decimal	False		True	VID of contact that created the ticket
Create date	Datetime	False		True	The date the ticket was created
First agent email response date	Datetime	True		True	The date of the first email response from an agent after a ticket was created
Business units	String	False		True	The business units this record is assigned to.
Assignment Method	String	False		True	defines how the Object Assignment is done
AutoGenerated from thread id	Decimal	True		True	Thread that this ticket was automatically created for using ticket rules
Originating Conversations Message Id	String	False		True	Conversations Message Id of the message that originated this ticket
Conversations originating thread id	Decimal	False		True	Thread that this ticket was originally created for
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
HubSpot create date	Datetime	True		True	Internal read_only property representing the date the ticket was created in HubSpot
Custom inbox ID	Decimal	False		True	ID of the custom inbox the ticket is associated with
Date entered 'New _Support Pipeline_'	Datetime	True		True	The date and time when the ticket entered the 'New' stage_ 'Support Pipeline' pipeline
Date entered 'Waiting on contact _Support Pipeline_'	Datetime	True		True	The date and time when the ticket entered the 'Waiting on contact' stage_ 'Support Pipeline' pipeline
Date entered 'Waiting on us _Support Pipeline_'	Datetime	True		True	The date and time when the ticket entered the 'Waiting on us' stage_ 'Support Pipeline' pipeline
Date entered 'Closed _Support Pipeline_'	Datetime	True		True	The date and time when the ticket entered the 'Closed' stage_ 'Support Pipeline' pipeline
Date exited 'New _Support Pipeline_'	Datetime	True		True	The date and time when the ticket exited the 'New' stage_ 'Support Pipeline' pipeline
Date exited 'Waiting on contact _Support Pipeline_'	Datetime	True		True	The date and time when the ticket exited the 'Waiting on contact' stage_ 'Support Pipeline' pipeline
Date exited 'Waiting on us _Support Pipeline_'	Datetime	True		True	The date and time when the ticket exited the 'Waiting on us' stage_ 'Support Pipeline' pipeline
Date exited 'Closed _Support Pipeline_'	Datetime	True		True	The date and time when the ticket exited the 'Closed' stage_ 'Support Pipeline' pipeline
External object ids	String	False		True	Unique ids corresponding to tickets in a system outside of HubSpot
Last CES survey comment	String	True		True	Last CES survey comment that this contact gave for this ticket
Last CES survey rating	String	True		True	Last CES survey rating that this contact gave for this ticket
Last CES survey date	Datetime	True		True	The time that this contact last submitted a CES survey response. This is automatically set by HubSpot.
File upload	String	False		True	Files attached to a support form by a contact.
First agent response date	Datetime	True		True	The date of the first response from an agent out of all associated conversations
In Help Desk	Bool	False		True	Is this Ticket rendered in the Help Desk
Inbox ID	Decimal	True		True	Inbox the ticket is in
Last email activity	String	True		True	The type of the last email activity with the contact associated with the ticket.
Last email date	Datetime	True		True	The date of the last email activity with the contact associated with the ticket.
Last message received date	Datetime	True		True	The date of the last response from the visitor
Last response date	Datetime	True		True	The date of the last response from an agent or bot
Last activity date	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a ticket. This is updated automatically by HubSpot.
Last contacted date	Datetime	True		True	The last time a call_ chat conversation_ LinkedIn message_ postal mail_ meeting_ sales email_ SMS_ or WhatsApp message was logged for a ticket. This is set automatically by HubSpot based on user actions in the ticket record.
Last modified date	Datetime	True		True	Most recent timestamp of any property update for this ticket. This includes HubSpot internal properties_ which can be visible or hidden. This property is updated automatically.
Latest message seen by agent ids	String	True		True	Agents who have seen the newest message across all conversations associated to the ticket
Merged ticket ids	String	True		True	All ticket ids for this ticket
Microsoft Teams message ID for this ticket.	String	True		True	Microsoft Teams message ID for this ticket.
Next activity date	Datetime	True		True	The date of the next upcoming activity for a ticket. This property is set automatically by HubSpot based on user action. This includes logging a future call_ 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.
Number of Associated Companies	Decimal	True		True	Number of companies associated with this ticket
Number of times contacted	Decimal	True		True	The number of times a call_ email_ or meeting was logged on the ticket
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Originating channel account	String	True		True	First channel account used when conversation was started
Originating email engagement id	Decimal	True		True	Engagement id of the email originating this ticket
Originating channel type	String	True		True	The channel the conversation is in
Pinned Engagement ID	Decimal	True		True	The object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified.
Pipeline	String	False		True	The pipeline that contains this ticket
Ticket status	String	False		True	The pipeline stage that contains this ticket
Read Only Object	Bool	True		True	Is the object read only
Resolution	String	False		True	The action taken to resolve the ticket
Thread IDs To Restore	String	False		True	Thread IDs _from cv_threads_ used to implement custom cascading delete_restore
Category	String	False		True	Main reason customer reached out for help
Ticket ID	Decimal	True		True	The unique id for this ticket. This unique id is automatically populated by HubSpot.
Priority	String	False		True	The level of attention needed on the ticket
Time in 'New _Support Pipeline_'	Decimal	True		True	The total time in seconds spent by the ticket in the 'New' stage_ 'Support Pipeline' pipeline
Time in 'Waiting on contact _Support Pipeline_'	Decimal	True		True	The total time in seconds spent by the ticket in the 'Waiting on contact' stage_ 'Support Pipeline' pipeline
Time in 'Waiting on us _Support Pipeline_'	Decimal	True		True	The total time in seconds spent by the ticket in the 'Waiting on us' stage_ 'Support Pipeline' pipeline
Time in 'Closed _Support Pipeline_'	Decimal	True		True	The total time in seconds spent by the ticket in the 'Closed' stage_ 'Support Pipeline' pipeline
Time to Close SLA Due Date	Datetime	True		True	When the ticket falls out of Time to Close SLA.
Time to Close SLA Ticket Status	String	True		True	Current Time to Close SLA status of ticket
Time to First Response SLA Due Date	Datetime	True		True	When the ticket falls out of the Time to First Response SLA
Time to First Response SLA Status	String	True		True	Current Time to First Response SLA status.
Unique creation key	String	True		True	Unique property used for idempotent creates
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object
Owner assigned date	Datetime	True		True	The date an owner was assigned to the ticket
Date of last engagement	Datetime	True		True	The date of the last reply or note
Last customer reply date	Datetime	True		True	The date of the last customer response
NPS follow up	String	False		True	Answer to NPS follow up question
NPS follow up question	Decimal	False		True	Specific version of NPS follow up question that was asked
Conversation NPS score	String	False		True	NPS score received after ticket resolution
Reference to email thread	String	False		True	The id of an email thread with ticket conversation
Time to close	Decimal	True		True	The time between when the ticket was created and closed
Time to first agent email reply	Decimal	True		True	The time from the ticket create date to the first agent email reply
Ticket name	String	False		True	Short summary of ticket
Ticket description	String	False		True	Description of the ticket
Source	String	False		True	Channel where ticket was originally submitted
Reference to sourceSpecific object	String	False		True	The id of a connected source object
Tags	String	False		True	Tags associated with your tickets
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to for this ticket
Ticket owner	String	False		True	User the ticket is assigned to. Assign additional users to a ticket record by creating a custom user property.
Last Contacted _Ticket Note_	Datetime	True		True	The last timestamp when a call_ email or meeting was logged for this ticket
Last Activity Date _Ticket Note_	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a ticket. This is set automatically by HubSpot based on user actions in the ticket record.
Next Activity Date _Ticket Note_	Datetime	True		True	The date of the next upcoming activity for this ticket
Number of times contacted _Ticket Note_	Decimal	True		True	The number of times a call_ email or meeting was logged for this ticket
Number of Sales Activities	Decimal	True		True	Number of sales activities for this ticket
HubSpot team	String	True		True	Primary team of the ticket owner. This property is set automatically by HubSpot.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom
All team ids	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom
All accessible team ids	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom

ビュー

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

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

HubSpot Connector for CData Sync ビュー


Name	Description
AssociationsTypes	Retrieve all available association types between a pair of CRM objects.
CompanyPropertiesHistory	Retrieve the available Company properties history in HubSpot.
ContactPropertiesHistory	Retrieve the available Contact properties history in HubSpot.
CustomObjectProperties	Retrieve the available Custom Objects Properties in HubSpot.
CustomObjects	Retrieve the available Custom Objects in HubSpot.
DealPropertiesHistory	Retrieve the available Deal properties history in HubSpot.
Files	Search through files in the file manager. Does not display hidden or archived files. Requires files or files.ui_hidden.read as a scope.
Folders	Search for folders. Does not contain hidden or archived folders. Requires files or files.ui_hidden.read as a scope.
GoalProperties	Retrieve the available Companyproperties in HubSpot.
Goals	Retrieve the available Goals in HubSpot.
Owners	HubSpot uses owners to assign CRM objects to specific people in your organization. The endpoints described here are used to get a list of the owners that are available for an account.
ThreadMessages	Retrieve the entire message history in a Thread
TicketPropertiesHistory	Retrieve the available ticket properties history in HubSpot.
WebAnalytics	The Web Analytics endpoint allows developers to find and filter events associated with a CRM object of any type.

AssociationsTypes

Retrieve all available association types between a pair of CRM objects.

View Specific Information

Select

You must specify FromObjectType and ToObjectType. For example:

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

Columns


Name	Type	References	Filterable	Description
Id [KEY]	String			The numeric ID for the association type.
Type	String			The name of the association type for the specified object pair.
FromObjectType [KEY]	String		True	The first object's type to retrieve association types for.
ToObjectType [KEY]	String		True	The second object's type to retrieve association types for.

CompanyPropertiesHistory

Retrieve the available Company properties history in HubSpot.

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The name of the property.
Value	String		False	The historical value of the property.
SourceType	String		False	The method by which the property was changed.
SourceId	String		False	Additional data related to the source. May not be populated for all sources.
Timestamp	Datetime		False	Datetime when the property was updated.

ContactPropertiesHistory

Retrieve the available Contact properties history in HubSpot.

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The name of the property.
Value	String		False	The historical value of the property.
SourceType	String		False	The method by which the property was changed.
SourceId	String		False	Additional data related to the source. May not be populated for all sources.
Timestamp	Datetime		False	Datetime when the property was updated.

CustomObjectProperties

Retrieve the available Custom Objects Properties in HubSpot.

Columns


Name	Type	References	Filterable	Description
ObjectId	String		False	An assigned unique ID for the object_ including portal ID and object name.
ObjectFullyQualifiedName [KEY]	String		False	A unique ID for this schema's object type. It is defined as _meta_type___unique ID_.
ObjectName	String		False	A unique name for the schema's object type.
ObjectLabelSingular	String		False	Singular label for the object. Used in CRM display.
ObjectLabelPlural	String		False	Plural label for the object. Used in CRM display.
Name [KEY]	String		False	The internal property name_ which must be used when referencing the property via the API.
Label	String		False	A human_readable property label that will be shown in HubSpot.
UpdatedAt	Datetime		False	When the Custom Object was last updated.
CreatedAt	Datetime		False	When the Custom Object was created.
ArchivedAt	Datetime		False	When the Custom Object was archived.
Type	String		False	The property data type.
FieldType	String		False	Controls how the property appears in HubSpot.
Description	String		False	A description of the property that will be shown as help text in HubSpot.
GroupName	String		False	The name of the property group the property belongs to.
Options	String		False	A list of valid options for the property. This field is required for enumerated properties_ but will be empty for other property types.
CreatedUserId	String		False	The internal ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.
UpdatedUserId	String		False	The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.
ReferencedObjectType	String		False	If this property is related to other object_s__ they'll be listed here.
DisplayOrder	Int		False	The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of _1 will cause the property to be displayed after any positive values.
Calculated	Bool		False	For default properties_ true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
ExternalOptions	Bool		False	For default properties_ true indicates that the options are stored externally to the property settings.
Archived	Bool		False	Whether or not the property is archived.
HasUniqueValue	Bool		False	Whether or not the property's value must be unique. Once set_ this can't be changed.
Hidden	Bool		False	Whether or not the property is hidden.
HubspotDefined	Bool		False	This will be true for default object properties built into HubSpot.
ShowCurrencySymbol	Bool		False	Whether the property will display the currency symbol set in the account settings.
ModificationMetadata	String		False	The properties' modification metadata.
FormField	Bool		False	Whether or not the property can be used in a HubSpot form.

CustomObjects

Retrieve the available Custom Objects in HubSpot.

Columns


Name	Type	References	Filterable	Description
Id	String		False	An assigned unique ID for the object_ including portal ID and object name.
FullyQualifiedName [KEY]	String		False	A unique ID for this schema's object type. It is defined as _meta_type___unique ID_.
Name	String		False	A unique name for the schema's object type.
LabelSingular	String		False	Singular label for the object. Used in CRM display.
LabelPlural	String		False	Plural label for the object. Used in CRM display.
CreatedAt	Datetime		False	When the Custom Object was created.
UpdatedAt	Datetime		False	When the Custom Object was last updated.
PropertiesAggregate	String		False	An aggregate of the properties defined for a given object type. This information can be viewed in more detail in CustomObjectProperties table.
AssociationsAggregate	String		False	An aggregate of the associations defined for a given object type. This information can be viewed in more detail in CustomObjectAssociations table.
RequiredProperties	String		False	The names of properties that should be required when creating an object of this type.
SearchableProperties	String		False	Names of properties that will be indexed for this object type in by HubSpot's product search.
PrimaryDisplayProperty	String		False	The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
SecondaryDisplayProperties	String		False	The names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
ObjectTypeId	String		False	The ID of the custom object type.
MetaType	String		False	The custom object type description.

DealPropertiesHistory

Retrieve the available Deal properties history in HubSpot.

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The name of the property.
Value	String		False	The historical value of the property.
SourceType	String		False	The method by which the property was changed.
SourceId	String		False	Additional data related to the source. May not be populated for all sources.
Timestamp	Datetime		False	Datetime when the property was updated.

Files

Search through files in the file manager. Does not display hidden or archived files. Requires files or files.ui_hidden.read as a scope.

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	File ID.
Name	String			Name of the file.
Extension	String			Extension of the file. For example png.
Access	String			File access. 使用できる値は次のとおりです。PUBLIC_INDEXABLE, PUBLIC_NOT_INDEXABLE, PRIVATE
CreatedAt	Datetime			Creation time of the file object.
UpdatedAt	Datetime			Timestamp of the latest update to the file.
Archived	Bool			If the file is deleted.
ArchivedAt	Datetime			Deletion time of the file object.
Type	String			Type of the file. 使用できる値は次のとおりです。IMG, DOCUMENT, AUDIO, MOVIE, OTHER
IsUsableInContent	Bool			Indicates if the file should be used when creating new content like web pages.
Encoding	String			Encoding of the file.
Size	Long			Size in bytes of the file.
Height	Int			For image and video files, the height of the content.
Width	Int			For image and video files, the width of the content.
Path	String			Path of the file in the file manager.
ParentFolderId	Long			Id of the folder the file is in.
Url	String			URL of the given file. This URL can change depending on the domain settings of the account. Will use the select file hosting domain.
DefaultHostingUrl	String			Default hosting URL of the file. This will use one of HubSpot's provided URLs to serve the file.
AllowsAnonymousAccess	Bool			If 'true' will show private files; if 'false' will show public files. The output will mirror the input value.

Folders

Search for folders. Does not contain hidden or archived folders. Requires files or files.ui_hidden.read as a scope.

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Id of the folder.
Name	String			Name of the folder.
Path	String			Path of the folder in the file manager.
ParentFolderId	Long			Id of the parent folder.
CreatedAt	Datetime			Timestamp of folder creation.
UpdatedAt	Datetime			Timestamp of the latest update to the folder.
Archived	Bool			Marks weather the folder is deleted or not.
ArchivedAt	Datetime			Timestamp of folder deletion.

GoalProperties

Retrieve the available Companyproperties in HubSpot.

Columns


Name	Type	References	Filterable	Description
Name [KEY]	String		False	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	The human readable label for the property that will display in the HubSpot UI.
FieldType	String		False	The type of field that will display on the screen for the property.
Type	String		False	The stored machine type for the property.
GroupName	String		False	The group that the property is a part of.
Description	String		False	A description of what the property is for.
DisplayOrder	Int		False	The order in which the property should be displayed in relation to other properties in the same group.
ExternalOptions	Bool		False	Boolean indicating if there are external options associate with the company property.
IsFormField	Bool		False	Boolean indicating if the property is a field that is part of a form.
IsCalculated	Bool		False	Boolean indicating if the property is calculated.
IsHidden	Bool		False	Boolean indicating if the property is hidden.
IsHubspotDefined	Bool		False	Boolean indicating if the definition is defined from HubSpot.
Archivable	Bool		False	Boolean indicating if the definition is archivable.
ReadOnlyDefinition	Bool		False	Boolean indicating if the definition for the property is read only.
ReadOnlyValue	Bool		False	Boolean indicating if the value of the property is read only.
OptionsAggregate	String		False	An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Goals

Retrieve the available Goals in HubSpot.

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier of the object.
Archived	Bool		False	Whether the object is archived or not.
CreatedAt	Datetime		False	When the object was created.
UpdatedAt	Datetime		False	When the object was last updated.
MigrationSoftDeleteDeprecated	String		True	Describes if the goal target can be treated as deleted.
Ad account asset IDs	String		True	A list of ';'-separated universally unique IDs of ad accounts, each formatted: {AD_NETWORK}-{ACCOUNT_ID}
Ad campaign asset ids	String		True	A list of ';'-separated universally unique IDs of ad campaigns, each formatted: {NETWORK}-{CAMPAIGN_ID}
All teams	String		True	The team IDs, including up the team hierarchy, corresponding to all owner referencing properties for this object, both default and custom
Business units	String		True	The business units this record is assigned to.
All owner ids	String		True	The value of all owner referencing properties for this object, both default and custom.
Team ids	String		True	Which team owns the goal (there should only ever be one team)
Assignee team ID	Decimal		True	The team ID of the assigned team of the goal (unpopulated if the goal is not team-assigned or team-by-user-assigned)
Assignee user ID	Decimal		True	The user ID of the assigned user of the goal (unpopulated if the goal is not user-assigned)
Campaign asset ids	String		True	List of marketing campaign asset ids
Contact lifecycle stage	String		True	The lifecycle stage selected for the contact lifecycle goal
Created by user ID	Decimal		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date/time	Datetime		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		True	DEPRECATED - DO NOT USE! Code for the currency conversion
Currency Exchange Rate	Decimal		True	Exchange rate to be used for calculated properties reflecting currency-based values in home currencies. Value is automatically set for in-progress goals. Once a goal has ended, the value should be alterable by admins only.
Deal pipelines	String		True	A serialized list of DEAL pipeline IDs used to filter the KPI value calculation.
Edit updates notification frequency	String		True	The frequency of goal edit update notifications
End date	Date		True	The last day covered by the Goal Target's date range.
End datetime	Datetime		True	The last day covered by the Goal Target's date range.
Fiscal year offset	Decimal		True	Represents the number of months the fiscal year is away from a standard calendar year (0 means the fiscal year starts in January).
Goal name	String		True	The name of the goal.
Goal target currency code	String		True	Currency code for the goal target
Goal Target Group ID	Decimal		True	Object ID of the associated Goal Target Group
Goal type	String		True	The goal type
Group correlation UUID	String		True	Unique ID set on all Goal Targets and Goal Target Groups created by a single request
Is forecastable	String		True	READ ME! (kind of) indicates whether the goal should appear in the forecasting app - this property may be true even if the goal should NOT appear in the forecasting app. As of April 2023, this property will be true if hs_milestone is either \\“monthly\\” or \\“quarterly\\“, and if the count of pipelines in hs_pipelines 0 or 1. No other checks are made!
IsLegacy	String		True	Describes if the object was created during the migration process and it comes from the old app.
KPI Display Unit	String		True	Display units for goals based on duration properties
KpiFilterGroups	String		True	Filter groups for KPI calculations
KPI is team rollup	Bool		True	Indicates whether this is a rollup goal: whether the KPI allows contributions from child teams (in addition to the assigned team)
KpiMetricType	String		True	Type of metric used to aggregate the property name
KpiObjectType	String		True	The name of the CrmObject the KPI values are based on
Kpi object type id	String		True	The ObjectTypeId of the object the KPI values are based on
KpiPropertyName	String		True	Name of the property on the object type aggregated as the KPI value.
KpiSingleObjectCustomGoalTypeName	String		True	Single object custom goal components (metric type, object type, property name)
KpiTimePeriodProperty	String		True	Time period property
KpiTrackingMethod	String		True	Tracking method for progress directionality
Kpi unit type	String		True	Unit type of the kpi calculation
KPI value	Decimal		True	The latest KPI value for this goal target
KPI value calculated at	Decimal		True	The time that latest KPI value was calculated
KPI value last calculated at	Datetime		True	The time that latest KPI value was calculated
Object last modified date/time	Datetime		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.
LegacyActive	String		True	Migrated value describing if the goal is active or soft deleted.
LegacyCreatedAt	Decimal		True	Migrated value of created at.
LegacyCreatedBy	Decimal		True	Migrated value of created by.
LegacyQuarterlyTargetCompositeId	String		True	Concatenated value of the 3 sql_ids that form a quarterly GT separated by a '-'. Used to be able to update both monthly and quarterly legacy Goal Targets.
LegacySqlId	Decimal		True	Id of the migrated goal target in the old system. This has been deprecated for legacy_unique_sql_id.
LegacyUniqueSqlId	Decimal		True	Id of the migrated goal target in the old system. This property has a unique value to ensure no duplicate migrated goals.
LegacyUpdatedAt	Decimal		True	Migrated value of updated at.
LegacyUpdatedBy	Decimal		True	Migrated value of updated by.
Merged record IDs	String		True	The list of record IDs that have been merged into this record. This value is automatically set by HubSpot and may not be modified.
MigrationSoftDelete	String		True	Describes if the goal target can be treated as deleted.
Milestone	String		True	The period during which a Goal Target is active
Record ID	Decimal		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Record Creation Source	String		True	Source (PropertySource) that created this object record
Record Creation Source ID	String		True	The sourceId -- further detail -- of the source that created this object record
Record Creation Source User ID	Decimal		True	User ID of the user who initiated creation of this object record
Outcome	String		True	Goal Target outcome
Owner ids of all owners	String		True	The owner IDs of all owners of this object
Participant type	String		True	The type of participant for the Goal Target
Pipeline ids	String		True	List of deal pipelines that the quota applies to. Used to calculate kpi values
Pipelines	String		True	A serialized list of pipeline IDs used to filter the KPI value calculation
Progress updates notification frequency	String		True	The frequency of goal progress update notifications
Read Only Object	Bool		True	Is the object read only
Notify on goal achieved	String		True	Opt into notifications when goal is achieved
Notify with goal edit updates	String		True	Opt into goal edit update notifications
Notify on goal exceeded	String		True	Opt into notifications when goal is exceeded
Notify on goal kickoff	String		True	Opt into notifications when a goal is kicked off
Notify on goal missed	String		True	Opt into notifications when a goal is missed
Notify with progress updates	String		True	Opt into goal progress updates notifications
ShouldRecalculate	String		True	Property used to flag Goal targets that need to be recalculated
Start datetime	Datetime		True	The first day that goal target's date range covers
Static KPI Filter Groups	String		True	Goal Target Filter Group(s) for all filters except time-based filters
Status	String		True	The status of the Goal Target
Status display order	Decimal		True	The goal status display order.
Target amount	Decimal		True	The target amount for this goal target
Target amount in company currency	Decimal		True	The amount of the goal target, using the exchange rate, in your company's currency
Team ID	Decimal		True	The team ID associated with the Goal Target
Ticket pipelines	String		True	A serialized list of TICKET pipeline IDs used to filter the KPI value calculation.
Unique creation key	String		True	Unique property used for idempotent creates
Updated by user ID	Decimal		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User ID	Decimal		True	The user ID associated with the Goal Target
User IDs of all notification followers	String		True	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	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	The user IDs of all owners of this object
Performed in an import	Bool		True	Object is part of an import
Owner Assigned Date	Datetime		True	The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
Owner	String		True	The owner of the object.
HubSpot Team	String		True	The primary team of the owner.
Start date	Date		True	The first day that goal target's date range covers
Kpi progress percent	Decimal		True	Progress percent is represented by the kpi value as a percent of the target amount

Owners

HubSpot uses owners to assign CRM objects to specific people in your organization. The endpoints described here are used to get a list of the owners that are available for an account.

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Owner ID
FirstName	String		False	First name of the owner.
LastName	String		False	Last name of the owner.
UserId	String		False	User id of the owner.
Email	String		True	Email of the owner.
Teams	String		False	Teams of the owner.
CreatedAt	Datetime		False	Created date time.
UpdatedAt	Datetime		False	Updated date time.
Archived	Bool		False	Weather or not is archived.

ThreadMessages

Retrieve the entire message history in a Thread

Columns


Name	Type	References	Filterable	Description
Id [KEY]	String		True	The unique Id of the message.
Type	String			The type of the message.
CreatedAt	Datetime			Time the message was created.
UpdatedAt	Datetime			Time the message was updated.
CreatedBy	String			The Id of an actor/participant which created the message.
ClientType	String			The type of the client.
IntegrationAppId	Integer			The Id of the client if the client is an integration.
SendersId	String			The Id of an actor/participant which sent the message.
SendersName	String			The Name of an actor/participant which sent the message.
SendersField	String			The sender's field.
SendersDeliveryIdentifierType	String			The delivery identifier type for sender.
SendersDeliveryIdentifierValue	String			The delivery identifier value for sender.
RecipientsId	String			The Id of an actor/participant which received the message.
RecipientsName	String			The Name of an actor/participant which received the message.
RecipientsField	String			The recipient's field.
RecipientsDeliveryIdentifierType	String			The delivery identifier type for recipient.
RecipientsDeliveryIdentifierValue	String			The delivery identifier value for recipient.
ChannelId	String			The Id of the channel.
ChannelAccountId	String			The Account Id of the channel.
Archived	Bool			The status of archived.
AssignedTo	String			To which it is assigned.
AssignedFrom	String			From whom it is assigned.
Text	String			The content of the message.
RichText	String			The content of the message in HTML format.
AttachmentsFileId	String			The Id of the attachment to the comment.
AttachmentsUrl	String			The URL of the attachment to the comment.
Subject	String			The subject of the message.
TruncationStatus	String			The truncation status of the message.
InReplyToId	String			The Id value being replied to.
StatusType	String			The status type.
Direction	String			The direction of the message.
NewStatus	String			The value of the new status.

Pseudo-Columns

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


Name	Type	Description
ThreadId	String		Id of the thread that contains the messages.

TicketPropertiesHistory

Retrieve the available ticket properties history in HubSpot.

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The name of the property.
Value	String		False	The historical value of the property.
SourceType	String		False	The method by which the property was changed.
SourceId	String		False	Additional data related to the source. May not be populated for all sources.
Timestamp	Datetime		False	Datetime when the property was updated.

WebAnalytics

The Web Analytics endpoint allows developers to find and filter events associated with a CRM object of any type.

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	Id of the event.
ObjectId	String		False	Id of the object.
ObjectType	String		False	Type of the selected object.
EventType	String		False	Type of the event.
OccurredAt	Datetime		False	Time when the event occurred.
Properties	String		False	Additional properties.

Pseudo-Columns

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


Name	Type	Description
ObjectProperty	String		If the id of the selected object not present_ then the objectProperty parameter is required. A particular property to match on is identified by an objectProperty._propname___propvalue_ query parameter. To find contacts by their email property you have to specify the value of the ObjectProperty in this format _ 'propertyName_propertyValue'
OccurredAfter	Datetime		The starting time as an ISO 8601 timestamp.
OccurredBefore	Datetime		The ending time as an ISO 8601 timestamp.
Sort	String		Selects the sort field and order. Defaults to ascending_ prefix with _ for descending order. 'occurredAt' is the only field supported for sorting.

HubSpot V4 データモデル

The CData Sync App models HubSpot CRM API v4 objects as relational Tables, Views, and Stored Procedures. This section describes API limitations and requirements; you can use the SupportEnhancedSQL feature, set by default, to circumvent most of these limitations.

Tables

テーブル describes the available tables.

Views

ビュー are tables that cannot be modified. Typically, data that are read-only and cannot be updated are shown as views.

Stored Procedures

ストアドプロシージャ are function-like interfaces to the data source. They can be used to search, update, and modify information in the data source.

テーブル

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

HubSpot Connector for CData Sync テーブル


Name	Description
Companies	Retrieve the available Companies in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
CompanyAssociations	Retrieve the IDs of all the objects associated to specific Deals objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
ContactAssociations	Retrieve the IDs of all the objects associated to specific Deals objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
Contacts	Retrieve the available Contacts in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
DealAssociations	Retrieve the IDs of all the objects associated to specific Deals objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
Deals	Retrieve the available Deals in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
EngagementsCalls	Retrieve the available Calls in HubSpot.
EngagementsEmails	Retrieve the available Emails in HubSpot.
EngagementsMeetings	Retrieve the available Meetings in HubSpot.
EngagementsNotes	Retrieve the available Notes in HubSpot.
EngagementsTasks	Retrieve the available Tasks in HubSpot.
FeedbackSubmissionAssociations	Retrieve the IDs of all the objects associated to specific feedback submissions objects in HubSpot.
Feedbacksubmissions	Retrieve the available feedback submissions in HubSpot.
LineitemAssociations	Retrieve the IDs of all the objects associated to specific line items objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
Lineitems	Retrieve the available Lineitems in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
Products	Retrieve the available Products in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
QuoteAssociations	Retrieve the IDs of all the objects associated to specific Quotes objects in HubSpot. This table supports only PrivateAppToken authentication.
Quotes	Retrieve the available Quotes in HubSpot. This table supports only PrivateAppToken authentication.
TicketAssociations	Retrieve the IDs of all the objects associated to specific Tickets objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.
Tickets	Retrieve the available Tickets in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

Companies

Retrieve the available Companies in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

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 =, !=, <, <=, >, and >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 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}
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	False		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.
About Us	String	False		True	Short about_company.
ClosedateTimestampEarliestValueA2a17e6e	Datetime	True		True	Calculation context property providing timestamp for rollup property closedate calculated as EARLIEST_VALUE via values of closedate on object type ObjectTypeId_legacyObjectType_CONTACT_
Facebook Fans	Decimal	False		True	Number of Facebook fans.
FirstContactCreatedateTimestampEarliestValue78b50eea	Datetime	True		True	Calculation context property providing timestamp for rollup property first_contact_createdate calculated as EARLIEST_VALUE via values of createdate on object type ObjectTypeId_legacyObjectType_CONTACT_
First Conversion Date	Datetime	True		True	The first conversion date across all contacts associated this company or organization.
FirstConversionDateTimestampEarliestValue61f58f2c	Datetime	True		True	Calculation context property providing timestamp for rollup property first_conversion_date calculated as EARLIEST_VALUE via values of first_conversion_date on object type ObjectTypeId_legacyObjectType_CONTACT_
First Conversion	String	True		True	The first form submitted across all contacts associated this company or organization.
FirstConversionEventNameTimestampEarliestValue68ddae0a	Datetime	True		True	Calculation context property providing timestamp for rollup property first_conversion_event_name calculated as EARLIEST_VALUE via values of first_conversion_event_name on object type ObjectTypeId_legacyObjectType_CONTACT_
First Deal Created Date	Datetime	True		True	Date the first deal was associated with this company record.
Year Founded	String	False		True	The year the company was created. Powered by HubSpot Insights.
Additional Domains	String	False		True	Additional domains belonging to this company.
Business units	String	False		True	The business units this record is assigned to.
Time First Seen	Datetime	True		True	The first activity for any contact associated with this company or organization.
HsAnalyticsFirstTimestampTimestampEarliestValue11e3a63a	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_first_timestamp calculated as EARLIEST_VALUE via values of hs_analytics_first_timestamp on object type ObjectTypeId_legacyObjectType_CONTACT_
First Touch Converting Campaign	String	True		True	The campaign responsible for the first touch creation of the first contact associated with this company.
HsAnalyticsFirstTouchConvertingCampaignTimestampEarliestValue4757fe10	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_first_touch_converting_campaign calculated as EARLIEST_VALUE via values of hs_analytics_first_touch_converting_campaign on object type ObjectTypeId_legacyObjectType_CONTACT_
Time of First Session	Datetime	True		True	Time of first session across all contacts associated with this company or organization.
HsAnalyticsFirstVisitTimestampTimestampEarliestValueAccc17ae	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_first_visit_timestamp calculated as EARLIEST_VALUE via values of hs_analytics_first_visit_timestamp on object type ObjectTypeId_legacyObjectType_CONTACT_
Time Last Seen	Datetime	True		True	Time last seen across all contacts associated with this company or organization.
HsAnalyticsLastTimestampTimestampLatestValue4e16365a	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_last_timestamp calculated as LATEST_VALUE via values of hs_analytics_last_timestamp on object type ObjectTypeId_legacyObjectType_CONTACT_
Last Touch Converting Campaign	String	True		True	The campaign responsible for the last touch creation of the first contact associated with this company.
HsAnalyticsLastTouchConvertingCampaignTimestampLatestValue81a64e30	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_last_touch_converting_campaign calculated as LATEST_VALUE via values of hs_analytics_last_touch_converting_campaign on object type ObjectTypeId_legacyObjectType_CONTACT_
Time of Last Session	Datetime	True		True	Time of the last session attributed to any contacts that are associated with this company record.
HsAnalyticsLastVisitTimestampTimestampLatestValue999a0fce	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_last_visit_timestamp calculated as LATEST_VALUE via values of hs_analytics_last_visit_timestamp on object type ObjectTypeId_legacyObjectType_CONTACT_
Latest Source	String	True		True	Source of the last session attributed to any contacts that are associated with this company.
Latest Source Data 1	String	True		True	Additional source details of the last session attributed to any contacts that are associated with this company.
Latest Source Data 2	String	True		True	Additional source details of the last session attributed to any contacts that are associated with this company.
Latest Source Timestamp	Datetime	True		True	Timestamp of when latest source occurred.
Number of Pageviews	Decimal	True		True	Total number of page views across all contacts associated with this company or organization.
HsAnalyticsNumPageViewsCardinalitySumE46e85b0	Decimal	True		True	Calculation context property providing cardinality for rollup property hs_analytics_num_page_views calculated as SUM via values of hs_analytics_num_page_views on object type ObjectTypeId_legacyObjectType_CONTACT_
Number of Sessions	Decimal	True		True	Total number of sessions across all contacts associated with this company or organization.
HsAnalyticsNumVisitsCardinalitySum53d952a6	Decimal	True		True	Calculation context property providing cardinality for rollup property hs_analytics_num_visits calculated as SUM via values of hs_analytics_num_visits on object type ObjectTypeId_legacyObjectType_CONTACT_
Original Source Type	String	False		True	Original source for the contact with the earliest activity for this company or organization.
Original Source Data 1	String	True		True	Additional information about the original source for the contact with the earliest activity for this company or organization.
HsAnalyticsSourceData1TimestampEarliestValue9b2f1fa1	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_source_data_1 calculated as EARLIEST_VALUE via values of hs_analytics_source_data_1 on object type ObjectTypeId_legacyObjectType_CONTACT_
Original Source Data 2	String	True		True	Additional information about the original source for the contact with the earliest activity for this company or organization.
HsAnalyticsSourceData2TimestampEarliestValue9b2f9400	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_source_data_2 calculated as EARLIEST_VALUE via values of hs_analytics_source_data_2 on object type ObjectTypeId_legacyObjectType_CONTACT_
HsAnalyticsSourceTimestampEarliestValue25a3a52c	Datetime	True		True	Calculation context property providing timestamp for rollup property hs_analytics_source calculated as EARLIEST_VALUE via values of hs_analytics_source on object type ObjectTypeId_legacyObjectType_CONTACT_
Avatar FileManager key	String	True		True	The path in the FileManager CDN for this company's avatar override image. Automatically set by HubSpot.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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 'Customer _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Evangelist _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Opportunity _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Other _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Subscriber _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company entered the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Customer _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Evangelist _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Opportunity _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Other _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Subscriber _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the company exited the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline.
Ideal Customer Profile Tier	String	False		True	How well this company matches your Ideal Customer Profile. Tier 1 means a great fit for your products_services_ Tier 3 might be acceptable_ but low priority.
Target Account	Bool	False		True	Identifies whether this company is being marketed and sold to as part of your account_based strategy.
Last Booked Meeting Date	Datetime	True		True	The last date of booked meetings associated with the company.
Last Logged Call Date	Datetime	True		True	The last date of logged calls associated with the company.
Last Open Task Date	Datetime	True		True	The last due date of open tasks associated with the company.
last sales activity date old	Datetime	True		True	The date of the last sales activity with the company in seconds.
Last Engagement Date	Datetime	True		True	The last time a contact engaged with your site or a form_ document_ meetings link_ or tracked email. This doesn't include marketing emails or emails to multiple contacts.
Last Engagement Type	String	True		True	The type of the last engagement a company performed. This doesn't include marketing emails or emails to multiple contacts.
Last Modified Date	Datetime	True		True	Most recent timestamp of any property update for this company. This includes HubSpot internal properties_ which can be visible or hidden. This property is updated automatically.
Latest create date of active subscriptions	Datetime	True		True	Latest created date of all associated active Subscriptions.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Number of blockers	Decimal	True		True	The number of contacts associated with this company with the role of blocker.
Number of contacts with a buying role	Decimal	True		True	The number of contacts associated with this company with a buying role.
Number of decision makers	Decimal	True		True	The number of contacts associated with this company with the role of decision maker.
Number of open deals	Decimal	True		True	The number of open deals associated with this company.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Pinned Engagement ID	Decimal	True		True	The object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified.
Pipeline	String	False		True	The pipeline with which this company is currently associated.
Likelihood to close	Decimal	True		True	The highest probability that a contact associated with this company will become a customer within the next 90 days. This score is based on standard contact properties and behavior.
HsPredictivecontactscoreV2NextMaxMaxD4e58c1e	Decimal	True		True	Calculation context property providing next_max for rollup property hs_predictivecontactscore_v2 calculated as MAX via values of hs_predictivecontactscore_v2 on object type ObjectTypeId_legacyObjectType_CONTACT_
Read Only Object	Bool	True		True	Is the object read only.
Target Account2	String	False		True	The Target Account property is a means to flag high priority companies if you are following an account based strategy
Target Account Probability	Decimal	True		True	The probability a company is marked as a target account
Target Account Recommendation Snooze Time	Datetime	False		True	The date when the target account recommendation is snoozed.
Target Account Recommendation State	String	False		True	The state of the target account recommendation.
Time in 'Customer _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Evangelist _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Opportunity _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Other _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Subscriber _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the company in the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline.
Total open deal value	Decimal	True		True	The total value_ in your company's currency_ of all open deals associated with this company.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this company.
Is Public	Bool	False		True	Indicates if the company is publicly traded. Powered by HubSpot Insights.
Number of Associated Contacts	Decimal	True		True	The number of contacts associated with this company.
Number of Associated Deals	Decimal	True		True	The number of deals associated with this company.
Number of Form Submissions	Decimal	True		True	The number of forms submission for all contacts associated with this company or organization.
NumConversionEventsCardinalitySumD095f14b	Decimal	True		True	Calculation context property providing cardinality for rollup property num_conversion_events calculated as SUM via values of num_conversion_events on object type ObjectTypeId_legacyObjectType_CONTACT_
Recent Conversion Date	Datetime	True		True	The most recent conversion date across all contacts associated this company or organization.
RecentConversionDateTimestampLatestValue72856da1	Datetime	True		True	Calculation context property providing timestamp for rollup property recent_conversion_date calculated as LATEST_VALUE via values of recent_conversion_date on object type ObjectTypeId_legacyObjectType_CONTACT_
Recent Conversion	String	True		True	The last form submitted across all contacts associated this company or organization.
RecentConversionEventNameTimestampLatestValue66c820bf	Datetime	True		True	Calculation context property providing timestamp for rollup property recent_conversion_event_name calculated as LATEST_VALUE via values of recent_conversion_event_name on object type ObjectTypeId_legacyObjectType_CONTACT_
Recent Deal Amount	Decimal	True		True	The amount of the last deal closed.
Recent Deal Close Date	Datetime	True		True	Date of the last .
Time Zone	String	False		True	Time zone where the company or organization is located. Powered by HubSpot Insights.
Total Money Raised	String	False		True	The total amount of money raised by the company. Powered by HubSpot Insights.
Total Revenue	Decimal	True		True	The total amount of closed won deals.
Company name	String	False		True	The name of the company or organization. Powered by HubSpot Insights.
HubSpot Owner Email	String	False		True	HubSpot owner email for this company or organization.
Twitter Handle	String	False		True	The main twitter account of the company or organization.
HubSpot Owner Name	String	False		True	HubSpot owner name for this company or organization.
Phone Number	String	False		True	Company primary phone number. Powered by HubSpot Insights.
Twitter Bio	String	False		True	The Twitter bio of the company or organization.
Twitter Followers	Decimal	False		True	The number of Twitter followers of the company or organization.
Street Address	String	False		True	Street address of the company or organization_ including unit number. Powered by HubSpot Insights.
Street Address 2	String	False		True	Additional address of the company or organization. Powered by HubSpot Insights.
Facebook Company Page	String	False		True	The URL of the Facebook company page for the company or organization
City	String	False		True	City where the company is located. Powered by HubSpot Insights.
LinkedIn Company Page	String	False		True	The URL of the LinkedIn company page for the company or organization.
LinkedIn Bio	String	False		True	The LinkedIn bio for the company or organization.
State_Region	String	False		True	State or region in which the company or organization is located. Powered by HubSpot Insights.
Google Plus Page	String	False		True	The URL of the Google Plus page for the company or organization.
Date of last meeting booked in meetings tool	Datetime	True		True	Last Meeting Booked for any contact associated with this Company_Organization.
Campaign of last booking in meetings tool	String	True		True	This UTM parameter shows which marketing campaign _e.g. a specific email_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Medium of last booking in meetings tool	String	True		True	This UTM parameter shows which channel _e.g. email_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Source of last booking in meetings tool	String	True		True	This UTM parameter shows which site _e.g. Twitter_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Latest meeting activity	Datetime	True		True	The date of the most recent meeting _past or upcoming_ logged for_ scheduled with_ or booked by a contact associated with this company.
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to by this company.
Company owner	String	False		True	The owner of the company.
Last Contacted	Datetime	True		True	Timestamp of the last call_ email_ or meeting that was logged for a contact at this company.
Last Activity Date	Datetime	True		True	The last time a note_ call_ meeting_ or task was logged for a company. This is set automatically by HubSpot based on user actions in the company record.
Next Activity Date	Datetime	True		True	Date of the next upcoming scheduled sales activity for this company record.
Number of times contacted	Decimal	True		True	The number of times a call_ email or meeting was logged for this company.
Number of Sales Activities	Decimal	True		True	Number of sales activities for this company. For example_ a call_ email or meeting logged.
Postal Code	String	False		True	Postal or zip code of the company or organization. Powered by HubSpot Insights.
Country_Region	String	False		True	Country in which the company or organization is located. Powered by HubSpot Insights.
HubSpot Team	String	True		True	The team of the owner of the company.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
Website URL	String	False		True	The main website of the company or organization. This property is used to identify unique companies. Powered by HubSpot Insights.
Company Domain Name	String	False		True	The domain name of the company or organization.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.
Number of Employees	Decimal	False		True	The total number of employees who work for the company or organization. Powered by HubSpot Insights.
Industry	String	False		True	The type of business the company performs. By default_ this property has approximately 150 pre_defined options to select from. While these options cannot be deleted as they used by HubSpot Insights_ you can add new custom options to meet your needs.
Annual Revenue	Decimal	False		True	The actual or estimated annual revenue of the company. Powered by HubSpot Insights.
Lifecycle Stage	String	False		True	The most advanced lifecycle stage across all contacts associated with this company or organization.
Lead Status	String	False		True	The company's sales_ prospecting or outreach status.
Parent Company	Decimal	True		True	The parent company of this company.
Type	String	False		True	The optional classification of this company record _ prospect_ partner_ etc.
Description	String	False		True	A short statement about the company's mission and goals. Powered by HubSpot Insights.
Number of child companies	Decimal	True		True	The number of child companies of this company.
HubSpot Score	Decimal	True		True	The sales and marketing score for the company or organization.
Create Date	Datetime	True		True	The date the company or organization was added to the database.
Close Date	Datetime	False		True	The date the company or organization was closed as a customer.
First Contact Create Date	Datetime	True		True	The date that the first contact from this company entered the system_ which could pre_date the company's create date.
Days to Close	Decimal	True		True	The number of days between when the company record was created and when they closed as a customer.
Web Technologies	String	False		True	The web technologies used by the company or organization. Powered by HubSpot Insights.

CompanyAssociations

Retrieve the IDs of all the objects associated to specific Deals objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Deals.Id	False	Deals ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Deals 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	AssociationsLabels.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False	AssociationsLabels.Type	False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.

ContactAssociations

Retrieve the IDs of all the objects associated to specific Deals objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

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 returns the Ids of all the records and their corresponding object type associated with a specific Contact record.

SELECT * FROM ContactAssociations

INSERT

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

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

To add a new custom association between a Contact record and a Deals record, you need to also specify the TypeId and Category of the custom association.

INSERT INTO ContactAssociations (Id, AssociationId, Type, TypeId, Category) VALUES ('3432', '34654', 'Deal', '1', 'USER_DEFINED')

DELETE

To delete an existing association between a Contacts record and a Deals record, you need to specify the Ids of the two associated records and the associated deal object Type. Note that, for custom objects, you will need to specify the FullyQualifiedName as the Type.

DELETE [ContactAssociations] WHERE Id = '3432' AND AssociationId = '34654' AND Type = 'Deal'

DELETE

To delete an existing custom association between a Contacts record and a Deals record, you need to also specify the TypeId and Category of the custom association.

DELETE [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	Deals.Id	False	Deals ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Deals 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	AssociationsLabels.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False	AssociationsLabels.Type	False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.

Contacts

Retrieve the available Contacts in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

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, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them. For example:

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

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 Contacts WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Contacts WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Contacts WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Contacts 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 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 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.
Company size	String	False		True	Contact's company size. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Date of birth	String	False		True	Contact's date of birth. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Days To Close	Decimal	True		True	Count of days elapsed between creation and being closed as a customer. Set automatically.
Degree	String	False		True	Contact's degree. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Field of study	String	False		True	Contact's field of study. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
First Conversion Date	Datetime	True		True	Date this contact first submitted a form.
First Conversion	String	True		True	First form this contact submitted.
First Deal Created Date	Datetime	True		True	Date first deal was created for contact. Set automatically.
Gender	String	False		True	Contact's gender. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Graduation date	String	False		True	Contact's graduation date. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Additional email addresses	String	True		True	A set of additional email addresses for a contact.
Business units	String	False		True	The business units this record is assigned to.
All vids for a contact	String	True		True	A set of all vids_ canonical or otherwise_ for a contact.
First Touch Converting Campaign	String	True		True	Campaign responsible for the first touch creation of this contact.
Last Touch Converting Campaign	String	True		True	Campaign responsible for the last touch creation of this contact.
Avatar FileManager key	String	True		True	The path in the FileManager CDN for this contact's avatar override image. Automatically set by HubSpot.
Buying Role	String	False		True	Role the contact plays during the sales process. Contacts can have multiple roles_ and can share roles with others.
All form submissions for a contact	String	True		True	A set of all form submissions for a contact.
Merged vids with timestamps of a contact	String	True		True	Merged vids with timestamps of a contact.
Calculated Mobile Number in International Format	String	True		True	Mobile number in international format.
Calculated Phone Number in International Format	String	True		True	Phone number in international format.
Calculated Phone Number Area Code	String	True		True	Area Code of the calculated phone number.
Calculated Phone Number Country Code	String	True		True	Country code of the calculated phone number.
Calculated Phone Number Region	String	True		True	ISO2 Country code for the derived phone number.
Clicked on a LinkedIn Ad	String	False		True	Whether contact has clicked on a LinkedIn Ad.
Email Confirmed	Bool	True		True	Email Confirmation status of user of Content Membership.
Registration Follow Up Email Enqueued At	Datetime	False		True	The time when the first registration follow up email was enqueued.
Membership Notes	String	False		True	Notes relating to the contact's content membership.
Registered At	Datetime	True		True	Datetime at which this user was set up for Content Membership.
Domain to which registration email was sent	String	True		True	Domain to which the registration invitation email for Content Membership was sent to.
Time registration email was sent	Datetime	True		True	Datetime at which this user was sent a registration invitation email for Content Membership.
Status	String	False		True	Status of the contact's content membership.
Conversations visitor email	String	True		True	A Conversations visitor's email address.
Count of unengaged contacts	Decimal	True		True	if contact is assigned and unworked_ set to 1. if contact is assigned and worked_ set to 0.
Count of engaged contacts	Decimal	True		True	if contact is assigned and worked_ set to 1. if contact is assigned and unworked_ set to 0.
Created By Conversations	Bool	True		True	Flag indicating this contact was created by the Conversations API.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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 'Customer _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Evangelist _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Opportunity _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Other _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date entered 'Subscriber _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact entered the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Customer _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Evangelist _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Opportunity _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Other _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Date exited 'Subscriber _Lifecycle Stage Pipeline_'	Datetime	True		True	The date and time when the contact exited the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline.
Recent Document Revisit Date	Datetime	True		True	The last time a shared document _presentation_ was accessed by this contact.
Invalid email address	Bool	True		True	The email address associated with this contact is invalid.
Email address quarantine reason	String	False		True	The reason why the email address has been quarantined.
Email Domain	String	True		True	A contact's email address domain.
Email hard bounce reason	String	True		True	The issue that caused a contact to hard bounce from your emails. If this is an error or a temporary issue_ you can unbounce this contact from the contact record.
Email hard bounce reason2	String	True		True	The issue that caused a contact to hard bounce from your emails. If this is an error or a temporary issue_ you can unbounce this contact from the contact record.
Email Address Quarantined	Bool	True		True	Indicates that the current email address has been quarantined for anti_abuse reasons and any marketing email sends to it will be blocked. This is automatically set by HubSpot.
Email address automated quarantine reason	String	True		True	The automated reason why the email address has been quarantined.
Email Address Recipient Fatigue Next Available Sending Time	Datetime	True		True	When this recipient has reached the limit of email sends per time period_ this property indicates the next available time to send. This is automatically set by HubSpot.
Sends Since Last Engagement	Decimal	True		True	The number of marketing emails that have been sent to the current email address since the last engagement _open or link click_. This is automatically set by HubSpot.
Marketing email confirmation status	String	True		True	The status of a contact's eligibility to receive marketing email. This is automatically set by HubSpot.
Clicked Facebook ad	Bool	False		True	Whether contact has clicked a Facebook ad.
Facebook click id	String	False		True
Facebook ID	String	False		True	A contact's Facebook id.
Last NPS survey comment	String	True		True	Last NPS survey comment that this contact gave.
Last NPS survey rating	String	True		True	Last NPS survey rating that this contact gave.
Last NPS survey date	Datetime	True		True	The time that this contact last submitted a NPS survey response. This is automatically set by HubSpot.
Should be shown an NPS web survey	Bool	False		True	Whether or not a contact should be shown an NPS web survey. This is automatically set by HubSpot.
ID of first engagement	Decimal	True		True	The object id of the current contact owner's first engagement with the contact. Used in Sales Analytics app.
First subscription create date	Datetime	True		True	The create date of the first subscription by the contact.
Google ad click id	String	False		True
googleplus ID	String	False		True	A contact's googleplus id.
Contact has an active subscription	Decimal	True		True	The rollup property value is 1 when the contact has an active Subscription or 0 otherwise.
IP Timezone	String	True		True	The timezone reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
Is a contact	Bool	True		True	Is a contact_ has not been deleted and is not a visitor.
Contact unworked	Bool	True		True	Contact has not been assigned or has not been engaged after last owner assignment_re_assignment.
last sales activity date old	Datetime	True		True	The date of the last sales activity with the contact. This property is set automatically by HubSpot. Note_ This field is only updated for contacts with an owner.
Last Engagement Date	Datetime	True		True	The last time a contact engaged with your site or a form_ document_ meetings link_ or tracked email. This doesn't include marketing emails or emails to multiple contacts.
Last Engagement Type	String	True		True	The type of the last engagement a contact performed. This doesn't include marketing emails or emails to multiple contacts.
Object last modified date_time	Datetime	True		True	Most recent timestamp of any property update for this contact. This includes HubSpot internal properties_ which can be visible or hidden. This property is updated automatically.
Last sequence ended date	Datetime	True		True	The last sequence ended date.
Last sequence enrolled	Decimal	True		True	The last sequence enrolled.
Last sequence enrolled date	Datetime	True		True	The last sequence enrolled date.
Last sequence finished date	Datetime	True		True	The last sequence finished date.
Last sequence unenrolled date	Datetime	True		True	The last sequence unenrolled date.
Latest Source Date	Date	False		True	The time of the latest session for a contact.
Latest subscription create date	Datetime	True		True	The create date of the latest subscription by the contact.
Lead Status	String	False		True	The contact's sales_ prospecting or outreach status.
Legal basis for processing contact's data	String	False		True	Legal basis for processing contact's data_ 'Not applicable' will exempt the contact from GDPR protections.
Clicked LinkedIn Ad	String	False		True
Linkedin ID	String	False		True	A contact's linkedin id.
Marketing contact status source name	String	True		True	The ID of the activity that set the contact as a marketing contact.
Marketing contact status source type	String	True		True	The type of the activity that set the contact as a marketing contact.
Marketing contact status	String	True		True	The marketing status of a contact.
Marketing contact until next update	String	True		True	Specifies if this contact will be set as non_marketing on renewal.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Pinned engagement ID	Decimal	True		True
Pipeline	String	False		True	The pipeline with which this contact is currently associated.
Likelihood to close	Decimal	True		True	The probability that a contact will become a customer within the next 90 days. This score is based on standard contact properties and behavior.
Contact priority	String	True		True	A ranking system of contacts evenly assigned into four tiers. Contacts in tier one are more likely to become customers than contacts in tier four.
Read Only Object	Bool	True		True	Is the object read only.
Date of first engagement	Datetime	True		True	The date the current contact owner first engaged with the contact. Used in Sales Analytics app.
Description of first engagement	String	True		True	A description of the current contact owner's first engagement with the contact. Used in the Sales Analytics app.
Type of first engagement	String	True		True	The object type of the current contact owner's first engagement with the contact. Used in the Sales Analytics app.
Recent Sales Email Clicked Date	Datetime	True		True	The last time a tracked sales email was clicked by this user.
Recent Sales Email Opened Date	Datetime	True		True	The last time a tracked sales email was opened by this contact. This property does not update for emails that were sent to more than one contact.
Calculated Mobile Number with country code	String	True		True	Mobile number with country code.
Calculated Phone Number with country code	String	True		True	Phone number with country code.
Calculated Mobile Number without country code	String	True		True	Mobile number without country code.
Calculated Phone Number without country code	String	True		True	Phone number without country code.
Number of sequences actively enrolled	Decimal	True		True	The number of sequences actively enrolled.
Number of sequences enrolled	Decimal	True		True	The number of sequences enrolled.
Currently in Sequence	Bool	True		True	A yes_no field that indicates whether the contact is currently in a Sequence.
testpurge	String	True		True	Testing purge.
testrollback	String	True		True	Testing rollback.
Time between contact creation and deal close	Decimal	False		True
Time between contact creation and deal creation	Decimal	False		True
Time in 'Customer _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Evangelist _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Marketing Qualified Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Opportunity _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Other _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Sales Qualified Lead _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline.
Time in 'Subscriber _Lifecycle Stage Pipeline_'	Decimal	True		True	The total time in seconds spent by the contact in the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline.
Lead response time	Decimal	True		True	Time it took current owner to do first qualifying engagement _ms_. Used in Sales Analytics app.
Time to move from lead to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot lead stage to the HubSpot customer stage.
Time to move from marketing qualified lead to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot marketing qualified lead stage to the HubSpot customer stage.
Time to move from opportunity to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot opportunity stage to the HubSpot customer stage.
Time to move from sales qualified lead to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot sales qualified lead stage to the HubSpot customer stage.
Time to move from subscriber to customer	Decimal	False		True	How long it takes for a contact to move from the HubSpot subscriber stage to the HubSpot customer stage.
Time Zone	String	False		True	The contact_s time zone. This can be set automatically by HubSpot based on other contact properties. It can also be set manually for each contact.
Twitter ID	String	False		True	A contact's Twitter id.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
WhatsApp Phone Number	String	False		True	The phone number associated with the contact_s WhatsApp account.
Owner Assigned Date	Datetime	True		True	The most recent date a HubSpot Owner was assigned to a contact. This is set automatically by HubSpot and can be used for segmentation and reporting.
IP City	String	True		True	The city reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP Country	String	True		True	The country reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP Country Code	String	True		True	The country code reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP Latitude _ Longitude	String	True		True
IP State_Region	String	True		True	The state or region reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP State Code_Region Code	String	True		True	The state code or region code reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP Zipcode	String	True		True	The zipcode reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
Job function	String	False		True	Contact's job function. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Last Modified Date	Datetime	True		True	The date any property on this contact was modified.
Marital Status	String	False		True	Contact's marital status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Military status	String	False		True	Contact's military status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Number of Associated Deals	Decimal	True		True	Count of deals associated with this contact. Set automatically by HubSpot.
Number of Form Submissions	Decimal	True		True	The number of forms this contact has submitted.
Number of Unique Forms Submitted	Decimal	True		True	The number of different forms this contact has submitted.
Recent Conversion Date	Datetime	True		True	The date this contact last submitted a form.
Recent Conversion	String	True		True	The last form this contact submitted.
Recent Deal Amount	Decimal	True		True	Amount of last closed won deal associated with a contact. Set automatically.
Recent Deal Close Date	Datetime	True		True	Date last deal associated with contact was closed_won. Set automatically.
Relationship Status	String	False		True	Contact's relationship status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
School	String	False		True	Contact's school. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Seniority	String	False		True	Contact's seniority. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Start date	String	False		True	Contact's start date. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Total Revenue	Decimal	True		True	Sum of all closed_won deal revenue associated with the contact. Set automatically.
Work email	String	False		True	Contact's work email. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
First Name	String	False		True	A contact's first name.
First Page Seen	String	True		True	First page the contact visited on your website. Set automatically.
Marketing emails delivered	Decimal	True		True	The number of marketing emails delivered for the current email address. This is automatically set by HubSpot.
Opted out of emailCustomer Service Communication	String	True		True	Indicates that the current email address has opted out of this email type.
Opted out of emailOne to One	String	True		True	This column is a custom field. Indicates that the current email address has opted out of this email type.
Twitter Username	String	False		True	The contact's Twitter handle.
Currently in workflow	String	True		True	True when contact is enrolled in a workflow.
Follower Count	Decimal	False		True	The number of Twitter followers a contact has.
Last Page Seen	String	True		True	Last page the contact visited on your website. Set automatically.
Marketing emails opened	Decimal	True		True	The number of marketing emails opened for the current email address. This is automatically set by HubSpot.
Last Name	String	False		True	A contact's last name.
Number of Pageviews	Decimal	True		True	Total number of page views this contact has had on your website. Set automatically.
Marketing emails clicked	Decimal	True		True	The number of marketing emails which have had link clicks for the current email address. This is automatically set by HubSpot.
Salutation	String	False		True	The title used to address a contact.
Twitter Profile Photo	String	False		True	The contact's Twitter profile photo. This is set by HubSpot using the contact's email address.
Email	String	False		True	A contact's email address.
Number of Sessions	Decimal	True		True	Number of times a contact has come to your website. Set automatically.
Marketing emails bounced	Decimal	True		True	The number of marketing emails that bounced for the current email address. This is automatically set by HubSpot.
Persona	String	False		True	A contact's persona.
Most Recent Social Click	Datetime	True		True	The date of the most recent click on a published social message. This is set automatically by HubSpot for each contact.
Number of event completions	Decimal	True		True	Total number of events for this contact. Set automatically.
Unsubscribed from all email	Bool	True		True	Indicates that the current email address has opted out of all email.
Twitter Clicks	Decimal	True		True	The number of times a contact clicked on links you shared on Twitter through HubSpot. This is set automatically by HubSpot and can be used for segmentation.
Mobile Phone Number	String	False		True	A contact's mobile phone number.
Phone Number	String	False		True	A contact's primary phone number.
Fax Number	String	False		True	A contact's primary fax number.
Time First Seen	Datetime	True		True	First time the contact has been seen. Set automatically.
Last marketing email name	String	True		True	The name of the last marketing email sent to the current email address. This is automatically set by HubSpot.
Last marketing email send date	Datetime	True		True	The date of the most recent delivery for any marketing email to the current email address. This is automatically set by HubSpot.
Facebook Clicks	Decimal	True		True	The number clicks on links shared on Facebook.
Street Address	String	False		True	Contact's street address_ including apartment or unit number.
Date of last meeting booked in meetings tool	Datetime	True		True	The date of the last meeting that has been scheduled by a contact through the meetings tool. If multiple meetings have been scheduled_ the date of the last chronological meeting in the timeline is shown.
Campaign of last booking in meetings tool	String	True		True	UTM parameter for marketing campaign _e.g. a specific email_ responsible for recent meeting booking. Only populated when tracking parameters are included in meeting link.
Medium of last booking in meetings tool	String	True		True	UTM parameter for the channel _e.g. email_ responsible for most recent meeting booking. Only populated when tracking parameters are included in meeting link.
Source of last booking in meetings tool	String	True		True	UTM parameter for the site _e.g. Twitter_ responsible for most recent meeting booking. Only populated when tracking parameters are included in meeting link.
Time of First Session	Datetime	True		True	First time the contact visited your website. Set automatically.
Last marketing email open date	Datetime	True		True	The date of the most recent open for any marketing email to the current email address. This is automatically set by HubSpot.
Latest meeting activity	Datetime	True		True	The date of the most recent meeting _past or upcoming_ logged for_ scheduled with_ or booked by this contact.
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to by this user. This is set automatically by HubSpot based on user actions in the contact record.
LinkedIn Clicks	Decimal	True		True	The number clicks on links shared on LinkedIn.
Contact owner	String	False		True	The owner of a contact. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
Last Contacted	Datetime	True		True	The last time a call_ email_ or meeting was logged for a contact. This is set automatically by HubSpot based on user actions in the contact record.
Last Activity Date	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a contact. This is set automatically by HubSpot based on user actions in the contact record.
Next Activity Date	Datetime	True		True	The date of the next upcoming activity for a contact. This is set automatically by HubSpot based on user actions in the contact record.
Number of times contacted	Decimal	True		True	The number of times a call_ email_ or meeting was logged for a contact. This is set automatically by HubSpot based on user actions in the contact record.
Number of Sales Activities	Decimal	True		True	The number of sales activities for a contact. This is set automatically by HubSpot based on user actions in the contact record.
HubSpot Owner Email _legacy_	String	False		True	A legacy property used to identify the email address of the owner of the contact. This property is no longer in use.
HubSpot Owner Name _legacy_	String	False		True	A legacy property used to identify the name of the owner of the contact. This property is no longer in use.
SurveyMonkey Event Last Updated	Decimal	True		True	This field is meaningless on its own_ and is solely used for triggering dynamic list updates when SurveyMonkey information is updated.
Webinar Event Last Updated	Decimal	True		True	This field is meaningless on its own_ and is solely used for triggering dynamic list updates when webinar information is updated.
City	String	False		True	A contact's city of residence.
Time Last Seen	Datetime	True		True	Timestamp for most recent webpage view on your website.
Last marketing email click date	Datetime	True		True	The date of the most recent link click for any marketing email to the current email address. This is automatically set by HubSpot.
Google Plus Clicks	Decimal	True		True	The number clicks on links shared on Google Plus.
HubSpot Team	String	True		True	The team of the owner of a contact.
LinkedIn Bio	String	False		True	A contact's LinkedIn bio.
Twitter Bio	String	False		True	The contact's Twitter bio. This is set by HubSpot using the contact's email address.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
Time of Last Session	Datetime	True		True	Timestamp for start of the most recent session for this contact to your website.
First marketing email send date	Datetime	True		True	The date of the earliest delivery for any marketing email to the current email address. This is automatically set by HubSpot.
Broadcast Clicks	Decimal	True		True	The number of clicks on published social messages. This is set automatically by HubSpot for each contact.
State_Region	String	False		True	The contact's state of residence. This might be set via import_ form_ or integration.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
Original Source	String	False		True	First known source the contact used to find your website. Set automatically_ but may be updated manually.
First marketing email open date	Datetime	True		True	The date of the earliest open for any marketing email to the current email address. This is automatically set by HubSpot.
Latest Source	String	False		True	The source of the latest session for a contact.
Postal Code	String	False		True	The contact's zip code. This might be set via import_ form_ or integration.
Country_Region	String	False		True	The contact's country_region of residence. This might be set via import_ form_ or integration.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.
Original Source DrillDown 1	String	True		True	Additional information about the source the contact used to find your website. Set automatically.
First marketing email click date	Datetime	True		True	The date of the earliest link click for any marketing email to the current email address. This is automatically set by HubSpot.
Latest Source DrillDown 1	String	True		True	Additional information about the latest source for the last session the contact used to find your website. Set automatically.
LinkedIn Connections	Decimal	False		True	How many LinkedIn connections they have.
Original Source DrillDown 2	String	True		True	Additional information about the source the contact used to find your website. Set automatically.
Is globally ineligible	Bool	True		True	Indicates the contact is globally ineligible for email.
Preferred language	String	False		True	Set your contact's preferred language for communications. This property can be changed from an import_ form_ or integration.
Latest Source DrillDown 2	String	True		True	Additional information about the source for the last session the contact used to find your website. Set automatically.
Klout Score	Decimal	False		True	A contact's Klout score_ a measure of Internet influence.
First Referring Site	String	True		True	URL that referred the contact to your website. Set automatically.
First marketing email reply date	Datetime	True		True	The date of the earliest reply for any marketing email to the current email address. This is automatically set by HubSpot.
Job Title	String	False		True	A contact's job title.
Photo	String	False		True	Social Media photo.
Last Referring Site	String	True		True	Last URL that referred contact to your website. Set automatically.
Last marketing email reply date	Datetime	True		True	The date of the latest reply for any marketing email to the current email address. This is automatically set by HubSpot.
Message	String	False		True	A default property to be used for any message or comments a contact may want to leave on a form.
Close Date	Datetime	False		True	Date the contact became a customer. Set automatically when a deal or opportunity is marked as closed_won. It can also be set manually or programmatically.
Average Pageviews	Decimal	True		True	Average number of pageviews per session for this contact. Set automatically.
Marketing emails replied	Decimal	True		True	The number of marketing emails replied to by the current email address. This is automatically set by HubSpot.
Event Revenue	Decimal	True		True	Set event revenue on a contact though the Enterprise Events feature. http___help.hubspot.com_articles_KCS_Article_Reports_How_do_I_create_Events_in_HubSpot
Became a Lead Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Lead. This is automatically set by HubSpot for each contact.
Became a Marketing Qualified Lead Date	Datetime	True		True	The date when a contact's lifecycle stage changed to MQL. This is automatically set by HubSpot for each contact.
Became an Opportunity Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Opportunity. This is automatically set by HubSpot for each contact.
Lifecycle Stage	String	False		True	The qualification of contacts to sales readiness. It can be set through imports_ forms_ workflows_ and manually on a per contact basis.
Became a Sales Qualified Lead Date	Datetime	True		True	The date when a contact's lifecycle stage changed to SQL. This is automatically set by HubSpot for each contact.
Create Date	Datetime	True		True	The date that a contact entered the system.
Became an Evangelist Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Evangelist. This is automatically set by HubSpot for each contact.
Became a Customer Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Customer. This is automatically set by HubSpot for each contact.
HubSpot Score	Decimal	True		True	The number that shows qualification of contacts to sales readiness. It can be set in HubSpot's Lead Scoring app.
Company Name	String	False		True	Name of the contact's company. This can be set independently from the name property on the contact's associated company.
Became a Subscriber Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Subscriber. This is automatically set by HubSpot for each contact.
Became an Other Lifecycle Date	Datetime	True		True	The date when a contact's lifecycle stage changed to Other. This is automatically set by HubSpot for each contact.
Website URL	String	False		True	Associated company website.
Number of Employees	String	False		True	The number of company employees.
Annual Revenue	String	False		True	Annual company revenue.
Industry	String	False		True	The Industry a contact is in.
Primary Associated Company ID	Decimal	False		True	HubSpot defined ID of a contact's primary associated company in HubSpot.
Associated Company Last Updated	Decimal	True		True	This field is meaningless on its own_ and is solely used for triggering dynamic list updates when a company is updated.
Lead Rating	String	True		True	The rating of this contact based on their predictive lead score.
Predictive Lead Score	Decimal	True		True	A score calculated by HubSpot that represents a contact's likelihood to become a customer.

DealAssociations

Retrieve the IDs of all the objects associated to specific Deals objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Deals.Id	False	Deals ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Deals 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	AssociationsLabels.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False	AssociationsLabels.Type	False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.

Deals

Retrieve the available Deals in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 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}
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	False		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.
Amount in company currency	Decimal	True		True	The amount of the deal_ using the exchange rate_ in your company's currency.
Days to close	Decimal	True		True	The number of days the deal took to close.
Currency	String	False		True	Currency code for the deal.
Annual contract value	Decimal	True		True	The annual contract value _ACV_ of this deal.
Business units	String	False		True	The business units this record is assigned to.
Deal Collaborator	String	True		True	Owner ids of the users involved in closing the deal.
Deal Split Users	String	True		True	The owner ids of all associated Deal Splits. This property is set automatically by HubSpot.
Latest Source	String	True		True	Source for the contact either directly or indirectly associated with the last session activity for this deal.
Latest Source Company	String	True		True	Source for the company with an associated contact with the last session activity for this deal.
Latest Source Contact	String	True		True	Source for the directly associated contact with the last session activity for this deal.
Latest Source Data 1	String	True		True	Additional source details of the last session attributed to any contacts that are directly or indirectly associated with this deal.
Latest Source Data 1 Company	String	True		True	Additional source details of the last session attributed to any contacts that are indirectly associated with this deal _via a company association_.
Latest Source Data 1 Contact	String	True		True	Additional source details of the last session attributed to any contacts that are directly associated with this deal.
Latest Source Data 2	String	True		True	Additional source details of the last session attributed to any contacts that are directly or indirectly associated with this deal.
Latest Source Data 2 Company	String	True		True	Additional source details of the last session attributed to any contacts that are indirectly associated with this deal.
Latest Source Data 2 Contact	String	True		True	Additional source details of the last session attributed to any contacts that are directly associated with this deal.
Latest Source Timestamp	Datetime	True		True	Timestamp of when latest source occurred for either a directly or indirectly associated contact.
Latest Source Timestamp Company	Datetime	True		True	Timestamp of when latest source occurred for an indirectly associated contact.
Latest Source Timestamp Contact	Datetime	True		True	Timestamp of when latest source occurred for a directly associated contact.
Original Source Type	String	False		True	Original source for the contact with the earliest activity for this deal.
Original Source Data 1	String	True		True	Additional information about the original source for the associated contact_ or associated company if there is no contact_ with the oldest value for the Time first seen property.
Original Source Data 2	String	True		True	Additional information about the original source for the associated contact_ or associated company if there is no contact_ with the oldest value for the Time first seen property.
Annual recurring revenue	Decimal	True		True	The annual recurring revenue _ARR_ of this deal.
HubSpot Campaign	String	False		True	The marketing campaign the deal is associated with.
Closed Deal Amount	Decimal	True		True	Returns the amount if the deal is closed. Else_ returns 0.
Closed Deal Amount In Home Currency	Decimal	True		True	Returns the amount in home currency if the deal is closed. Else_ returns 0.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Date entered 'Appointment Scheduled _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline.
Date entered 'Closed Lost _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Closed Lost' stage_ 'Sales Pipeline' pipeline.
Date entered 'Closed Won _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Closed Won' stage_ 'Sales Pipeline' pipeline.
Date entered 'Contract Sent _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Contract Sent' stage_ 'Sales Pipeline' pipeline.
Date entered 'Decision Maker BoughtIn _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Decision Maker Bought_In' stage_ 'Sales Pipeline' pipeline.
Date entered 'Presentation Scheduled _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline.
Date entered 'Qualified To Buy _Sales Pipeline_'	Datetime	True		True	The date and time when the deal entered the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline.
Date exited 'Appointment Scheduled _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline.
Date exited 'Closed Lost _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Closed Lost' stage_ 'Sales Pipeline' pipeline.
Date exited 'Closed Won _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Closed Won' stage_ 'Sales Pipeline' pipeline.
Date exited 'Contract Sent _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Contract Sent' stage_ 'Sales Pipeline' pipeline.
Date exited 'Decision Maker BoughtIn _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Decision Maker Bought_In' stage_ 'Sales Pipeline' pipeline.
Date exited 'Presentation Scheduled _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline.
Date exited 'Qualified To Buy _Sales Pipeline_'	Datetime	True		True	The date and time when the deal exited the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline.
Deal amount calculation preference	String	False		True	Specifies how deal amount should be calculated from line items.
Deal probability	Decimal	False		True	The probability a deal will close. This defaults to the deal stage probability setting.
Deal stage probability shadow	Decimal	True		True	Fall back property for calculating the deal stage when no customer override exist. Probability between 0 and 1 of deal stage. Defaults to 0 for unknown deal stages.
Exchange rate	Decimal	True		True	This is the exchange rate used to convert the deal amount into your company currency.
Forecast amount	Decimal	True		True	The custom forecasted deal value calculated by multiplying the forecast probability and deal amount in your company_s currency.
Forecast probability	Decimal	False		True	The custom percent probability a deal will close.
Is Deal Closed_	Bool	True		True	True if the deal was won or lost.
Is Closed Won	Bool	True		True	True if the deal is in the closed won state_ false otherwise.
Deal Split Added	Bool	True		True	Indicates if the deal is split between multiple users.
Last Modified Date	Datetime	True		True	Most recent timestamp of any property update for this deal. This includes HubSpot internal properties_ which can be visible or hidden. This property is updated automatically.
Likelihood to close by the close date	Decimal	True		True	Hubspot predicted likelihood between 0 and 1 of the deal to close by the close date.
Global Term Line Item Discount Percentage	String	False		True	For internal HubSpot Application use only. Global term for the discount percentage applied.
Global Term Line Item Discount Percentage Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for the discount percentage is enabled.
Global Term Line Item Recurring Billing Period	String	False		True	For internal HubSpot Application use only. Global term for product recurring billing duration.
Global Term Line Item Recurring Billing Period Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for product recurring billing duration is enabled.
Global Term Line Item Recurring Billing Start Date	String	False		True	For internal HubSpot Application use only. Global term for recurring billing start date for a line item.
Global Term Line Item Recurring Billing Start Date Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for recurring billing start date for a line item is enabled.
Global Term Line Item Recurring Billing Frequency	String	False		True	For internal HubSpot Application use only. Global term for how frequently the product is billed.
Global Term Line Item Recurring Billing Frequency Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for how frequently the product is billed is enabled.
Forecast category	String	False		True	The likelihood a deal will close. This property is used for manual forecasting your deals.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Monthly recurring revenue	Decimal	True		True	The monthly recurring revenue _MRR_ of this deal.
Next step	String	False		True	A short description of the next step for the deal.
Number of Active Deal Registrations	Decimal	True		True	The number of active deal registrations associated with this deal. This property is set automatically by HubSpot.
Number of Deal Registrations	Decimal	True		True	The number of deal registrations associated with this deal. This property is set automatically by HubSpot.
Number of Deal Splits	Decimal	True		True	The number of deal splits associated with this deal. This property is set automatically by HubSpot.
Number of target accounts	Decimal	True		True	The number of target account companies associated with this deal. This property is set automatically by HubSpot.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Pinned Engagement ID	Decimal	True		True	The object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified.
The predicted deal amount	Decimal	True		True	Returns the multiplication of the deal amount times the predicted likelihood of the deal to close by the close date.
The predicted deal amount in your company's currency	Decimal	True		True	Returns the multiplication of the deal amount in your company's currency times the predicted likelihood of the deal to close by the close date.
Priority	String	False		True
Weighted amount	Decimal	True		True	Returns the multiplication of the amount times the probability of the deal closing.
Weighted amount in company currency	Decimal	True		True	Returns the multiplication of the amount in home currency times the probability of the deal closing.
Read Only Object	Bool	True		True	Is the object read only.
Total contract value	Decimal	True		True	The total contract value _TCV_ of this deal.
Time in 'Appointment Scheduled _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline.
Time in 'Closed Lost _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Closed Lost' stage_ 'Sales Pipeline' pipeline.
Time in 'Closed Won _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Closed Won' stage_ 'Sales Pipeline' pipeline.
Time in 'Contract Sent _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Contract Sent' stage_ 'Sales Pipeline' pipeline.
Time in 'Decision Maker BoughtIn _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Decision Maker Bought_In' stage_ 'Sales Pipeline' pipeline.
Time in 'Presentation Scheduled _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline.
Time in 'Qualified To Buy _Sales Pipeline_'	Decimal	True		True	The total time in seconds spent by the deal in the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner Assigned Date	Datetime	True		True	The date the most recent deal owner was assigned to a deal. This is updated automatically by HubSpot.
Deal Name	String	False		True	The name given to this deal.
Amount	Decimal	False		True	The total amount of the deal.
Deal Stage	String	False		True	The stage of the deal. Deal stages allow you to categorize and track the progress of the deals that you are working on.
Pipeline	String	False		True	The pipeline the deal is in. This determines which stages are options for the deal.
Close Date	Datetime	False		True	Date the deal was closed. This property is set automatically by HubSpot.
Create Date	Datetime	False		True	Date the deal was created. This property is set automatically by HubSpot.
Date of last meeting booked in meetings tool	Datetime	True		True	The date of the most recent meeting an associated contact has booked through the meetings tool.
Campaign of last booking in meetings tool	String	True		True	This UTM parameter shows which marketing campaign _e.g. a specific email_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Medium of last booking in meetings tool	String	True		True	This UTM parameter shows which channel _e.g. email_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Source of last booking in meetings tool	String	True		True	This UTM parameter shows which site _e.g. Twitter_ referred an associated contact to the meetings tool for their most recent booking. This property is only populated when you add tracking parameters to your meeting link.
Latest meeting activity	Datetime	True		True	The date of the most recent meeting _past or upcoming_ logged for_ scheduled with_ or booked by a contact associated with this deal.
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to for this deal.
Deal owner	String	False		True	User the deal is assigned to. Assign additional users to a deal record by creating a custom user property.
Last Contacted	Datetime	True		True	The last time a call_ sales email_ or meeting was logged for this deal. This is set automatically by HubSpot based on user actions.
Last Activity Date	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a deal. This is updated automatically by HubSpot.
Next Activity Date	Datetime	True		True	The date of the next upcoming activity for a deal. 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.
Number of times contacted	Decimal	True		True	The total number of sales activities _notes_ calls_ emails_ meetings_ or tasks_ logged for a deal. This is updated automatically by HubSpot.
Number of Sales Activities	Decimal	True		True	The total number of times a sales email or call has been logged for a deal. This is updated automatically by HubSpot.
HubSpot Create Date	Datetime	True		True	The date the deal was created. This property is set automatically by HubSpot.
HubSpot Team	String	True		True	Primary team of the deal owner. This property is set automatically by HubSpot.
Deal Type	String	False		True	The type of deal. By default_ categorize your deal as either a New Business or Existing Business.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
Deal Description	String	False		True	Description of the deal.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.
Number of Associated Contacts	Decimal	True		True	The number of contacts associated with this deal. This property is set automatically by HubSpot.
Closed Lost Reason	String	False		True	Reason why this deal was lost.
Closed Won Reason	String	False		True	Reason why this deal was won.

EngagementsCalls

Retrieve the available Calls in HubSpot.

SELECT

When selecting Call Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operator 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	False		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.
Call and meeting type	String	False		True	The activity type of the engagement.
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement.
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement.
Call notes preview	String	True		True	A truncated preview of the call notes.
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview.
Body Preview Truncated	Bool	True		True	Indicates if the engagement body was truncated for the preview.
Integrating App ID	Decimal	False		True	The App ID associated with the integrating app.
Authenticated recording files url provider	String	True		True	URL which returns Authenticated audio_video URL of the recording.
Call notes	String	False		True	The body of the call.
Callee object id	Decimal	False		True	The id of the callee.
Callee object type	String	False		True	The type of callee.
Call direction	String	False		True	The direction of a call.
Call outcome	String	False		True	The outcome of the call.
Call duration	Decimal	False		True	The duration of the call_ in milliseconds.
External Account ID	String	False		True	External Account ID.
External ID	String	False		True	The external ID of the call.
From Number	String	False		True	The phone number of the person that initiated the call.
From Number Name	String	True		True	The name of the phone number that initiated the call.
Transcript Available	Bool	False		True	Flag to indicate if the call has an associated transcript.
Voicemail Available	String	True		True	Flag to indicate if the call has an associated voicemail.
Recording URL	String	False		True	The URL of the recorded call audio.
Call Source	String	False		True	The source of the call to differentiate VoIP vs Video Conferencing Apps.
Call status	String	False		True	The status of the call.
Call Title	String	False		True	The title of the call.
To Number	String	False		True	The phone number of the person that was called.
To Number Name	String	True		True	The name of the phone number that was called.
Tracked terms	String	True		True	A list of any tracked terms contained in the call transcript.
Call transcription id	Decimal	False		True	The id of the transcription.
Video url	String	False		True	Video URL of the recording.
Unique Zoom Meeting ID	String	False		True	The Zoom meeting unique identifier of the call.
Calls Service Call ID	Decimal	True		True	The Calls Service specific global unique identifier for a call.
Activity created by	Decimal	True		True	The user who created the engagement.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date that an engagement was created.
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.
Follow up action	String	False		True	What action should be performed during follow up.
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request.
Last modified date	Datetime	True		True	The date any property on this engagement was modified.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated by	Decimal	True		True	The user who last updated the engagement.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement.
Queue Memberships	String	False		True	The list of queues that contain this engagement.
Read Only Object	Bool	True		True	Is the object read only.
Activity date	Datetime	False		True	The date that an engagement occurred.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Unique ID	String	False		True	The unique ID of the engagement.
Unknown Visitor Conversation	Bool	False		True	Whether or not this communication was made with an unknown visitor.
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement.
Activity assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.

EngagementsEmails

Retrieve the available Emails in HubSpot.

SELECT

When selecting Email Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operator 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	False		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.
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement.
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement.
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 if the engagement body was truncated for the preview.
Activity created by	String	True		True	The user who created the engagement.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date that an engagement was created.
Email direction and unique ID	String	True		True	The direction and unique ID of the email.
Attached Video	String	False		True	The ID of a video optionally attached to an email.
Attached Video Name	String	False		True	The name of a video optionally attached to an email.
Attached Video Opened	Bool	False		True	Has the video attachment been opened.
Attached Video Watched	Bool	False		True	Has the video attachement been watched.
Email BCC Address	String	True		True	Email addresses of the email's BCC recipients.
Email BCC First Name	String	True		True	First names of the email's BCC recipients.
Email BCC Last Name	String	True		True	Last names of the email's BCC recipients.
Email BCC	String	True		True	Raw header values of the email's BCC recipients.
Email Bounce Error Detail Message	String	False		True	The message from the bounce error.
Email Bounce Error Detail Status Code	Decimal	False		True	The status code from the bounce error.
Email CC Address	String	True		True	Email addresses of the email's CC recipients.
Email CC First Name	String	True		True	First names of the email's CC recipients.
Email CC Last Name	String	True		True	Last names of the email's CC recipients.
Email CC	String	True		True	Raw header values of the email's CC recipients.
Email Direction	String	False		True	The direction the email was sent in.
Encoded Email Associations Request	String	True		True	Encoded email associations request.
Error Message	String	False		True	The error that occurred while sending the email.
Email Send Id	String	True		True	The ID of the email send event sent through Facsimile.
Email From Address	String	True		True	Email address of the email's sender.
Email From First Name	String	True		True	First name of the email's sender.
Email From Last Name	String	True		True	Last name of the email's sender.
Email From	String	True		True	Raw header value of the email's sender.
Email Headers	String	False		True	The sender and receivers of the email.
Email body	String	False		True	This is the body of any email sent from a record. It doesn't include emails received from contacts.
Logged From	String	False		True	Where the email was logged.
Media Processing Status	String	False		True	Processing status for this email's images and attachments.
Email is member of forwarded subthread	Bool	False		True	Whether this email is a member of a forwarded subthread.
Message ID	String	False		True	The ID of the message.
EmailMigratedViaPortalDataMigration	String	False		True	Indicates that the email was migrated from another portal using DataMigration tool.
Email pending inline image file IDs	String	False		True	File IDs of pending inline images in the email's HTML.
PostSend Status	String	False		True	A description of what happened to the email _successful send_ bounced_ dropped_ and why.
RecipientDrop Reasons	String	False		True	A list of the dropped recipients paired with the reason each was dropped.
Email Send Event Id	String	False		True	The ID of the email send event.
Email Send Event Id Created	Datetime	False		True	The date when the email send event ID was created.
Email Sender Address	String	True		True	Email address of the email's sender.
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 of the email's sender.
Sent Via	String	False		True	How the email was sent.
Email send status	String	False		True	The send status of the email.
Email subject	String	False		True	The subject of the email.
Text	String	False		True	The plaintext of the email.
Thread ID	String	False		True	The thread that the email belongs to.
Email To Address	String	True		True	Email addresses of the email's recipients.
Email To First Name	String	True		True	First names of the email's recipients.
Email To Last Name	String	True		True	Last names of the email's recipients.
Email To	String	True		True	Raw header values of the email's recipients.
Tracker Key	String	False		True	The tracker key of the email.
Validation Skipped	String	False		True	Validation skipped that would have otherwise rejected logging.
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.
Follow up action	String	False		True	What action should be performed during follow up.
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request.
Last modified date	Datetime	True		True	The date any property on this engagement was modified.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated by	String	True		True	The user who last updated the engagement.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement.
Queue Memberships	String	False		True	The list of queues that contain this engagement.
Read Only Object	Bool	True		True	Is the object read only.
Activity date	Datetime	False		True	The date that an engagement occurred.
Unique creation key	String	True		True	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 that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement.
Activity assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.

EngagementsMeetings

Retrieve the available Meetings in HubSpot.

SELECT

When selecting Meeting Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operator 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	False		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.
Call and meeting type	String	False		True	The activity type of the engagement.
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement.
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement.
HubSpot attendee owner IDs	String	False		True	List of HubSpot owner IDs for additional attendees.
Body preview	String	True		True	A truncated preview of the engagegement body.
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview.
Body Preview Truncated	Bool	True		True	Indicates if the engagement body was truncated for the preview.
Activity created by	Decimal	True		True	The user who created the engagement.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date that an engagement was created.
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.
Follow up action	String	False		True	What action should be performed during follow up.
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request.
iCalUid	String	True		True	The iCalUid of the synced event.
Internal Meeting Notes	String	False		True
Last modified date	Datetime	True		True	The date any property on this engagement was modified.
Meeting description	String	False		True	The text description of the meeting.
Meeting calendar event hash	String	False		True	The unique hash for the meeting.
Meeting change id	String	False		True	The unique change id for the meeting.
Created From Link ID	String	False		True	Created From Link ID.
Meeting end time	Datetime	False		True	The date when the meeting ends.
External URL	String	False		True	The external URL for the meeting.
Meeting location	String	False		True	Where the meeting takes place.
Location type	String	False		True	The type of location for the meeting event.
Meeting outcome	String	False		True	The outcome of this meeting.
Payments session id	String	False		True	The payments session id for the meeting.
PreMeeting prospect reminders	String	False		True	A list of dates when meeting reminders should be sent to prospects.
Meeting source	String	True		True	The source where the meeting was booked.
Source ID	String	False		True	The source ID of the meeting.
Meeting start time	Datetime	False		True	The date when the meeting starts.
Meeting name	String	False		True	The title of the meeting.
Web conference meeting ID	String	False		True	The meeting ID of the web conference.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated by	Decimal	True		True	The user who last updated the engagement.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement.
Queue Memberships	String	False		True	The list of queues that contain this engagement.
Read Only Object	Bool	True		True	Is the object read only.
Scheduled tasks	String	True		True
Activity date	Datetime	False		True	The date that an engagement occurred.
Unique creation key	String	True		True	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 that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement.
Activity assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.

EngagementsNotes

Retrieve the available Notes in HubSpot.

SELECT

When selecting Note Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operator 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	False		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.
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement.
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement.
Body preview	String	True		True	A truncated preview of the engagegement body.
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview.
Body Preview Truncated	Bool	True		True	Indicates if the engagement body was truncated for the preview.
Activity created by	Decimal	True		True	The user who created the engagement.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date that an engagement was created.
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.
Follow up action	String	False		True	What action should be performed during follow up.
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request.
Last modified date	Datetime	True		True	The date any property on this engagement was modified.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated by	Decimal	True		True	The user who last updated the engagement.
Note body	String	False		True	The body of the note.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement.
Queue Memberships	String	False		True	The list of queues that contain this engagement.
Read Only Object	Bool	True		True	Is the object read only.
Activity date	Datetime	False		True	The date that an engagement occurred.
Unique creation key	String	True		True	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 that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement.
Activity assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.

EngagementsTasks

Retrieve the available Tasks in HubSpot.

SELECT

When selecting Task Engagements, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operator 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	False		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.
Business units	String	False		True	The business units this record is assigned to.
AtMentioned Owner Ids	String	False		True	The owners that have been at_mentioned on the engagement.
Attached file IDs	String	False		True	The IDs of the files that are attached to the engagement.
Notes _preview_	String	True		True	A plain_text preview of the notes field on a task.
HTML Body Preview	String	True		True	The HTML representation of the engagement body preview.
Body Preview Truncated	Bool	True		True	Indicates if the engagement body was truncated for the preview.
Calendar Event ID	String	True		True	The event ID for the synced task.
Created by	Decimal	True		True	The user who created the engagement.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Created at	Datetime	True		True	The date that an engagement was created.
Source	String	False		True	The source that created this engagement.
Source ID	String	False		True	The specific ID of the process that created this engagement.
Follow up action	String	False		True	What action should be performed during follow up.
GDPR deleted	Bool	True		True	Indicates the body of this engagement has been cleared because of a GDPR delete request.
Last modified at	Datetime	True		True	The date any property on this engagement was modified.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Last modified by	Decimal	True		True	The user who last updated the engagement.
MS Teams message ID	String	True		True	The message ID for the created task.
Associated Companies	Decimal	True		True	The number of companies associated with this task.
Associated Contacts	Decimal	True		True	The number of contacts associated with this task.
Associated Deals	Decimal	True		True	The number of deals associated with this task.
Associated Queue Objects	Decimal	True		True	The number of objects associated with this task that support task queues.
Associated Tickets	Decimal	True		True	The number of tickets associated with this task.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product name	String	False		True	The name of the product associated with this engagement.
Queue	String	False		True	The list of queues that contain this engagement.
Read Only Object	Bool	True		True	Is the object read only.
Task repeat status	String	True		True	Indicates whether the task is currently repeating .
Scheduled tasks	String	True		True
Notes	String	False		True	The content in the notes field on a task.
Completed at	Datetime	True		True	The date that the task was completed.
Contact Time Zone	String	True		True	The time zone of the associated contact.
For Object Type	String	False		True	The object type for the task.
Task is all day	Bool	False		True	Determines if the task is due all day or at a specific time.
Last contacted	Datetime	True		True	The last time a call_ email_ or meeting was logged for the associated contact. This is set automatically by HubSpot based on user actions in the contact record.
Last engagement	Datetime	True		True	The date of the last sales activity with the associated contact. This is set automatically by HubSpot based on user actions in the contact record.
Priority	String	False		True	The priority of the task.
Task probability to complete	Decimal	True		True	The probability the task will be completed.
Relative Task Reminders	String	False		True	The dates _relative to the due date_ when reminders will be sent.
Reminder	String	False		True	The dates when reminders will be sent.
Interval	String	True		True	How often the task should repeat.
Send Default Reminder	Bool	False		True	Whether or not a reminder should be sent when the task is due.
Sequence Enrollment Is Active	Bool	True		True	Whether the sequence enrollment this task is a part of is currently active.
Sequence step enrollment Id	String	True		True	The id of the sequence step that created the task.
Sequence step number	Decimal	True		True	The order of this task in the sequence at time of enrollment.
Task Status	String	False		True	The status of the task.
Task Title	String	False		True	The subject text for the task.
Task template id	Decimal	True		True	The id of template the task was created from.
Task Type	String	False		True	The type of task.
Due date	Datetime	False		True	The date that an engagement occurred.
Unique creation key	String	True		True	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 that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner Assigned Date	Datetime	True		True	The timestamp when an owner was assigned to this engagement.
Assigned to	String	False		True	The user that the activity is assigned to in HubSpot. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
HubSpot Team	String	True		True	The team of the owner of an engagement.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.

FeedbackSubmissionAssociations

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

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Deals.Id	False	Deals ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Deals 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	AssociationsLabels.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False	AssociationsLabels.Type	False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.

Feedbacksubmissions

Retrieve the available feedback submissions in HubSpot.

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 contacts, they can be filtered by columns marked below as 'Filterable'. For those columns, the supported server-side operators are =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 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 Contacts WHERE {Column} = {Value} AND {Column} < {Value} AND {Column} > {Value}
SELECT * FROM Contacts WHERE {Column} != {Value} AND {Column} >= {Value} AND {Column} <= {Value}
SELECT * FROM Contacts WHERE ({Column} = {Value} AND {Column} = {Value}) OR ({Column} != {Value} AND {Column} >= {Value})
SELECT * FROM Contacts 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	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False		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.
Agent email	String	True		True	Conversation agent's email.
Agent responsible for the conversation	Decimal	True		True	Agent responsible for the conversation which led to the feedback.
Agent name	String	True		True	Conversation agent's full name.
All accessible team IDs	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.
Business units	String	False		True	The business units this record is assigned to.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
Chatflow ID	Decimal	True		True	Chatflow ID of the conversation associated to the submission.
Chatflow name	String	True		True	The name of the chatflow associated to the submission.
Chatflow object id	Decimal	True		True	Chatflow object id of the conversation associated to the submission.
Contact first name	String	True		True	First name of the contact associated with the submission.
Contact Id	Decimal	True		True	The id of the contact most recently associated with this submission.
Contact last name	String	True		True	Last name of the contact associated with the submission.
Conversation thread id	Decimal	True		True	Thread id of the conversation associated to the submission.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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.
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 object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Read Only Object	Bool	True		True	Is the object read only.
Tag IDs	String	True		True	Tag IDs assigned to this submission.
Tags	String	True		True	Tags assigned to this submission.
Ticket id	Decimal	True		True	ID of the ticket associated with the submission.
Ticket owner avatar uri	String	True		True	Avatar URI of the ticket associated to the feedback's owner.
Ticket owner	Decimal	True		True	User the ticket is assigned to which is associated to feedback submission.
Ticket name	String	True		True	Short summary of ticket associated with the submission.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner Assigned Date	Datetime	True		True	The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
Owner	String	False		True	The owner of the object.
HubSpot Team	String	True		True	The primary team of the owner.
Industry Standard Question Type	String	True		True	Industry standard question type for custom surveys.
Sentiment	String	True		True	This column is a custom field. Sentiment of feedback submission based on survey type.
Survey ID	Decimal	True		True	The survey id that the feedback submission is linked with.
Survey Type	String	True		True	The type of the survey.
Source	String	True		True	The channel of the survey when the feedback submission occurred.
Date	Datetime	True		True	The timestamp of the feedback submission.
Rating	Decimal	True		True	The value of the feedback submission.
Feedback sentiment	String	True		True	The sentiment of the feedback submission.
Response	String	False		True	The follow_up response of the feedback submission.
Ingestion id	String	True		True	The identifier we use when we initially capture a feedback submission.
Knowledge article id	Decimal	True		True	The id of the knowledge article this submission was for.
Visitor id	Decimal	True		True	The id of the visitor who submitted this feedback.
Engagement id	Decimal	True		True	The id of the equivalent engagement object.
Submission URL	String	True		True	The URL of the page the submission was made from.
Survey Name	String	True		True	The name of the feedback survey the submission is linked with.
Form guid	String	True		True	The form guid that the feedback submission is linked with.
Email	String	True		True	The email of the contact associated with a feedback submission.
Submission Name	String	True		True	The email of the contact associated with a feedback submission.

LineitemAssociations

Retrieve the IDs of all the objects associated to specific line items objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Deals.Id	False	Deals ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Deals 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	AssociationsLabels.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False	AssociationsLabels.Type	False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.

Lineitems

Retrieve the available Lineitems in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them. For example:

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}
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	False		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.
Net price	Decimal	True		True	The amount of a line item.
Create Date	Datetime	False		True	The date the line item was created.
Description	String	False		True	Full description of product.
Unit discount	Decimal	False		True	The discount amount applied.
Annual contract value	Decimal	True		True	The annual contract value _ACV_ of this product.
All accessible team IDs	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.
Business units	String	False		True	The business units this record is assigned to.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
Allow buyer selected quantity	String	True		True	Whether buyer selected quantity is to be enabled or not for a LineItem.
Annual recurring revenue	Decimal	True		True	The annual recurring revenue _ARR_ of this product.
Delayed billing start by days	Decimal	False		True	Number of days billing should be delayed by. It allows the customers to start billing sometime in the future.
Delayed billing start by months	Decimal	False		True	Number of months billing should be delayed by. It allows the customers to start billing sometime in the future.
Start billing terms	String	True		True	The type of billing start delay. It can be a fixed date in the future_ relative delay in number of days or months.
Unit cost	Decimal	False		True	The amount that sold goods cost the HubSpot customer.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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.
Discount Percentage	Decimal	False		True	The discount percentage applied.
External LineItem id	Decimal	True		True	The ID of a line item.
Image URL	String	False		True	Product images.
Last Modified Date	Datetime	True		True	The date any property on this product was modified.
Currency	String	False		True	Currency code for the line item.
Margin	Decimal	True		True	The margin value of this product.
Annual contract value margin	Decimal	True		True	The margin annual contract value of this product.
Annual recurring revenue margin	Decimal	True		True	The margin annual recurring revenue of this product.
Monthly recurring revenue margin	Decimal	True		True	The margin monthly recurring revenue of this product.
Total contract value margin	Decimal	True		True	The margin total contract value of this product.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Monthly recurring revenue	Decimal	True		True	The monthly recurring revenue _MRR_ of this product.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Position on quote	Decimal	False		True	The order which the line item appears on the quotes.
Pre Discount Amount	Decimal	True		True	The pre_discount amount of a line item.
Product ID	Decimal	False		True	ID of the product this was copied from.
Read Only Object	Bool	True		True	Is the object read only.
End Date	Date	True		True	Recurring billing end date for a line item.
Number of payments	Decimal	True		True	Number of payments for the given period on a Line Item.
Term	String	False		True	Product recurring billing duration.
Billing start date	Date	False		True	Recurring billing start date for a line item.
Billing terms	String	True		True	If there are fixed number payments or it goes on until cancelled.
SKU	String	False		True	Unique product identifier.
Sync amount	Decimal	True		True	The amount set by Ecommerce sync.
Total contract value	Decimal	True		True	The total contract value _TCV_ of this product.
Term in months	Decimal	True		True	The number of months in the term of this product.
Calculated Total Discount	Decimal	True		True	Calculated total Discount for the line item taking in consideration the flat amount and discount percentage.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
URL	String	False		True	Product url.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Variant id of the product	Decimal	True		True	Varient id of the shopify product.
Owner Assigned Date	Datetime	True		True	The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
Owner	String	False		True	The owner of the object.
HubSpot Team	String	True		True	The primary team of the owner.
Name	String	False		True	Product name.
Unit price	Decimal	False		True	Cost of product.
Quantity	Decimal	False		True	How many units of a product are in this line item.
Billing frequency	String	False		True	How often a line item with recurring billing is billed. It informs the pricing calculation for deals and quotes. Line items with one_time billing aren_t included.
Tax	Decimal	False		True	The tax amount applied.

Products

Retrieve the available Products in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them. For example:

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}
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	False		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.
Net price	Decimal	True		True	Internal placeholder _to prevent conflicts with line item property of same name_.
Create Date	Datetime	False		True	The date the product was created.
Product description	String	False		True	Full description of product.
Unit discount	Decimal	False		True	The discount amount applied.
All accessible team IDs	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.
Business units	String	False		True	The business units this record is assigned to.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
Avatar FileManager key	String	True		True	The path in the FileManager CDN for this product's image. Automatically set by HubSpot.
Unit cost	Decimal	False		True	The amount that sold goods cost the HubSpot customer.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
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.
Discount Percentage	Decimal	False		True	The discount percentage applied.
Folder Id	Decimal	False		True	The ID of the folder that has this product.
Image Url	String	False		True	Product images.
Last Modified Date	Datetime	True		True	The date any property on this product was modified.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product Type	String	False		True	The type of product. By default_ categorize your product as either Inventory_ Non_Inventory or Service.
Read Only Object	Bool	True		True	Is the object read only.
Term	String	False		True	Product recurring billing duration.
Start Date	Date	False		True	Recurring billing start date for a line item.
SKU	String	False		True	Unique product identifier.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
URL	String	False		True	Product url.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner Assigned Date	Datetime	True		True	The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
Owner	String	False		True	The owner of the object.
HubSpot Team	String	True		True	The primary team of the owner.
Name	String	False		True	Product name.
Unit price	Decimal	False		True	Cost of product.
Quantity	Decimal	True		True	Internal placeholder _to prevent conflicts with line item property of same name_.
Recurring billing frequency	String	False		True	How often a product with recurring billing is billed. It informs the pricing calculation for deals and quotes. Products with one_time billing aren_t included.
Tax	Decimal	False		True	The tax amount applied.

QuoteAssociations

Retrieve the IDs of all the objects associated to specific Quotes objects in HubSpot. This table supports only PrivateAppToken authentication.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Deals.Id	False	Deals ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Deals 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	AssociationsLabels.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False	AssociationsLabels.Type	False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.

Quotes

Retrieve the available Quotes in HubSpot. This table supports only PrivateAppToken authentication.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 AND operators inside of them. For example:

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}
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	False		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.
Business units	String	False		True	The business units this record is assigned to.
Allowed Payment Methods	String	False		True	Accepted forms of payment if quote is using HubSpot Payment.
Quote Approver	String	False		True
Collect Billing Address	Bool	False		True	Indicates if billing address should be collected with this quote.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Create date	Datetime	True		True	The date the quote was created.
Quote Domain	String	False		True	Domain this quote should be served from.
ESign Date	Datetime	True		True	The date and time the document was signed by all signers.
Expiration Template Path	String	False		True	Path of the expiration template for the quote.
Quote approval feedback	String	False		True	Feedback about this quote during the approval process.
Language	String	False		True	The language for displaying this quote publicly.
Last modified date	Datetime	True		True	The last time any property on the quote was modified.
Global Term Line Item Discount Percentage	String	False		True	For internal HubSpot Application use only. Global term for the discount percentage applied.
Global Term Line Item Discount Percentage Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for the discount percentage is enabled.
Global Term Line Item Recurring Billing Period	String	False		True	For internal HubSpot Application use only. Global term for product recurring billing duration.
Global Term Line Item Recurring Billing Period Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for product recurring billing duration is enabled.
Global Term Line Item Recurring Billing Start Date	String	False		True	For internal HubSpot Application use only. Global term for recurring billing start date for a line item.
Global Term Line Item Recurring Billing Start Date Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for recurring billing start date for a line item is enabled.
Global Term Line Item Recurring Billing Frequency	String	False		True	For internal HubSpot Application use only. Global term for how frequently the product is billed.
Global Term Line Item Recurring Billing Frequency Enabled	Bool	False		True	For internal HubSpot Application use only. Indicates if the Global term for how frequently the product is billed is enabled.
Locale	String	False		True	The locale for displaying this quote publicly.
Locked	Bool	True		True	Indicates if this quote is locked and can never be updated.
Merged object IDs	String	True		True	The list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Payment date	Datetime	True		True	The date the quote was paid by the customer.
Payment Status	String	True		True	Payment status for the quote.
Payment Type	String	False		True	Payment type for the quote if payment is enabled.
Quote PDF download link	String	True		True	The link to download a pdf of a quote.
Proposal Domain	String	True		True	Domain this proposal should be served from.
Proposal Slug	String	True		True	Path to serve this proposal from.
Proposal Template	String	False		True	Template Path this proposal is rendered with.
Public URL key	String	True		True	Key for accessing quote document URL.
Quote Total Preference	String	False		True	What LineItem property will be used to calculate the Quote Amount.
Read Only Object	Bool	True		True	Is the object read only.
Sender image URL	String	False		True	URL to image of the sender avatar image to be set on the quote.
Quote Slug	String	False		True	Path to serve this quote from.
Template Type	String	False		True	Whether this Quote is rendered with the default templates.
Test mode	Bool	False		True	Indicates if the quote is in test mode.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner assigned date	Datetime	True		True	The date an owner was assigned to the quote.
Sender company name	String	False		True	The name of the company sending this quote.
Sender first name	String	False		True	First name of the sender of this quote.
Quote title	String	False		True	The title of this quote.
Expiration date	Datetime	False		True	The date that this quote expires.
Sender company domain	String	False		True	The domain of the company sending this quote.
Sender last name	String	False		True	Last name of the sender of this quote.
Comments to buyer	String	False		True	Comments to the buyer.
Sender company street address	String	False		True	The street address of the company sending this quote.
Sender email	String	False		True	Email address of the sender of this quote.
Sender company street address 2	String	False		True	The second line of the street address of the company sending this quote.
Sender phone number	String	False		True	Phone number of the sender of this quote.
Terms	String	False		True	Any relevant information about pricing_ purchasing terms_ and_or master agreements.
Logo URL	String	False		True	URL to image of the logo displayed on the quote.
Sender company city	String	False		True	The city in which the company sending this quote is located.
Sender job title	String	False		True	Job title of the sender of this quote.
Sender company state_region	String	False		True	The state_region in which the company sending this quote is located.
Space for written signature	Bool	False		True	Indicates if the quote document should have a place for a written signature.
Branding color	String	False		True	Color value used on the quote document.
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to for this quote.
Sender company postal code	String	False		True	The zip code in which the company sending this quote is located.
Space for written countersignature	Bool	False		True	Indicates if the quote document should have a place for a written countersignature.
Quote owner	String	False		True	The owner of the quote.
Last Contacted	Datetime	True		True	The last timestamp when a call_ email or meeting was logged for this quote.
Last Activity Date	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a quote. This is set automatically by HubSpot based on user actions in the quote record.
Next Activity Date	Datetime	True		True	The date of the next upcoming activity for this quote.
Number of times contacted	Decimal	True		True	The number of times a call_ email or meeting was logged for this quote.
Number of Sales Activities	Decimal	True		True	Number of sales activities for this quote.
Currency	String	False		True	Currency code for the quote.
Sender company country	String	False		True	The country in which the company sending this quote is located.
HubSpot team	String	True		True	The name of the team associated with the owner of the quote.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
Sender company image URL	String	False		True	URL to image of the sender company image to be set on the quote.
Time zone	String	False		True	Timezone for displaying dates on the quote.
All team ids	String	True		True	The team ids corresponding to all owner referencing properties for this object_ both default and custom.
Payment enabled	Bool	False		True	Indicates if payment can be collected via the quote link.
All accessible team ids	String	True		True	The team ids_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.
ESign enabled	Bool	False		True	Indicates if esign is enabled for quote.
Associated Deals	Decimal	True		True	The number of deals associated with this quote. This is set automatically by HubSpot.
ESign number of signers required	Decimal	True		True	Total number of signers required for this quote to be fully signed.
Legacy Quote Template	String	False		True	The legacy quote template used to generate a quote. These templates will be sunset on Dec. 12th 2022.
ESign completed signatures	Decimal	True		True	Number of completed signatures collected so far.
Quote amount	Decimal	True		True	The total due for the quote.
Quote approval status	String	False		True	Approval status of the quote.
Quote number	String	False		True	Reference number shown on quote document.
Collect shipping address	Bool	False		True	Indicates if shipping address should be collected with this quote.

TicketAssociations

Retrieve the IDs of all the objects associated to specific Tickets objects in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

Columns


Name	Type	ReadOnly	References	Filterable	Description
Id [KEY]	Long	False	Deals.Id	False	Deals ID.
AssociationId [KEY]	Long	False		False	ID of the object that this Deals 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	AssociationsLabels.Id	False	The numeric ID for the association type. This column is empty for more general associations queries.
Category [KEY]	String	False	AssociationsLabels.Type	False	The category of the association type for the specified object pair. This column is empty for more generic associations queries.

Tickets

Retrieve the available Tickets in HubSpot. This table supports both OAuth and PrivateAppToken authentication.

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 =, !=, <, <=, >, >=. Further filtering is available using AND and OR combinations. A maximum of 2 OR operators are supported server-side, with each of these operators supporting up to 2 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}
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	False		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.
Close date	Datetime	False		True	The date the ticket was closed.
Created by	Decimal	False		True	VID of contact that created the ticket.
Create date	Datetime	False		True	The date the ticket was created.
First agent email response date	Datetime	True		True	The date of the first email response from an agent after a ticket was created.
Business units	String	False		True	The business units this record is assigned to.
Assignment Method	String	False		True	defines how the Object Assignment is done.
AutoGenerated from thread id	Decimal	True		True	Thread that this ticket was automatically created for using ticket rules.
Originating Conversations Message Id	String	False		True	Conversations Message Id of the message that originated this ticket.
Conversations originating thread id	Decimal	False		True	Thread that this ticket was originally created for.
Created by user ID	Decimal	True		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
HubSpot create date	Datetime	True		True	Internal read_only property representing the date the ticket was created in HubSpot.
Custom inbox ID	Decimal	False		True	ID of the custom inbox the ticket is associated with.
Date entered 'New _Support Pipeline_'	Datetime	True		True	The date and time when the ticket entered the 'New' stage_ 'Support Pipeline' pipeline.
Date entered 'Waiting on contact _Support Pipeline_'	Datetime	True		True	The date and time when the ticket entered the 'Waiting on contact' stage_ 'Support Pipeline' pipeline.
Date entered 'Waiting on us _Support Pipeline_'	Datetime	True		True	The date and time when the ticket entered the 'Waiting on us' stage_ 'Support Pipeline' pipeline.
Date entered 'Closed _Support Pipeline_'	Datetime	True		True	The date and time when the ticket entered the 'Closed' stage_ 'Support Pipeline' pipeline.
Date exited 'New _Support Pipeline_'	Datetime	True		True	The date and time when the ticket exited the 'New' stage_ 'Support Pipeline' pipeline.
Date exited 'Waiting on contact _Support Pipeline_'	Datetime	True		True	The date and time when the ticket exited the 'Waiting on contact' stage_ 'Support Pipeline' pipeline.
Date exited 'Waiting on us _Support Pipeline_'	Datetime	True		True	The date and time when the ticket exited the 'Waiting on us' stage_ 'Support Pipeline' pipeline.
Date exited 'Closed _Support Pipeline_'	Datetime	True		True	The date and time when the ticket exited the 'Closed' stage_ 'Support Pipeline' pipeline.
External object ids	String	False		True	Unique ids corresponding to tickets in a system outside of HubSpot.
Last CES survey comment	String	True		True	Last CES survey comment that this contact gave for this ticket.
Last CES survey rating	String	True		True	Last CES survey rating that this contact gave for this ticket.
Last CES survey date	Datetime	True		True	The time that this contact last submitted a CES survey response. This is automatically set by HubSpot.
File upload	String	False		True	Files attached to a support form by a contact.
First agent response date	Datetime	True		True	The date of the first response from an agent out of all associated conversations.
In Help Desk	Bool	False		True	Is this Ticket rendered in the Help Desk.
Inbox ID	Decimal	True		True	Inbox the ticket is in.
Last email activity	String	True		True	The type of the last email activity with the contact associated with the ticket.
Last email date	Datetime	True		True	The date of the last email activity with the contact associated with the ticket.
Last message received date	Datetime	True		True	The date of the last response from the visitor.
Last response date	Datetime	True		True	The date of the last response from an agent or bot.
Last activity date	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a ticket. This is updated automatically by HubSpot.
Last contacted date	Datetime	True		True	The last time a call_ chat conversation_ LinkedIn message_ postal mail_ meeting_ sales email_ SMS_ or WhatsApp message was logged for a ticket. This is set automatically by HubSpot based on user actions in the ticket record.
Last modified date	Datetime	True		True	Most recent timestamp of any property update for this ticket. This includes HubSpot internal properties_ which can be visible or hidden. This property is updated automatically.
Latest message seen by agent ids	String	True		True	Agents who have seen the newest message across all conversations associated to the ticket.
Merged ticket ids	String	True		True	All ticket ids for this ticket.
Microsoft Teams message ID for this ticket.	String	True		True	Microsoft Teams message ID for this ticket.
Next activity date	Datetime	True		True	The date of the next upcoming activity for a ticket. This property is set automatically by HubSpot based on user action. This includes logging a future call_ 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.
Number of Associated Companies	Decimal	True		True	Number of companies associated with this ticket.
Number of times contacted	Decimal	True		True	The number of times a call_ email_ or meeting was logged on the ticket.
Record ID	Decimal	True		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Originating channel account	String	True		True	First channel account used when conversation was started.
Originating email engagement id	Decimal	True		True	Engagement id of the email originating this ticket.
Originating channel type	String	True		True	The channel the conversation is in.
Pinned Engagement ID	Decimal	True		True	The object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified.
Pipeline	String	False		True	The pipeline that contains this ticket.
Ticket status	String	False		True	The pipeline stage that contains this ticket.
Read Only Object	Bool	True		True	Is the object read only.
Resolution	String	False		True	The action taken to resolve the ticket.
Thread IDs To Restore	String	False		True	Thread IDs _from cv_threads_ used to implement custom cascading delete_restore.
Category	String	False		True	Main reason customer reached out for help.
Ticket ID	Decimal	True		True	The unique id for this ticket. This unique id is automatically populated by HubSpot.
Priority	String	False		True	The level of attention needed on the ticket.
Time in 'New _Support Pipeline_'	Decimal	True		True	The total time in seconds spent by the ticket in the 'New' stage_ 'Support Pipeline' pipeline.
Time in 'Waiting on contact _Support Pipeline_'	Decimal	True		True	The total time in seconds spent by the ticket in the 'Waiting on contact' stage_ 'Support Pipeline' pipeline.
Time in 'Waiting on us _Support Pipeline_'	Decimal	True		True	The total time in seconds spent by the ticket in the 'Waiting on us' stage_ 'Support Pipeline' pipeline.
Time in 'Closed _Support Pipeline_'	Decimal	True		True	The total time in seconds spent by the ticket in the 'Closed' stage_ 'Support Pipeline' pipeline.
Time to Close SLA Due Date	Datetime	True		True	When the ticket falls out of Time to Close SLA.
Time to Close SLA Ticket Status	String	True		True	Current Time to Close SLA status of ticket.
Time to First Response SLA Due Date	Datetime	True		True	When the ticket falls out of the Time to First Response SLA.
Time to First Response SLA Status	String	True		True	Current Time to First Response SLA status.
Unique creation key	String	True		True	Unique property used for idempotent creates.
Updated by user ID	Decimal	True		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followers	String	True		True	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		True	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		True	The user IDs of all owners of this object.
Owner assigned date	Datetime	True		True	The date an owner was assigned to the ticket.
Date of last engagement	Datetime	True		True	The date of the last reply or note.
Last customer reply date	Datetime	True		True	The date of the last customer response.
NPS follow up	String	False		True	Answer to NPS follow up question.
NPS follow up question	Decimal	False		True	Specific version of NPS follow up question that was asked.
Conversation NPS score	String	False		True	NPS score received after ticket resolution.
Reference to email thread	String	False		True	The id of an email thread with ticket conversation.
Time to close	Decimal	True		True	The time between when the ticket was created and closed.
Time to first agent email reply	Decimal	True		True	The time from the ticket create date to the first agent email reply.
Ticket name	String	False		True	Short summary of ticket.
Ticket description	String	False		True	Description of the ticket.
Source	String	False		True	Channel where ticket was originally submitted.
Reference to sourceSpecific object	String	False		True	The id of a connected source object.
Tags	String	False		True	Tags associated with your tickets.
Recent Sales Email Replied Date	Datetime	True		True	The last time a tracked sales email was replied to for this ticket.
Ticket owner	String	False		True	User the ticket is assigned to. Assign additional users to a ticket record by creating a custom user property.
Last Contacted _Ticket Note_	Datetime	True		True	The last timestamp when a call_ email or meeting was logged for this ticket.
Last Activity Date _Ticket Note_	Datetime	True		True	The last time a note_ call_ email_ meeting_ or task was logged for a ticket. This is set automatically by HubSpot based on user actions in the ticket record.
Next Activity Date _Ticket Note_	Datetime	True		True	The date of the next upcoming activity for this ticket.
Number of times contacted _Ticket Note_	Decimal	True		True	The number of times a call_ email or meeting was logged for this ticket.
Number of Sales Activities	Decimal	True		True	Number of sales activities for this ticket.
HubSpot team	String	True		True	Primary team of the ticket owner. This property is set automatically by HubSpot.
All owner ids	String	True		True	The value of all owner referencing properties for this object_ both default and custom.
All team ids	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.
All accessible team ids	String	True		True	The team IDs_ including up the team hierarchy_ corresponding to all owner referencing properties for this object_ both default and custom.

ビュー

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

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

HubSpot Connector for CData Sync ビュー


Name	Description
AssociationsLabels	Retrieve all available association types between a pair of CRM objects.
CompanyPropertiesHistory	Retrieve the available Company properties history in HubSpot.
ContactPropertiesHistory	Retrieve the available Contact properties history in HubSpot.
DealPropertiesHistory	Retrieve the available Deal properties history in HubSpot.
Goals	Retrieve the available Goals in HubSpot.
TicketPropertiesHistory	Retrieve the available ticket properties history in HubSpot.

AssociationsLabels

Retrieve all available association types between a pair of CRM objects.

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 ID for the association type.
Category [KEY]	String			The category of the association type for the specified object pair.
Label	String			The name of the association type for the specified object pair.
FromObjectType [KEY]	String		True	The first object's type to retrieve association types for.
ToObjectType [KEY]	String		True	The second object's type to retrieve association types for.

CompanyPropertiesHistory

Retrieve the available Company properties history in HubSpot.

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The name of the property.
Value	String		False	The historical value of the property.
SourceType	String		False	The method by which the property was changed.
SourceId	String		False	Additional data related to the source. May not be populated for all sources.
Timestamp	Datetime		False	Datetime when the property was updated.

ContactPropertiesHistory

Retrieve the available Contact properties history in HubSpot.

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The name of the property.
Value	String		False	The historical value of the property.
SourceType	String		False	The method by which the property was changed.
SourceId	String		False	Additional data related to the source. May not be populated for all sources.
Timestamp	Datetime		False	Datetime when the property was updated.

DealPropertiesHistory

Retrieve the available Deal properties history in HubSpot.

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The name of the property.
Value	String		False	The historical value of the property.
SourceType	String		False	The method by which the property was changed.
SourceId	String		False	Additional data related to the source. May not be populated for all sources.
Timestamp	Datetime		False	Datetime when the property was updated.

Goals

Retrieve the available Goals in HubSpot.

Columns


Name	Type	References	Filterable	Description
Id [KEY]	Long		True	Unique identifier of the object.
Archived	Bool		False	Whether the object is archived or not.
CreatedAt	Datetime		False	When the object was created.
UpdatedAt	Datetime		False	When the object was last updated.
MigrationSoftDeleteDeprecated	String		True	Describes if the goal target can be treated as deleted.
Ad account asset IDs	String		True	A list of ';'-separated universally unique IDs of ad accounts, each formatted: {AD_NETWORK}-{ACCOUNT_ID}
Ad campaign asset ids	String		True	A list of ';'-separated universally unique IDs of ad campaigns, each formatted: {NETWORK}-{CAMPAIGN_ID}
All teams	String		True	The team IDs, including up the team hierarchy, corresponding to all owner referencing properties for this object, both default and custom.
Business units	String		True	The business units this record is assigned to.
All owner ids	String		True	The value of all owner referencing properties for this object, both default and custom.
Team ids	String		True	Which team owns the goal (there should only ever be one team).
Assignee team ID	Decimal		True	The team ID of the assigned team of the goal (unpopulated if the goal is not team-assigned or team-by-user-assigned).
Assignee user ID	Decimal		True	The user ID of the assigned user of the goal (unpopulated if the goal is not user-assigned).
Campaign asset ids	String		True	List of marketing campaign asset ids.
Contact lifecycle stage	String		True	The lifecycle stage selected for the contact lifecycle goal.
Created by user ID	Decimal		True	The user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date/time	Datetime		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		True	DEPRECATED - DO NOT USE! Code for the currency conversion.
Currency Exchange Rate	Decimal		True	Exchange rate to be used for calculated properties reflecting currency-based values in home currencies. Value is automatically set for in-progress goals. Once a goal has ended, the value should be alterable by admins only.
Deal pipelines	String		True	A serialized list of DEAL pipeline IDs used to filter the KPI value calculation.
Edit updates notification frequency	String		True	The frequency of goal edit update notifications.
End date	Date		True	The last day covered by the Goal Target's date range.
End datetime	Datetime		True	The last day covered by the Goal Target's date range.
Fiscal year offset	Decimal		True	Represents the number of months the fiscal year is away from a standard calendar year (0 means the fiscal year starts in January).
Goal name	String		True	The name of the goal.
Goal target currency code	String		True	Currency code for the goal target.
Goal Target Group ID	Decimal		True	Object ID of the associated Goal Target Group.
Goal type	String		True	The goal type.
Group correlation UUID	String		True	Unique ID set on all Goal Targets and Goal Target Groups created by a single request.
Is forecastable	String		True	READ ME! (kind of) indicates whether the goal should appear in the forecasting app - this property may be true even if the goal should NOT appear in the forecasting app. As of April 2023, this property will be true if hs_milestone is either \\“monthly\\” or \\“quarterly\\“, and if the count of pipelines in hs_pipelines 0 or 1. No other checks are made!
IsLegacy	String		True	Describes if the object was created during the migration process and it comes from the old app.
KPI Display Unit	String		True	Display units for goals based on duration properties.
KpiFilterGroups	String		True	Filter groups for KPI calculations.
KPI is team rollup	Bool		True	Indicates whether this is a rollup goal: whether the KPI allows contributions from child teams (in addition to the assigned team).
KpiMetricType	String		True	Type of metric used to aggregate the property name.
KpiObjectType	String		True	The name of the CrmObject the KPI values are based on.
Kpi object type id	String		True	The ObjectTypeId of the object the KPI values are based on.
KpiPropertyName	String		True	Name of the property on the object type aggregated as the KPI value.
KpiSingleObjectCustomGoalTypeName	String		True	Single object custom goal components (metric type, object type, property name).
KpiTimePeriodProperty	String		True	Time period property.
KpiTrackingMethod	String		True	Tracking method for progress directionality.
Kpi unit type	String		True	Unit type of the kpi calculation.
KPI value	Decimal		True	The latest KPI value for this goal target.
KPI value calculated at	Decimal		True	The time that latest KPI value was calculated.
KPI value last calculated at	Datetime		True	The time that latest KPI value was calculated.
Object last modified date/time	Datetime		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.
LegacyActive	String		True	Migrated value describing if the goal is active or soft deleted.
LegacyCreatedAt	Decimal		True	Migrated value of created at.
LegacyCreatedBy	Decimal		True	Migrated value of created by.
LegacyQuarterlyTargetCompositeId	String		True	Concatenated value of the 3 sql_ids that form a quarterly GT separated by a '-'. Used to be able to update both monthly and quarterly legacy Goal Targets.
LegacySqlId	Decimal		True	Id of the migrated goal target in the old system. This has been deprecated for legacy_unique_sql_id.
LegacyUniqueSqlId	Decimal		True	Id of the migrated goal target in the old system. This property has a unique value to ensure no duplicate migrated goals.
LegacyUpdatedAt	Decimal		True	Migrated value of updated at.
LegacyUpdatedBy	Decimal		True	Migrated value of updated by.
Merged record IDs	String		True	The list of record IDs that have been merged into this record. This value is automatically set by HubSpot and may not be modified.
MigrationSoftDelete	String		True	Describes if the goal target can be treated as deleted.
Milestone	String		True	The period during which a Goal Target is active.
Record ID	Decimal		True	The unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Record Creation Source	String		True	Source (PropertySource) that created this object record.
Record Creation Source ID	String		True	The sourceId -- further detail -- of the source that created this object record.
Record Creation Source User ID	Decimal		True	User ID of the user who initiated creation of this object record.
Outcome	String		True	Goal Target outcome.
Owner ids of all owners	String		True	The owner IDs of all owners of this object.
Participant type	String		True	The type of participant for the Goal Target.
Pipeline ids	String		True	List of deal pipelines that the quota applies to. Used to calculate kpi values.
Pipelines	String		True	A serialized list of pipeline IDs used to filter the KPI value calculation.
Progress updates notification frequency	String		True	The frequency of goal progress update notifications.
Read Only Object	Bool		True	Is the object read only.
Notify on goal achieved	String		True	Opt into notifications when goal is achieved.
Notify with goal edit updates	String		True	Opt into goal edit update notifications.
Notify on goal exceeded	String		True	Opt into notifications when goal is exceeded.
Notify on goal kickoff	String		True	Opt into notifications when a goal is kicked off.
Notify on goal missed	String		True	Opt into notifications when a goal is missed.
Notify with progress updates	String		True	Opt into goal progress updates notifications.
ShouldRecalculate	String		True	Property used to flag Goal targets that need to be recalculated.
Start datetime	Datetime		True	The first day that goal target's date range covers.
Static KPI Filter Groups	String		True	Goal Target Filter Group(s) for all filters except time-based filters.
Status	String		True	The status of the Goal Target.
Status display order	Decimal		True	The goal status display order.
Target amount	Decimal		True	The target amount for this goal target.
Target amount in company currency	Decimal		True	The amount of the goal target, using the exchange rate, in your company's currency.
Team ID	Decimal		True	The team ID associated with the Goal Target.
Ticket pipelines	String		True	A serialized list of TICKET pipeline IDs used to filter the KPI value calculation.
Unique creation key	String		True	Unique property used for idempotent creates.
Updated by user ID	Decimal		True	The user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User ID	Decimal		True	The user ID associated with the Goal Target.
User IDs of all notification followers	String		True	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	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	The user IDs of all owners of this object.
Performed in an import	Bool		True	Object is part of an import.
Owner Assigned Date	Datetime		True	The most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
Owner	String		True	The owner of the object.
HubSpot Team	String		True	The primary team of the owner.
Start date	Date		True	The first day that goal target's date range covers.
Kpi progress percent	Decimal		True	Progress percent is represented by the kpi value as a percent of the target amount.

TicketPropertiesHistory

Retrieve the available ticket properties history in HubSpot.

Columns


Name	Type	References	Filterable	Description
PropertyName	String		False	The name of the property.
Value	String		False	The historical value of the property.
SourceType	String		False	The method by which the property was changed.
SourceId	String		False	Additional data related to the source. May not be populated for all sources.
Timestamp	Datetime		False	Datetime when the property was updated.

データ型マッピング

Data Type Mappings

The Sync App 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	The type of authentication to use when connecting to HubSpot.
Schema	Specify the HubSpot API version to use. HUBSPOTV3 is the new API.
OAuthOptionalScopes	A comma-separated set of optional scopes that give you permissions to your HubSpot account.
OAuthRequiredScopes	A comma-separated set of permissions that your Hubspot app needs access to.

OAuth

プロパティ	説明
OAuthAccessToken	OAuth を使用して接続するためのアクセストークン。

SSL

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

Firewall

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

Proxy

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

Logging

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

Schema

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Miscellaneous

プロパティ	説明
Archived	Specify whether to get archived or unarchived records.
CallPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Calls table.
ColumnSizes	A file with a name=value comma separated list of column sizes.
CompanyPropertiesFile	A file with a comma separated list of properties to select from HubSpot for the Companies table.
ContactPropertiesFile	A file with a comma separated list of properties to select from HubSpot for the Contacts table.
DealPropertiesFile	A file with a comma separated list of properties to select from HubSpot for the Deals table.
EmailPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Emails table.
ExpandAssociations	Specify whether to expand or not the object Associations tables.
FeedbackSubmissionPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the FeedbackSubmissions table.
GenerateSchemaFiles	スキーマを生成して保存するユーザーの好みのタイミングを示します。
GoalPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Goals table.
IncludeCustomTables	Specify whether to get Custom HubSpot Objects or not.
LineItemPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the LineItems table.
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
MeetingPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Meetings table.
NotePropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Notes table.
NumberColumnMode	Specifies how to handle detected number columns.
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	HubSpot から返されるページあたりの結果の最大数。
ProductPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Products table.
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
QuotePropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Quotes table.
TaskPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Tasks table.
TicketPropertiesFile	A file with a comma separated list of properties to select from HubSpot for the Tickets table.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseDisplayNames	Boolean determining if the display names for the tables and columns should be used instead of the API names.
UseDropdownLabels	Boolean determining if dropdown labels should be used instead of internal values for enums.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

Authentication

このセクションでは、本プロバイダーの接続文字列で設定可能なAuthentication プロパティの全リストを提供します。

プロパティ	説明
AuthScheme	The type of authentication to use when connecting to HubSpot.
Schema	Specify the HubSpot API version to use. HUBSPOTV3 is the new API.
OAuthOptionalScopes	A comma-separated set of optional scopes that give you permissions to your HubSpot account.
OAuthRequiredScopes	A comma-separated set of permissions that your Hubspot app needs access to.

AuthScheme

The type of authentication to use when connecting to HubSpot.

解説

Auto: Lets the driver decide automatically based on the other connection properties you have set.
OAuth: Set to this to perform the OAuth 2.0 authentication.
PrivateAppToken: Set this to perform Token Based Authentication via the OAuthAccessToken property.

Schema

Specify the HubSpot API version to use. HUBSPOTV3 is the new API.

解説

Select from the following to specify which API version of HubSpot to use:

HUBSPOT for CRM API v2
HUBSPOTV3 for CRM API v3
HUBSPOTV4 for CRM API v4

OAuthOptionalScopes

A comma-separated set of optional scopes that give you permissions to your HubSpot account.

解説

A comma-separated set of optional scopes that give you permissions to your HubSpot account.

OAuthRequiredScopes

A comma-separated set of permissions that your Hubspot app needs access to.

解説

A comma-separated set of permissions that your Hubspot app needs access to. Any scopes that you've checked off in your app's Auth settings will be treated as required, and you'll need to include them in this parameter or the authorization page will display an error.

OAuth

このセクションでは、本プロバイダーの接続文字列で設定可能なOAuth プロパティの全リストを提供します。

プロパティ	説明
OAuthAccessToken	OAuth を使用して接続するためのアクセストークン。

OAuthAccessToken

OAuth を使用して接続するためのアクセストークン。

解説

OAuth を使用して接続するには、OAuthAccessToken プロパティが使用されます。認証プロセスにおいてOAuth サーバーからOAuthAccessToken が取得されます。このプロパティは、サーバーに依存するタイムアウトがあり、要求の間で再利用することができます。

アクセストークンは、ユーザー名とパスワードの代わりに使用されます。サーバー上で維持することで、認証情報が保護されます。

SSL

このセクションでは、本プロバイダーの接続文字列で設定可能なSSL プロパティの全リストを提供します。

プロパティ	説明
SSLServerCert	TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

SSLServerCert

TLS/SSL を使用して接続するときに、サーバーが受け入れ可能な証明書。

解説

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

これを指定しない場合は、マシンが信用するすべての証明書が受け入れられます。

すべての証明書の受け入れを示すには、'*'を使用します。セキュリティ上の理由から、これはお勧めできません。

Firewall

このセクションでは、本プロバイダーの接続文字列で設定可能なFirewall プロパティの全リストを提供します。

プロパティ	説明
FirewallType	プロキシベースのファイアウォールで使われるプロトコル。
FirewallServer	プロキシベースのファイアウォールの名前もしくはIP アドレス。
FirewallPort	プロキシベースのファイアウォールのTCP ポート。
FirewallUser	プロキシベースのファイアウォールに認証するために使うユーザー名。
FirewallPassword	プロキシベースのファイアウォールへの認証に使われるパスワード。

FirewallType

プロキシベースのファイアウォールで使われるプロトコル。

解説

このプロパティは、Sync App がFirewallServer プロキシ経由でトンネルトラフィックを使うためのプロトコルを指定します。デフォルトでは、Sync App はシステムプロキシに接続します。この動作を無効化し次のプロキシタイプのどれかで接続するには、ProxyAutoDetect をfalse に設定します。


タイプ	デフォルトポート	説明
TUNNEL	80	これが設定されている場合、Sync App はHubSpot への接続を開き、プロキシを経由して通信が行われます。
SOCKS4	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 4 プロキシ経由で送信し、接続リクエストが許容されるかどうかを決定します。
SOCKS5	1080	これが設定されている場合、Sync App はデータをFirewallServer およびFirewallPort で指定されたSOCS 5 プロキシ経由で送信します。プロキシに認証が必要な場合には、FirewallUser およびFirewallPassword をプロキシが認識する認証情報に設定します。

HTTP プロキシへの接続には、ProxyServer およびProxyPort ポートを使ってください。HTTP プロキシへの認証には、ProxyAuthScheme、ProxyUser、およびProxyPassword を使ってください。

FirewallServer

プロキシベースのファイアウォールの名前もしくはIP アドレス。

解説

ファイアウォールトラバーサルを許容するために設定するIP アドレス、DNS 名、もしくはプロキシホスト名を指定するプロパティです。プロトコルはFirewallType で指定されます。このプロパティとFirewallServer を使って、SOCKS 経由での接続、もしくはトンネリングが可能です。HTTP プロキシへの接続には、ProxyServer を使用します。

Sync App はデフォルトでシステムプロキシを使うので注意してください。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定してください。

FirewallPort

プロキシベースのファイアウォールのTCP ポート。

解説

ファイアウォールトラバーサルを許容するために設定するプロキシベースのファイアウォールのTCP ポート。名前もしくはIP アドレスを指定するには、FirewallServer を使います。FirewallType でプロトコルを指定します。

FirewallUser

プロキシベースのファイアウォールに認証するために使うユーザー名。

解説

FirewallUser およびFirewallPassword プロパティは、FirewallType により指定された認証方式に則り、FirewallServer、およびFirewallPort で指定されたプロキシに対しての認証に使われます。

FirewallPassword

プロキシベースのファイアウォールへの認証に使われるパスワード。

解説

このプロパティは、FirewallType により指定された認証メソッドに則り、FirewallServer およびFirewallPort で指定されたプロキシに渡されます。

Proxy

このセクションでは、本プロバイダーの接続文字列で設定可能なProxy プロパティの全リストを提供します。

プロパティ	説明
ProxyAutoDetect	これは、システムプロキシ設定を使用するかどうかを示します。
ProxyServer	HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。
ProxyPort	ProxyServer プロキシが起動しているTCP ポート。
ProxyAuthScheme	ProxyServer プロキシへの認証で使われる認証タイプ。
ProxyUser	ProxyServer プロキシへの認証に使われるユーザー名。
ProxyPassword	ProxyServer プロキシへの認証に使われるパスワード。
ProxySSLType	ProxyServer プロキシへの接続時に使用するSSL タイプ。
ProxyExceptions	ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

ProxyAutoDetect

これは、システムプロキシ設定を使用するかどうかを示します。

解説

これは他のプロキシ設定よりも優先されるため、カスタムプロキシ設定を使用するにはProxyAutoDetect をFALSE に設定する必要があります。

HTTP プロキシへの接続には、ProxyServer を参照してください。SOCKS やトンネリングなどの他のプロキシには、FirewallType を参照してください。

ProxyServer

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。

解説

HTTP トラフィックをルートするためのプロキシのホストネームもしくはIP アドレス。HTTP プロキシへの認証には、Sync App はHTTP、Windows(NTLM)、もしくはKerberos 認証タイプを使用することができます。

SOCKS プロキシを経由して接続する、もしくは接続をトンネルするには、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシを使う場合には、ProxyAutoDetect をfalse に設定します。

ProxyPort

ProxyServer プロキシが起動しているTCP ポート。

解説

HTTP トラフィックをリダイレクトするHTTP プロキシが実行されているポート。ProxyServer でHTTP プロキシを指定します。その他のプロキシタイプについては、FirewallType を参照してください。

ProxyAuthScheme

ProxyServer プロキシへの認証で使われる認証タイプ。

解説

この値は、ProxyServer およびProxyPort で指定されるHTTP プロキシに認証するために使われる認証タイプを指定します。

Sync App は、デフォルトでsystem proxy settings を使い、追加での設定が不要です。他のプロキシへの接続をする場合には、ProxyServer およびProxyPort に加え、ProxyAutoDetect をfalse に設定します。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

認証タイプは、次のどれかになります。

BASIC： Sync App はHTTP BASIC 認証を行います。
DIGEST： Sync App はHTTP DIGEST 認証を行います。
NEGOTIATE： Sync App は認証において有効なプロトコルに応じて、NTLM もしくはKerberos トークンを取得します。
PROPRIETARY： Sync App はNTLM もしくはKerberos トークンを発行しません。このトークンを、HTTP リクエストのAuthorization ヘッダーに含める必要があります。

SOCKS 5 認証のような他の認証タイプを使用するには、FirewallType を参照してください。

ProxyUser

ProxyServer プロキシへの認証に使われるユーザー名。

解説

ProxyUser および ProxyPassword オプションは、ProxyServer で指定されたHTTP プロキシに対して接続および認証するために使用されます。

ProxyAuthScheme で使用可能な認証タイプを選択することができます。HTTP 認証を使う場合、これをHTTP プロキシで識別可能なユーザーのユーザー名に設定します。Windows もしくはKerberos 認証を使用する場合、このプロパティを次の形式のどれかでユーザー名に設定します。

user@domain
domain\user

ProxyPassword

ProxyServer プロキシへの認証に使われるパスワード。

解説

このプロパティは、NTLM(Windows)、Kerberos、もしくはHTTP 認証をサポートするHTTP プロキシサーバーに認証するために使われます。HTTP プロキシを指定するためには、ProxyServer およびProxyPort を設定します。認証タイプを指定するためにはProxyAuthScheme を設定します。

HTTP 認証を使う場合、さらにHTTP プロキシにProxyUser およびProxyPassword を設定します。

NTLM 認証を使う場合、Windows パスワードにProxyUser およびProxyPassword を設定します。Kerberos 認証には、これらを入力する必要があります。

SOCKS 5 認証もしくは、トンネリングは、FirewallType を参照してください。

デフォルトで、Sync App はsystem プロキシを使います。他のプロキシに接続する場合には、これをfalse に設定します。

ProxySSLType

ProxyServer プロキシへの接続時に使用するSSL タイプ。

解説

このプロパティは、ProxyServer で指定されたHTTP プロキシへの接続にSSL を使用するかどうかを決定します。この値は、AUTO、ALWAYS、NEVER、TUNNEL のいずれかです。有効な値は次のとおりです。


AUTO	デフォルト設定。URL がHTTPS URL の場合、Sync App は、TUNNEL オプションを使います。URL がHTTP URL の場合、コンポーネントはNEVER オプションを使います。
ALWAYS	接続は、常にSSL 有効となります。
NEVER	接続は、SSL 有効になりません。
TUNNEL	接続は、トンネリングプロキシを経由します。プロキシサーバーがリモートホストへの接続を開き、プロキシを経由して通信が行われます。

ProxyExceptions

ProxyServer 経由での接続が免除される宛先ホスト名またはIP のセミコロン区切りのリスト。

解説

ProxyServer は、このプロパティで定義されたアドレスを除くすべてのアドレスに使用されます。セミコロンを使用してエントリを区切ります。

Sync App は、追加設定なしにデフォルトでシステムのプロキシ設定を使います。この接続のプロキシ例外を明示的に構成するには、ProxyAutoDetect をfalse に設定して、ProxyServer およびProxyPort を設定する必要があります。認証するには、ProxyAuthScheme を設定し、必要な場合にはProxyUser およびProxyPassword を設定します。

Logging

このセクションでは、本プロバイダーの接続文字列で設定可能なLogging プロパティの全リストを提供します。

プロパティ	説明
LogModules	ログファイルに含めるコアモジュール。

LogModules

ログファイルに含めるコアモジュール。

解説

指定された（';' で区切られた）モジュールのみがログファイルに含まれます。デフォルトではすべてのモジュールが含まれます。

概要はログページを参照してください。

Schema

このセクションでは、本プロバイダーの接続文字列で設定可能なSchema プロパティの全リストを提供します。

プロパティ	説明
Location	テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。
BrowsableSchemas	このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。
Tables	このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。
Views	使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

Location

テーブル、ビュー、およびストアドプロシージャを定義するスキーマファイルを格納するディレクトリへのパス。

解説

Sync App のスキーマファイル（テーブルとビューの場合は.rsd ファイル、ストアドプロシージャの場合は.rsb ファイル）を含むディレクトリへのパス。このフォルダの場所は、実行ファイルの場所からの相対パスにすることができます。Location プロパティは、定義をカスタマイズしたり（例えば、カラム名を変更する、カラムを無視するなど）、新しいテーブル、ビュー、またはストアドプロシージャでデータモデルを拡張する場合にのみ必要です。

Note： このSync App は複数のスキーマをサポートするため、HubSpot カスタムスキーマファイルの構造は以下のようになります。

各スキーマには、そのスキーマ名に対応するフォルダが作られます。
これらのスキーマフォルダは親フォルダに含まれています。
親フォルダは、個々のスキーマのフォルダではなく、Location として設定する必要があります。

指定しない場合、デフォルトの場所は"%APPDATA%\\CData\\HubSpot Data Provider\\Schema" となり、%APPDATA% はユーザーのコンフィギュレーションディレクトリに設定されます：


Platform	%APPDATA%
Windows	APPDATA 環境変数の値
Linux	~/.config

BrowsableSchemas

このプロパティは、使用可能なスキーマのサブセットにレポートされるスキーマを制限します。例えば、BrowsableSchemas=SchemaA,SchemaB,SchemaC です。

解説

スキーマをデータベースからリストすると、負荷がかかる可能性があります。接続文字列でスキーマのリストを提供すると、パフォーマンスが向上します。

Tables

このプロパティは、使用可能なテーブルのサブセットにレポートされるテーブルを制限します。例えば、Tables=TableA,TableB,TableC です。

解説

テーブルを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でテーブルのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいテーブルを指定します。各テーブルは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Views

使用可能なテーブルのサブセットにレポートされるビューを制限します。例えば、Views=ViewA,ViewB,ViewC です。

解説

ビューを複数のデータベースからリストすると、負荷がかかる可能性があります。接続文字列でビューのリストを提供すると、Sync App のパフォーマンスが向上します。

このプロパティは、作業したいビューがすでにわかっていて、ビューが多すぎる場合に、ビューを自動的にリストする代わりに使用することもできます。

カンマ区切りのリストで使用したいビューを指定します。各ビューは、角かっこ、二重引用符、またはバッククオートを使用してエスケープされた特殊文字列を含む有効なSQL 識別子である必要があります。例えば、Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space` です。

複数のスキーマまたはカタログを持つデータソースに接続する場合は、複数のカタログやスキーマに存在するテーブル間の曖昧さを避けるため、最後の例のように、このプロパティにテーブルの完全修飾名を指定する必要があることに注意してください。

Miscellaneous

このセクションでは、本プロバイダーの接続文字列で設定可能なMiscellaneous プロパティの全リストを提供します。

プロパティ	説明
Archived	Specify whether to get archived or unarchived records.
CallPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Calls table.
ColumnSizes	A file with a name=value comma separated list of column sizes.
CompanyPropertiesFile	A file with a comma separated list of properties to select from HubSpot for the Companies table.
ContactPropertiesFile	A file with a comma separated list of properties to select from HubSpot for the Contacts table.
DealPropertiesFile	A file with a comma separated list of properties to select from HubSpot for the Deals table.
EmailPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Emails table.
ExpandAssociations	Specify whether to expand or not the object Associations tables.
FeedbackSubmissionPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the FeedbackSubmissions table.
GenerateSchemaFiles	スキーマを生成して保存するユーザーの好みのタイミングを示します。
GoalPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Goals table.
IncludeCustomTables	Specify whether to get Custom HubSpot Objects or not.
LineItemPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the LineItems table.
MaxRows	クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。
MeetingPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Meetings table.
NotePropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Notes table.
NumberColumnMode	Specifies how to handle detected number columns.
Other	これらの隠しプロパティは特定のユースケースでのみ使用されます。
Pagesize	HubSpot から返されるページあたりの結果の最大数。
ProductPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Products table.
PseudoColumns	このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。
QuotePropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Quotes table.
TaskPropertiesFile	A file or value with a comma separated list of properties to select from HubSpot for the Tasks table.
TicketPropertiesFile	A file with a comma separated list of properties to select from HubSpot for the Tickets table.
Timeout	タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。
UseDisplayNames	Boolean determining if the display names for the tables and columns should be used instead of the API names.
UseDropdownLabels	Boolean determining if dropdown labels should be used instead of internal values for enums.
UserDefinedViews	カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。
UseSimpleNames	テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

Archived

Specify whether to get archived or unarchived records.

解説

This property is only valid for schema "HubSpotV3" and for tables Contacts, Companies, Deals, Tickets, Products, Quotes and LineItems of HubSpotV3.

CallPropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the Calls table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the CallPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the CallProperties table. For instance: dealname,amount,description.

ColumnSizes

A file with a name=value comma separated list of column sizes.

解説

Some fields may requre a larger column size than the default. These can be entered as a comma separated list of tablename.columnname=value or columnname=value pairs. For instance: Table1.Col1=4000,Table1.Col2=5000,Col1=13. The values entered will override the default for any detected fields. The column specified with a tablename takes priority over the same column name without the tablename in front of it. In this example, the size of Col1 in Table1 is 4000, and in all the other tables it is 13.

CompanyPropertiesFile

A file with a comma separated list of properties to select from HubSpot for the Companies table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the CompanyPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the CompanyProperties table. For instance: dealname,amount,description.

ContactPropertiesFile

A file with a comma separated list of properties to select from HubSpot for the Contacts table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the ContactPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the ContactProperties table. For instance: firstname,lastname,lastmodifieddate.

DealPropertiesFile

A file with a comma separated list of properties to select from HubSpot for the Deals table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the DealPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the DealProperties table. For instance: dealname,amount,description.

EmailPropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the Emails table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the EmailPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the EmailProperties table. For instance: dealname,amount,description.

ExpandAssociations

Specify whether to expand or not the object Associations tables.

解説

If False, the driver will expose one associations table for each HubSpot object (ex. DealAssociations, CompanyAssociations, ContactAssociations, etc.). These tables will return the Id-s of all the objects associated to that specific object type.
If True, the driver will expose one associations table for each association between two HubSpot object types (ex. CompaniesToContactsAssociations, ContactsToDealsAssociations, DealsToLineitemsAssociations, etc.). Each of these tables will return the Id pairs of the associated records from the two object types.

Note: This property is only valid for schema "HubSpotV3".

FeedbackSubmissionPropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the FeedbackSubmissions table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the FeedbackSubmissionPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the FeedbackSubmissionProperties table. For instance: dealname,amount,description.

GenerateSchemaFiles

スキーマを生成して保存するユーザーの好みのタイミングを示します。

解説

このプロパティは、Location で指定されたパスの.rsd ファイルにスキーマをアウトプットします。

有効な設定は次のとおりです。

Never：スキーマファイルは生成されません。
OnUse：スキーマファイルがまだ存在していない場合に、初めてテーブルが参照されるときにスキーマファイルが生成されます。
OnStart：現在スキーマファイルを持たないあらゆるテーブルに対して、接続時にスキーマファイルが生成されます。
OnCreate：CREATE TABLE SQL クエリを実行すると、スキーマファイルが生成されます。

ファイルを再生成したい場合には、既存のファイルを削除する必要があることに注意してください。

SQL でスキーマを生成する

GenerateSchemaFiles をOnUse に設定すると、Sync App はSELECT クエリを実行したときにスキーマを生成します。スキーマはクエリのそれぞれの参照されたテーブルに対して生成されます。

GenerateSchemaFiles をOnCreate に設定すると、CREATE TABLE クエリが実行されたときにのみスキーマが生成されます。

接続時にスキーマを生成する

このプロパティのもう一つの使い方は、接続するときにデータベース内のすべてのテーブルのスキーマを取得することです。これには、GenerateSchemaFiles をOnStart に設定して接続します。

GoalPropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the Goals table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the GoalPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the GoalProperties table. For instance: dealname,amount,description.

IncludeCustomTables

Specify whether to get Custom HubSpot Objects or not.

解説

When set to false, only the Standard Objects will be exposed.

LineItemPropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the LineItems table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the LineItemPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the LineItemProperties table. For instance: dealname,amount,description.

MaxRows

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

解説

クエリで集計またはGROUP BY を使用しない場合に返される行数を制限します。これはLIMIT 句よりも優先されます。

MeetingPropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the Meetings table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the MeetingPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the MeetingProperties table. For instance: dealname,amount,description.

NotePropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the Notes table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the NotePropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the NoteProperties table. For instance: dealname,amount,description.

NumberColumnMode

Specifies how to handle detected number columns.

解説

HubSpot reports all numeric data type fields (ex. integer, double, decimal, etc.) as 'number' type. For this reason, there isn't a reliable way for the Sync App to determinate the exact numeric type for each detected numeric field.

By default, all numbers will be specified as decimal. However, depending on your needs, you may wish to handle number columns as either double or decimal. In addition, you can also set the value to string to report all number columns as strings.

Note: This connection property is applicable only for 'HUBSPOTV3' Schema.

Other

これらの隠しプロパティは特定のユースケースでのみ使用されます。

解説

以下にリストされているプロパティは、特定のユースケースで使用可能です。通常のドライバーのユースケースおよび機能では、これらのプロパティは必要ありません。

複数のプロパティをセミコロン区切りリストで指定します。

統合およびフォーマット


DefaultColumnSize	データソースがメタデータにカラムの長さを提供しない場合に、文字列フィールドのデフォルトの長さを設定します。デフォルト値は2000です。
ConvertDateTimeToGMT	日時の値を、マシンのローカルタイムではなくGMT グリニッジ標準時に変換するかどうかを決定します。
RecordToFile=filename	基底のソケットデータ転送を指定のファイルに記録します。

Pagesize

HubSpot から返されるページあたりの結果の最大数。

解説

Pagesize プロパティは、HubSpot から返されるページあたりの結果の最大数に影響を与えます。より大きい値を設定すると、1ページあたりの消費メモリが増える代わりに、パフォーマンスが向上する場合があります。

ProductPropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the Products table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the ProductPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the ProductProperties table. For instance: dealname,amount,description.

PseudoColumns

このプロパティは、テーブルのカラムとして疑似カラムが含まれているかどうかを示します。

解説

Entity Framework ではテーブルカラムでない疑似カラムに値を設定できないため、この設定はEntity Framework で特に便利です。この接続設定の値は、"Table1=Column1, Table1=Column2, Table2=Column3" の形式です。"*=*" のように"*" 文字を使用して、すべてのテーブルとすべてのカラムを含めることができます。

QuotePropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the Quotes table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the QuotePropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the QuoteProperties table. For instance: dealname,amount,description.

TaskPropertiesFile

A file or value with a comma separated list of properties to select from HubSpot for the Tasks table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the TaskPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt or dealname,amount,description.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the TaskProperties table. For instance: dealname,amount,description.

TicketPropertiesFile

A file with a comma separated list of properties to select from HubSpot for the Tickets table.

解説

In HubSpot, you can potentially have so many custom fields that attempting to select all of them at a time will cause HubSpot to return an error. In a situation where you do not have direct control over the SQL Statement but still need to get custom field data back, you set the TicketPropertiesFile to the full location of a file that lists which custom fields to select. For instance, C:\users\public\documents\customfields.txt.

The CustomFields document itself is just a comma separated list of the names of which custom fields to select. Note that these must be the API names of the custom fields. These names can be retrieved from the Name column of the TicketProperties table. For instance: dealname,amount,description.

Timeout

タイムアウトエラーがスローされ、処理をキャンセルするまでの秒数。

解説

Timeout が0に設定されている場合は、操作がタイムアウトしません。処理が正常に完了するか、エラー状態になるまで実行されます。

Timeout の有効期限が切れても処理が完了していない場合は、Sync App は例外をスローします。

UseDisplayNames

Boolean determining if the display names for the tables and columns should be used instead of the API names.

解説

Boolean determining if the display names for the tables and columns should be used instead of the API names.

UseDropdownLabels

Boolean determining if dropdown labels should be used instead of internal values for enums.

解説

Boolean determining if dropdown labels should be used instead of internal values for enums. This will only affect custom fields.

UseDropdownLabels will default to True. If set to false, the internal values will be displayed for dropdown values instead of the labels..

UserDefinedViews

カスタムビューを含むJSON コンフィギュレーションファイルを指すファイルパス。

解説

ユーザー定義ビューは、UserDefinedViews.json というJSON 形式のコンフィギュレーションファイルで定義されています。Sync App は、このファイルで指定されたビューを自動的に検出します。

また、複数のビュー定義を持ち、UserDefinedViews 接続プロパティを使用して制御することも可能です。このプロパティを使用すると、指定されたビューのみがSync App によって検知されます。

このユーザー定義ビューのコンフィギュレーションファイルは、次のようにフォーマットされています。

各ルートエレメントはビューの名前を定義します。
各ルートエレメントには、query と呼ばれる子エレメントが含まれており、この子エレメントにはビューのカスタムSQL クエリが含まれています。

次に例を示します。

{
	"MyView": {
		"query": "SELECT * FROM Contacts WHERE MyColumn = 'value'"
	},
	"MyView2": {
		"query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
	}
}

UserDefinedViews 接続プロパティを使用して、JSON コンフィギュレーションファイルの場所を指定します。次に例を示します。

"UserDefinedViews", C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json

指定されたパスは引用符で囲まれていないことに注意してください。

UseSimpleNames

テーブルとカラムに簡略名を使用するかどうかを決定するboolean。

解説

HubSpot テーブルおよびカラムでは、通常のデータベースでは使うことが認められていない特殊記号・文字を名前に使うことができます。UseSimpleNames を使用すると、Sync App を従来のデータベースツールでより簡単に使用できるようになります。

UseSimpleNames をtrue に設定し、返されるテーブル名およびカラム名をシンプルにします。表示されるテーブル名およびカラム名においてアルファベット文字およびアンダースコアのみを有効とするネーミングスキームを強制します。英数字以外の文字はすべて、アンダースコアに変換されます。

HubSpot Connector for CData Sync

HubSpot Connector for CData Sync

概要

HubSpot バージョンサポート

接続の確立

HubSpot への接続を追加

HubSpot への認証

OAuth

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

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

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

高度な機能

ユーザー定義ビュー

SSL の設定

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

クエリ処理

ログ

SSL の設定

SSL 設定のカスタマイズ

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

Firewall またはProxy 経由の接続

HTTP プロキシ

その他のプロキシ

データモデル

HubSpot API の使用

HubSpot V3 API の使用

HubSpot V4 API の使用

HubSpot データモデル

テーブル

ビュー

ストアドプロシージャ

テーブル

HubSpot Connector for CData Sync テーブル

Companies

Table Specific Information

SELECT

Columns

CompanyProperties

Table Specific Information

SELECT

Columns

CompanyPropertyGroups

Table Specific Information

SELECT

Columns

ContactLists

Table Specific Information

SELECT

Columns

ContactProperties

Table Specific Information

SELECT

Columns

ContactPropertyGroups

Table Specific Information

SELECT

Columns

Contacts

Table Specific Information

SELECT

UPDATE

Columns

ContactsInList

Table Specific Information

SELECT

Columns

CrmAssociations

Table Specific Information

SELECT

INSERT

UPDATE

DELETE

Columns

DealAssociations

Table Specific Information

SELECT

INSERT

DELETE

Columns

DealProperties