HubSpot Connector Objects (hubspotv3 Schema)
Name | Description |
---|---|
AssociationsTypes | Retrieve all available association types between a pair of CRM objects. |
CallAssociations | Retrieve the IDs of all the objects associated to specific Calls objects in HubSpot. |
CallProperties | Retrieve the available Quote properties in HubSpot. |
CommunicationProperties | Retrieve the available Communications properties in HubSpot. |
Communications | Retrieve the available Communications 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. |
CompanyProperties | Retrieve the available CompanyProperties in HubSpot. |
CompanyPropertiesHistory | Retrieve the available Company properties history in HubSpot. |
CompanyPropertyGroups | Retrieve the available Companypropertygroups 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. |
ContactProperties | Retrieve the available ContactProperties in HubSpot. |
ContactPropertiesHistory | Retrieve the available Contact properties history in HubSpot. |
ContactPropertyGroups | Retrieve the available Contactpropertygroups in HubSpot. |
Contacts | Retrieve available contacts in HubSpot. This table supports both OAuth and PrivateAppToken authentication methods. |
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. |
CustomObjectProperties | Retrieve the available Custom Objects Properties in HubSpot. |
CustomObjects | Retrieve the available Custom Objects 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. |
DealProperties | Retrieve the available DealProperties in HubSpot. |
DealPropertiesHistory | Retrieve the available Deal properties history in HubSpot. |
DealPropertyGroups | Retrieve the available Dealpropertygroups in HubSpot. |
Deals | Retrieve the available Deals in HubSpot. his table supports both OAuth and PrivateAppToken authentications. |
EmailAssociations | Retrieve the IDs of all the objects associated to specific Emails objects in HubSpot. |
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. |
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. |
Forms | Retrieve HubSpot forms used to collect lead information about your visitors and contacts. |
GoalProperties | Retrieve the available Companyproperties in HubSpot. |
Goals | Retrieve the available Goals in HubSpot. |
LeadAssociations | Retrieve the IDs of all the objects associated to specific Leads objects in HubSpot. |
LeadPipelines | Pipelines of Leads in HubSpot. |
LeadPipelineStages | Pipeline stages of Leads in HubSpot. |
LeadProperties | Retrieve the available LeadProperties in HubSpot. |
LeadPropertiesHistory | Retrieve the available Lead properties history in HubSpot. |
LeadPropertyGroups | Retrieve the available Lead property groups in HubSpot. |
Leads | Retrieve the available Leads in HubSpot. |
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. |
MeetingAssociations | Retrieve the IDs of all the objects associated to specific Meetings objects in HubSpot. |
MeetingProperties | Retrieve the available Quote properties in HubSpot. |
NoteAssociations | Retrieve the IDs of all the objects associated to specific Notes objects in HubSpot. |
NoteProperties | Retrieve the available Quote properties in HubSpot. |
OrderAssociations | Retrieve the IDs of all the objects associated to specific Orders objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications. |
OrderPipelines | Pipelines of Orders in HubSpot. |
OrderPipelineStages | Pipeline stages of Orders in HubSpot. |
OrderProperties | Retrieve the available Order properties in HubSpot. |
OrderPropertiesHistory | Retrieve the available Order properties history in HubSpot. |
OrderPropertyGroups | Retrieve the available Order property groups in HubSpot. |
Orders | Retrieve the available Orders 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. |
PerformanceWorkflows | Get a breakdown of the performance of a workflow based on the specified time period. |
PostalEmailProperties | Retrieve the available PostalEmails properties in HubSpot. |
PostalEmails | Retrieve the available Postalemails in HubSpot. |
ProductAssociations | Retrieve the IDs of all the objects associated to specific Products objects 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. |
QuoteProperties | Retrieve the available QuoteProperties in HubSpot. |
Quotes | Retrieve the available Quotes in HubSpot. |
Roles | Retrieves details about an account's roles. |
TaskProperties | Retrieve the available Quote properties in HubSpot. |
TasksAssociations | Retrieve the IDs of all the objects associated to specific Tasks objects in HubSpot. |
Teams | Returns details about an account's teams. |
ThreadMessages | Retrieve the entire message history in a Thread |
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. |
TicketProperties | Retrieve the available TicketProperties in HubSpot. |
TicketPropertiesHistory | Retrieve the available ticket properties history in HubSpot. |
TicketPropertyGroups | Retrieve the available Ticketpropertygroups in HubSpot. |
Tickets | Retrieve the available Tickets in HubSpot. This table supports both OAuth and PrivateAppToken authentications. |
UserProvisioning | Retrieves details about users in the account, along with their permissions. |
WebAnalytics | The Web Analytics endpoint allows developers to find and filter events associated with a CRM object of any type. |
Workflows | Select and manage HubSpot workflows. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The numeric ID for the association type. | |
Type | String | False | No | The name of the association type for the specified object pair. | |
FromObjectType [KEY] | String | False | No | The first object's type to retrieve association types for. | |
ToObjectType [KEY] | String | False | No | The second object's type to retrieve association types for. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Calls ID | |
AssociationId [KEY] | Long | False | No | ID of the object that this Calls object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object, which can be a contact, deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Properties | String | True | No | An aggregate of the properties defined for a given object type. | |
All teams | String | True | No | The team IDs, including the team hierarchy, of all default and custom owner properties for this record. | |
Business units | String | False | No | The business units this record is assigned to. | |
All owner IDs | String | True | No | Values of all default and custom owner properties for this record. | |
All team IDs | String | True | No | The team IDs of all default and custom owner properties for this record. | |
AtMentioned Owner Ids | String | False | No | The owners that have been at-mentioned on the engagement | |
Attached file IDs | String | False | No | The IDs of the files that are attached to the communication | |
Body preview | String | True | No | A truncated preview of the engagement body | |
HTML Body Preview | String | True | No | The HTML representation of the engagement body preview | |
Body Preview Truncated | Bool | True | No | Indicates if the engagement body was truncated for the preview | |
Communication body | String | False | No | The body of the communication | |
Channel Type | String | False | No | ||
Conversation associations sync timestamp | Datetime | True | No | Timestamp of the most recent time that associations were synced to this communication from the corresponding conversation object | |
Conversation object ID | Decimal | True | No | The ID of the conversation object for the thread that this communication belongs to | |
Conversations channel IDs | String | True | No | The IDs of the Conversations channels used in this communication | |
Conversations channel account IDs | String | True | No | The IDs of the Conversations channel accounts used in this communication | |
Conversations first message timestamp | Datetime | True | No | Timestamp of the first Conversations message in the communication | |
Conversations thread ID | Decimal | True | No | The ID of the Conversations thread that this communication belongs to | |
Logged From | String | False | No | Where the communication was logged | |
Activity created by | Decimal | True | No | The user who created the communication | |
Created by user ID | Decimal | True | No | The user who created this record. This value is set automatically by HubSpot. | |
Object create date/time | Datetime | True | No | The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified. | |
Engagement Source | String | False | No | The source that created this engagement | |
Engagement Source ID | String | False | No | The specific ID of the process that created this engagement | |
GDPR deleted | Bool | True | No | Indicates the body of this engagement has been cleared because of a GDPR delete request | |
Object last modified date/time | Datetime | True | No | Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically. | |
Merged record IDs | String | True | No | The list of record IDs that have been merged into this record. This value is set automatically by HubSpot. | |
Updated by | Decimal | True | No | The user who last updated the communication | |
Record ID | Decimal | True | No | The unique ID for this record. This value is set automatically by HubSpot. | |
Record creation source | String | True | No | Raw internal PropertySource present in the RequestMeta when this record was created. | |
Record source detail 1 | String | True | No | First level of detail on how this record was created. | |
Record source detail 2 | String | True | No | Second level of detail on how this record was created. | |
Record source detail 3 | String | True | No | Third level of detail on how this record was created. | |
Record creation source ID | String | True | No | Raw internal sourceId present in the RequestMeta when this record was created. | |
Record source | String | True | No | How this record was created. | |
Record creation source user ID | Decimal | True | No | Raw internal userId present in the RequestMeta when this record was created. | |
Read only object | Bool | True | No | Determines whether a record can be edited by a user. | |
Shared teams | String | True | No | Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs. | |
Shared users | String | True | No | Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs. | |
Activity date | Datetime | False | No | ||
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Unique ID | String | False | No | The unique ID of the communication | |
Updated by user ID | Decimal | True | No | The user who last updated this record. This value is set automatically by HubSpot. | |
User IDs of all notification followers | String | True | No | 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 | No | 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 | No | The user IDs of all owners of this record. | |
Performed in an import | Bool | True | No | Object is part of an import | |
Owner assigned date | Datetime | True | No | The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot. | |
Activity assigned to | String | False | No | 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 | No | The team of the owner of an engagement. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
ItemURL | String | True | No | Url that points directly to the HubSpot item. | |
About Us | String | False | No | Short about_company | |
ClosedateTimestampEarliestValueA2a17e6e | Datetime | True | No | Calculation context property providing timestamp for rollup property closedate calculated as EARLIESTVALUE via values of closedate on object type ObjectTypeId_legacyObjectType_CONTACT | |
Facebook Fans | Decimal | False | No | Number of facebook fans | |
FirstContactCreatedateTimestampEarliestValue78b50eea | Datetime | True | No | Calculation context property providing timestamp for rollup property firstcontact_createdate calculated as EARLIEST_VALUE via values of createdate on object type ObjectTypeId_legacyObjectType_CONTACT | |
First Conversion Date | Datetime | True | No | The first conversion date across all contacts associated this company or organization | |
FirstConversionDateTimestampEarliestValue61f58f2c | Datetime | True | No | Calculation context property providing timestamp for rollup property firstconversion_date calculated as EARLIEST_VALUE via values of first_conversion_date on object type ObjectTypeId_legacyObjectType_CONTACT | |
First Conversion | String | True | No | The first form submitted across all contacts associated this company or organization | |
FirstConversionEventNameTimestampEarliestValue68ddae0a | Datetime | True | No | Calculation context property providing timestamp for rollup property firstconversion_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 | No | Date the first deal was associated with this company record. | |
Year Founded | String | False | No | The year the company was created. Powered by HubSpot Insights. | |
Additional Domains | String | False | No | Additional domains belonging to this company | |
Business units | String | False | No | The business units this record is assigned to. | |
Time First Seen | Datetime | True | No | The first activity for any contact associated with this company or organization | |
HsAnalyticsFirstTimestampTimestampEarliestValue11e3a63a | Datetime | True | No | Calculation context property providing timestamp for rollup property hsanalytics_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 | No | The campaign responsible for the first touch creation of the first contact associated with this company | |
HsAnalyticsFirstTouchConvertingCampaignTimestampEarliestValue4757fe10 | Datetime | True | No | Calculation context property providing timestamp for rollup property hsanalytics_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 | No | Time of first session across all contacts associated with this company or organization | |
HsAnalyticsFirstVisitTimestampTimestampEarliestValueAccc17ae | Datetime | True | No | Calculation context property providing timestamp for rollup property hsanalytics_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 | No | Time last seen across all contacts associated with this company or organization | |
HsAnalyticsLastTimestampTimestampLatestValue4e16365a | Datetime | True | No | Calculation context property providing timestamp for rollup property hsanalytics_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 | No | The campaign responsible for the last touch creation of the first contact associated with this company | |
HsAnalyticsLastTouchConvertingCampaignTimestampLatestValue81a64e30 | Datetime | True | No | Calculation context property providing timestamp for rollup property hsanalytics_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 | No | Time of the last session attributed to any contacts that are associated with this company record. | |
HsAnalyticsLastVisitTimestampTimestampLatestValue999a0fce | Datetime | True | No | Calculation context property providing timestamp for rollup property hsanalytics_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 | No | Source of the last session attributed to any contacts that are associated with this company | |
Latest Source Data 1 | String | True | No | Additional source details of the last session attributed to any contacts that are associated with this company | |
Latest Source Data 2 | String | True | No | Additional source details of the last session attributed to any contacts that are associated with this company | |
Latest Source Timestamp | Datetime | True | No | Timestamp of when latest source occurred | |
Number of Pageviews | Decimal | True | No | Total number of page views across all contacts associated with this company or organization | |
HsAnalyticsNumPageViewsCardinalitySumE46e85b0 | Decimal | True | No | Calculation context property providing cardinality for rollup property hsanalytics_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 | No | Total number of sessions across all contacts associated with this company or organization | |
HsAnalyticsNumVisitsCardinalitySum53d952a6 | Decimal | True | No | Calculation context property providing cardinality for rollup property hsanalytics_num_visits calculated as SUM via values of hs_analytics_num_visits on object type ObjectTypeId_legacyObjectType_CONTACT | |
Original Source Type | String | False | No | Original source for the contact with the earliest activity for this company or organization | |
Original Source Data 1 | String | True | No | Additional information about the original source for the contact with the earliest activity for this company or organization | |
HsAnalyticsSourceData1TimestampEarliestValue9b2f1fa1 | Datetime | True | No | Calculation context property providing timestamp for rollup property hsanalytics_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 | No | Additional information about the original source for the contact with the earliest activity for this company or organization | |
HsAnalyticsSourceData2TimestampEarliestValue9b2f9400 | Datetime | True | No | Calculation context property providing timestamp for rollup property hsanalytics_source_data_2 calculated as EARLIEST_VALUE via values of hs_analytics_source_data_2 on object type ObjectTypeId_legacyObjectType_CONTACT | |
HsAnalyticsSourceTimestampEarliestValue25a3a52c | Datetime | True | No | Calculation context property providing timestamp for rollup property hsanalytics_source calculated as EARLIEST_VALUE via values of hs_analytics_source on object type ObjectTypeId_legacyObjectType_CONTACT | |
Avatar FileManager key | String | True | No | The path in the FileManager CDN for this company's avatar override image. Automatically set by HubSpot. | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Object create date_time | Datetime | True | No | 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 | No | The date and time when the company entered the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date entered 'Evangelist Lifecycle Stage Pipeline' | Datetime | True | No | The date and time when the company entered the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date entered 'Lead Lifecycle Stage Pipeline' | Datetime | True | No | 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 | No | 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 | No | The date and time when the company entered the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date entered 'Other Lifecycle Stage Pipeline' | Datetime | True | No | 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 | No | 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 | No | The date and time when the company entered the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date exited 'Customer Lifecycle Stage Pipeline' | Datetime | True | No | The date and time when the company exited the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date exited 'Evangelist Lifecycle Stage Pipeline' | Datetime | True | No | The date and time when the company exited the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date exited 'Lead Lifecycle Stage Pipeline' | Datetime | True | No | 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 | No | 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 | No | The date and time when the company exited the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date exited 'Other Lifecycle Stage Pipeline' | Datetime | True | No | 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 | No | 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 | No | The date and time when the company exited the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Ideal Customer Profile Tier | String | False | No | How well this company matches your Ideal Customer Profile. Tier 1 means a great fit for your productsservices Tier 3 might be acceptable_ but low priority. | |
Target Account | Bool | False | No | Identifies whether this company is being marketed and sold to as part of your account_based strategy. | |
Last Booked Meeting Date | Datetime | True | No | The last date of booked meetings associated with the company | |
Last Logged Call Date | Datetime | True | No | The last date of logged calls associated with the company | |
Last Open Task Date | Datetime | True | No | The last due date of open tasks associated with the company | |
last sales activity date old | Datetime | True | No | The date of the last sales activity with the company in seconds. | |
Last Engagement Date | Datetime | True | No | 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 | No | 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 | No | 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 | No | Latest created date of all associated active Subscriptions | |
Merged object IDs | String | True | No | 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 | No | The number of contacts associated with this company with the role of blocker. | |
Number of contacts with a buying role | Decimal | True | No | The number of contacts associated with this company with a buying role. | |
Number of decision makers | Decimal | True | No | The number of contacts associated with this company with the role of decision maker. | |
Number of open deals | Decimal | True | No | The number of open deals associated with this company. | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Pinned Engagement ID | Decimal | True | No | The object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified. | |
Pipeline | String | False | No | The pipeline with which this company is currently associated | |
Likelihood to close | Decimal | True | No | 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 | No | Calculation context property providing nextmax 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 | No | Is the object read only | |
Target Account2 | String | False | No | 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 | No | The probability a company is marked as a target account | |
Target Account Recommendation Snooze Time | Datetime | False | No | The date when the target account recommendation is snoozed. | |
Target Account Recommendation State | String | False | No | The state of the target account recommendation | |
Time in 'Customer Lifecycle Stage Pipeline' | Decimal | True | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | The total time in seconds spent by the company in the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Total open deal value | Decimal | True | No | The total value* in your company's currency* of all open deals associated with this company | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner Assigned Date | Datetime | True | No | The timestamp when an owner was assigned to this company | |
Is Public | Bool | False | No | Indicates if the company is publicly traded. Powered by HubSpot Insights. | |
Number of Associated Contacts | Decimal | True | No | The number of contacts associated with this company | |
Number of Associated Deals | Decimal | True | No | The number of deals associated with this company | |
Number of Form Submissions | Decimal | True | No | The number of forms submission for all contacts associated with this company or organization | |
NumConversionEventsCardinalitySumD095f14b | Decimal | True | No | Calculation context property providing cardinality for rollup property numconversion_events calculated as SUM via values of num_conversion_events on object type ObjectTypeId_legacyObjectType_CONTACT | |
Recent Conversion Date | Datetime | True | No | The most recent conversion date across all contacts associated this company or organization | |
RecentConversionDateTimestampLatestValue72856da1 | Datetime | True | No | Calculation context property providing timestamp for rollup property recentconversion_date calculated as LATEST_VALUE via values of recent_conversion_date on object type ObjectTypeId_legacyObjectType_CONTACT | |
Recent Conversion | String | True | No | The last form submitted across all contacts associated this company or organization | |
RecentConversionEventNameTimestampLatestValue66c820bf | Datetime | True | No | Calculation context property providing timestamp for rollup property recentconversion_event_name calculated as LATEST_VALUE via values of recent_conversion_event_name on object type ObjectTypeId_legacyObjectType_CONTACT | |
Recent Deal Amount | Decimal | True | No | The amount of the last deal closed | |
Recent Deal Close Date | Datetime | True | No | Date of the last | |
Time Zone | String | False | No | Time zone where the company or organization is located. Powered by HubSpot Insights. | |
Total Money Raised | String | False | No | The total amount of money raised by the company. Powered by HubSpot Insights. | |
Total Revenue | Decimal | True | No | The total amount of closed won deals | |
Company name | String | False | No | The name of the company or organization. Powered by HubSpot Insights. | |
HubSpot Owner Email | String | False | No | HubSpot owner email for this company or organization | |
Twitter Handle | String | False | No | The main twitter account of the company or organization | |
HubSpot Owner Name | String | False | No | HubSpot owner name for this company or organization | |
Phone Number | String | False | No | Company primary phone number. Powered by HubSpot Insights. | |
Twitter Bio | String | False | No | The Twitter bio of the company or organization | |
Twitter Followers | Decimal | False | No | The number of Twitter followers of the company or organization | |
Street Address | String | False | No | Street address of the company or organization_ including unit number. Powered by HubSpot Insights. | |
Street Address 2 | String | False | No | Additional address of the company or organization. Powered by HubSpot Insights. | |
Facebook Company Page | String | False | No | The URL of the Facebook company page for the company or organization | |
City | String | False | No | City where the company is located. Powered by HubSpot Insights. | |
LinkedIn Company Page | String | False | No | The URL of the LinkedIn company page for the company or organization | |
LinkedIn Bio | String | False | No | The LinkedIn bio for the company or organization | |
State_Region | String | False | No | State or region in which the company or organization is located. Powered by HubSpot Insights. | |
Google Plus Page | String | False | No | The URL of the Google Plus page for the company or organization | |
Date of last meeting booked in meetings tool | Datetime | True | No | Last Meeting Booked for any contact associated with this Company_Organization. | |
Campaign of last booking in meetings tool | String | True | No | 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 | No | 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 | No | 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 | No | 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 | No | The last time a tracked sales email was replied to by this company | |
Company owner | String | False | No | The owner of the company | |
Last Contacted | Datetime | True | No | Timestamp of the last call* email* or meeting that was logged for a contact at this company. | |
Last Activity Date | Datetime | True | No | 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 | No | Date of the next upcoming scheduled sales activity for this company record. | |
Number of times contacted | Decimal | True | No | The number of times a call_ email or meeting was logged for this company | |
Number of Sales Activities | Decimal | True | No | Number of sales activities for this company. For example* a call* email or meeting logged. | |
Postal Code | String | False | No | Postal or zip code of the company or organization. Powered by HubSpot Insights. | |
Country_Region | String | False | No | Country in which the company or organization is located. Powered by HubSpot Insights. | |
HubSpot Team | String | True | No | The team of the owner of the company. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
Website URL | String | False | No | 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 | No | The domain name of the company or organization | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom | |
All accessible team ids | String | True | No | 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 | No | The total number of employees who work for the company or organization. Powered by HubSpot Insights. | |
Industry | String | False | No | 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 | No | The actual or estimated annual revenue of the company. Powered by HubSpot Insights. | |
Lifecycle Stage | String | False | No | The most advanced lifecycle stage across all contacts associated with this company or organization | |
Lead Status | String | False | No | The company's sales_ prospecting or outreach status | |
Parent Company | Decimal | True | No | The parent company of this company | |
Type | String | False | No | The optional classification of this company record _ prospect_ partner_ etc. | |
Description | String | False | No | A short statement about the company's mission and goals. Powered by HubSpot Insights. | |
Number of child companies | Decimal | True | No | The number of child companies of this company | |
HubSpot Score | Decimal | True | No | The sales and marketing score for the company or organization | |
Create Date | Datetime | True | No | The date the company or organization was added to the database | |
Close Date | Datetime | False | No | The date the company or organization was closed as a customer | |
First Contact Create Date | Datetime | True | No | 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 | No | The number of days between when the company record was created and when they closed as a customer. | |
Web Technologies | String | False | No | The web technologies used by the company or organization. Powered by HubSpot Insights. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Companies.Id | No | Companies ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Companies object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object* which can be a contact* deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identified of the pipeline. | |
Label | String | False | No | The label name of the pipeline. | |
Archived | Bool | True | No | Whether the pipeline is archived or not. | |
CreatedAt | Datetime | True | No | When the pipeline was created. | |
UpdatedAt | Datetime | True | No | When the pipeline was last updated. | |
DisplayOrder | Int | False | No | The order of this specific pipeline in the collection of pipelines for this table. | |
StagesAggregate | String | False | No | An aggregate of the stages included in this pipeline. This information can be viewed in more detail in CompanyPipelineStages table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier of the stage in the pipeline. | |
PipelineId [KEY] | String | False | CompanyPipelines.Id | No | Unique identifier of the pipeline. |
Label | String | False | No | Label name of the pipeline stage. | |
PipelineLabel | String | True | CompanyPipelines.Label | No | The label name of the pipeline. |
IsClosed | Bool | False | No | Whether this stage is open or closed. | |
Probability | Decimal | False | No | Current state of the pipeline stage. | |
Archived | Bool | True | No | Whether the stage is archived or not. | |
CreatedAt | Datetime | True | No | Time the stage was created. | |
UpdatedAt | Datetime | True | No | Time the stage was last updated. | |
DisplayOrder | Int | False | No | The order of the stage in the collection of stages for this pipeline. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. | |
HasUniqueValue | Bool | False | No | Boolean indicating if the value of the property is unique. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
PropertyName | String | True | No | The name of the property. | |
Value | String | True | No | The historical value of the property. | |
SourceType | String | True | No | The method by which the property was changed. | |
SourceId | String | True | No | Additional data related to the source. May not be populated for all sources. | |
Timestamp | Datetime | True | No | Datetime when the property was updated. | |
CompanyId | Long | True | No | The company identifier. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | The name of the property group. | |
Label | String | False | No | The label of the group. | |
DisplayOrder | Int | False | No | The numerical order of the group with respect to other groups. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Contacts.Id | No | Contacts ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Contacts object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object* which can be a contact* deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identified of the pipeline. | |
Label | String | False | No | The label name of the pipeline. | |
Archived | Bool | True | No | Whether the pipeline is archived or not. | |
CreatedAt | Datetime | True | No | When the pipeline was created. | |
UpdatedAt | Datetime | True | No | When the pipeline was last updated. | |
DisplayOrder | Int | False | No | The order of this specific pipeline in the collection of pipelines for this table. | |
StagesAggregate | String | False | No | An aggregate of the stages included in this pipeline. This information can be viewed in more detail in ContactPipelineStages table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier of the stage in the pipeline. | |
PipelineId [KEY] | String | False | ContactPipelines.Id | No | Unique identifier of the pipeline. |
Label | String | False | No | Label name of the pipeline stage. | |
PipelineLabel | String | True | ContactPipelines.Label | No | The label name of the pipeline. |
IsClosed | Bool | False | No | Whether this stage is open or closed. | |
Probability | Decimal | False | No | Current state of the pipeline stage. | |
Archived | Bool | True | No | Whether the stage is archived or not. | |
CreatedAt | Datetime | True | No | Time the stage was created. | |
UpdatedAt | Datetime | True | No | Time the stage was last updated. | |
DisplayOrder | Int | False | No | The order of the stage in the collection of stages for this pipeline. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. | |
HasUniqueValue | Bool | False | No | Boolean indicating if the value of the property is unique. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
PropertyName | String | True | No | The name of the property. | |
Value | String | True | No | The historical value of the property. | |
SourceType | String | True | No | The method by which the property was changed. | |
SourceId | String | True | No | Additional data related to the source. May not be populated for all sources. | |
Timestamp | Datetime | True | No | Datetime when the property was updated. | |
ContactId | Long | True | No | The contact identifier. | |
ContactEmail | String | True | No | The contact's email address. | |
ContactPhoneNumber | String | True | No | The contact's primary phone number. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | The name of the property group. | |
Label | String | False | No | The label of the group. | |
DisplayOrder | Int | False | No | The numerical order of the group with respect to other groups. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
ItemURL | String | True | No | Url that points directly to the HubSpot item. | |
Company size | String | False | No | Contact's company size. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Date of birth | String | False | No | Contact's date of birth. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Days To Close | Decimal | True | No | Count of days elapsed between creation and being closed as a customer. Set automatically. | |
Degree | String | False | No | Contact's degree. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Field of study | String | False | No | Contact's field of study. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
First Conversion Date | Datetime | True | No | Date this contact first submitted a form. | |
First Conversion | String | True | No | First form this contact submitted. | |
First Deal Created Date | Datetime | True | No | Date first deal was created for contact. Set automatically. | |
Gender | String | False | No | Contact's gender. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Graduation date | String | False | No | Contact's graduation date. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Additional email addresses | String | True | No | A set of additional email addresses for a contact | |
Business units | String | False | No | The business units this record is assigned to. | |
All vids for a contact | String | True | No | A set of all vids* canonical or otherwise* for a contact | |
First Touch Converting Campaign | String | True | No | Campaign responsible for the first touch creation of this contact. | |
Last Touch Converting Campaign | String | True | No | Campaign responsible for the last touch creation of this contact. | |
Avatar FileManager key | String | True | No | The path in the FileManager CDN for this contact's avatar override image. Automatically set by HubSpot. | |
Buying Role | String | False | No | 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 | No | A set of all form submissions for a contact | |
Merged vids with timestamps of a contact | String | True | No | Merged vids with timestamps of a contact | |
Calculated Mobile Number in International Format | String | True | No | Mobile number in international format | |
Calculated Phone Number in International Format | String | True | No | Phone number in international format | |
Calculated Phone Number Area Code | String | True | No | Area Code of the calculated phone number | |
Calculated Phone Number Country Code | String | True | No | Country code of the calculated phone number | |
Calculated Phone Number Region | String | True | No | ISO2 Country code for the derived phone number | |
Clicked on a LinkedIn Ad | String | False | No | Whether contact has clicked on a LinkedIn Ad | |
Email Confirmed | Bool | True | No | Email Confirmation status of user of Content Membership | |
Registration Follow Up Email Enqueued At | Datetime | False | No | The time when the first registration follow up email was enqueued | |
Membership Notes | String | False | No | Notes relating to the contact's content membership. | |
Registered At | Datetime | True | No | Datetime at which this user was set up for Content Membership | |
Domain to which registration email was sent | String | True | No | Domain to which the registration invitation email for Content Membership was sent to | |
Time registration email was sent | Datetime | True | No | Datetime at which this user was sent a registration invitation email for Content Membership | |
Status | String | False | No | Status of the contact's content membership. | |
Conversations visitor email | String | True | No | A Conversations visitor's email address | |
Count of unengaged contacts | Decimal | True | No | if contact is assigned and unworked* set to 1. if contact is assigned and worked* set to 0. | |
Count of engaged contacts | Decimal | True | No | if contact is assigned and worked* set to 1. if contact is assigned and unworked* set to 0. | |
Created By Conversations | Bool | True | No | Flag indicating this contact was created by the Conversations API | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Object create date_time | Datetime | True | No | 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 | No | The date and time when the contact entered the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date entered 'Evangelist Lifecycle Stage Pipeline' | Datetime | True | No | The date and time when the contact entered the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date entered 'Lead Lifecycle Stage Pipeline' | Datetime | True | No | 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 | No | 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 | No | The date and time when the contact entered the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date entered 'Other Lifecycle Stage Pipeline' | Datetime | True | No | 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 | No | 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 | No | The date and time when the contact entered the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date exited 'Customer Lifecycle Stage Pipeline' | Datetime | True | No | The date and time when the contact exited the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date exited 'Evangelist Lifecycle Stage Pipeline' | Datetime | True | No | The date and time when the contact exited the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date exited 'Lead Lifecycle Stage Pipeline' | Datetime | True | No | 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 | No | 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 | No | The date and time when the contact exited the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Date exited 'Other Lifecycle Stage Pipeline' | Datetime | True | No | 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 | No | 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 | No | The date and time when the contact exited the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Recent Document Revisit Date | Datetime | True | No | The last time a shared document presentation was accessed by this contact | |
Invalid email address | Bool | True | No | The email address associated with this contact is invalid. | |
Email address quarantine reason | String | False | No | The reason why the email address has been quarantined. | |
Email Domain | String | True | No | A contact's email address domain | |
Email hard bounce reason | String | True | No | 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 | No | 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 | No | 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 | No | The automated reason why the email address has been quarantined. | |
Email Address Recipient Fatigue Next Available Sending Time | Datetime | True | No | 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 | No | 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 | No | The status of a contact's eligibility to receive marketing email. This is automatically set by HubSpot. | |
Clicked Facebook ad | Bool | False | No | Whether contact has clicked a Facebook ad | |
Facebook click id | String | False | No | ||
Facebook ID | String | False | No | A contact's facebook id | |
Last NPS survey comment | String | True | No | Last NPS survey comment that this contact gave | |
Last NPS survey rating | String | True | No | Last NPS survey rating that this contact gave | |
Last NPS survey date | Datetime | True | No | 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 | No | Whether or not a contact should be shown an NPS web survey. This is automatically set by HubSpot. | |
ID of first engagement | Decimal | True | No | 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 | No | The create date of the first subscription by the contact. | |
Google ad click id | String | False | No | ||
googleplus ID | String | False | No | A contact's googleplus id | |
Contact has an active subscription | Decimal | True | No | The rollup property value is 1 when the contact has an active Subscription or 0 otherwise. | |
IP Timezone | String | True | No | 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 | No | Is a contact_ has not been deleted and is not a visitor | |
Contact unworked | Bool | True | No | Contact has not been assigned or has not been engaged after last owner assignment_re_assignment | |
last sales activity date old | Datetime | True | No | 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 | No | 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 | No | 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 | No | 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 | No | The last sequence ended date. | |
Last sequence enrolled | Decimal | True | No | The last sequence enrolled. | |
Last sequence enrolled date | Datetime | True | No | The last sequence enrolled date. | |
Last sequence finished date | Datetime | True | No | The last sequence finished date. | |
Last sequence unenrolled date | Datetime | True | No | The last sequence unenrolled date. | |
Latest Source Date | Date | False | No | The time of the latest session for a contact | |
Latest subscription create date | Datetime | True | No | The create date of the latest subscription by the contact. | |
Lead Status | String | False | No | The contact's sales_ prospecting or outreach status | |
Legal basis for processing contact's data | String | False | No | Legal basis for processing contact's data_ 'Not applicable' will exempt the contact from GDPR protections | |
Clicked LinkedIn Ad | String | False | No | ||
Linkedin ID | String | False | No | A contact's linkedin id | |
Marketing contact status source name | String | True | No | The ID of the activity that set the contact as a marketing contact | |
Marketing contact status source type | String | True | No | The type of the activity that set the contact as a marketing contact | |
Marketing contact status | String | True | No | The marketing status of a contact | |
Marketing contact until next update | String | True | No | Specifies if this contact will be set as non_marketing on renewal | |
Merged object IDs | String | True | No | 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 | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Pinned engagement ID | Decimal | True | No | ||
Pipeline | String | False | No | The pipeline with which this contact is currently associated | |
Likelihood to close | Decimal | True | No | 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 | No | 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 | No | Is the object read only | |
Date of first engagement | Datetime | True | No | The date the current contact owner first engaged with the contact. Used in Sales Analytics app. | |
Description of first engagement | String | True | No | 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 | No | 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 | No | The last time a tracked sales email was clicked by this user | |
Recent Sales Email Opened Date | Datetime | True | No | 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 | No | Mobile number with country code | |
Calculated Phone Number with country code | String | True | No | Phone number with country code | |
Calculated Mobile Number without country code | String | True | No | Mobile number without country code | |
Calculated Phone Number without country code | String | True | No | Phone number without country code | |
Number of sequences actively enrolled | Decimal | True | No | The number of sequences actively enrolled. | |
Number of sequences enrolled | Decimal | True | No | The number of sequences enrolled. | |
Currently in Sequence | Bool | True | No | A yes_no field that indicates whether the contact is currently in a Sequence. | |
testpurge | String | True | No | testing purge | |
testrollback | String | True | No | testing rollback | |
Time between contact creation and deal close | Decimal | False | No | ||
Time between contact creation and deal creation | Decimal | False | No | ||
Time in 'Customer Lifecycle Stage Pipeline' | Decimal | True | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | The total time in seconds spent by the contact in the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline | |
Lead response time | Decimal | True | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | How long it takes for a contact to move from the HubSpot subscriber stage to the HubSpot customer stage. | |
Time Zone | String | False | No | 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 | No | A contact's twitter id | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
WhatsApp Phone Number | String | False | No | The phone number associated with the contact_s WhatsApp account. | |
Owner Assigned Date | Datetime | True | No | 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 | No | 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 | No | 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 | No | 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 | No | ||
IP State_Region | String | True | No | 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 | No | 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 | No | 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 | No | Contact's job function. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Last Modified Date | Datetime | True | No | The date any property on this contact was modified | |
Marital Status | String | False | No | Contact's marital status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Military status | String | False | No | Contact's military status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Number of Associated Deals | Decimal | True | No | Count of deals associated with this contact. Set automatically by HubSpot. | |
Number of Form Submissions | Decimal | True | No | The number of forms this contact has submitted | |
Number of Unique Forms Submitted | Decimal | True | No | The number of different forms this contact has submitted | |
Recent Conversion Date | Datetime | True | No | The date this contact last submitted a form | |
Recent Conversion | String | True | No | The last form this contact submitted | |
Recent Deal Amount | Decimal | True | No | Amount of last closed won deal associated with a contact. Set automatically. | |
Recent Deal Close Date | Datetime | True | No | Date last deal associated with contact was closed_won. Set automatically. | |
Relationship Status | String | False | No | Contact's relationship status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
School | String | False | No | Contact's school. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Seniority | String | False | No | Contact's seniority. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Start date | String | False | No | Contact's start date. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
Total Revenue | Decimal | True | No | Sum of all closed_won deal revenue associated with the contact. Set automatically. | |
Work email | String | False | No | Contact's work email. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool. | |
First Name | String | False | No | A contact's first name | |
First Page Seen | String | True | No | First page the contact visited on your website. Set automatically. | |
Marketing emails delivered | Decimal | True | No | 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 | No | Indicates that the current email address has opted out of this email type. | |
Opted out of emailOne to One | String | True | No | This column is a custom field. Indicates that the current email address has opted out of this email type. | |
Twitter Username | String | False | No | The contact's Twitter handle. | |
Currently in workflow | String | True | No | True when contact is enrolled in a workflow. | |
Follower Count | Decimal | False | No | The number of Twitter followers a contact has | |
Last Page Seen | String | True | No | Last page the contact visited on your website. Set automatically. | |
Marketing emails opened | Decimal | True | No | The number of marketing emails opened for the current email address. This is automatically set by HubSpot. | |
Last Name | String | False | No | A contact's last name | |
Number of Pageviews | Decimal | True | No | Total number of page views this contact has had on your website. Set automatically. | |
Marketing emails clicked | Decimal | True | No | The number of marketing emails which have had link clicks for the current email address. This is automatically set by HubSpot. | |
Salutation | String | False | No | The title used to address a contact | |
Twitter Profile Photo | String | False | No | The contact's Twitter profile photo. This is set by HubSpot using the contact's email address. | |
String | False | No | A contact's email address | ||
Number of Sessions | Decimal | True | No | Number of times a contact has come to your website. Set automatically. | |
Marketing emails bounced | Decimal | True | No | The number of marketing emails that bounced for the current email address. This is automatically set by HubSpot. | |
Persona | String | False | No | A contact's persona | |
Most Recent Social Click | Datetime | True | No | 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 | No | Total number of events for this contact. Set automatically. | |
Unsubscribed from all email | Bool | True | No | Indicates that the current email address has opted out of all email. | |
Twitter Clicks | Decimal | True | No | 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 | No | A contact's mobile phone number | |
Phone Number | String | False | No | A contact's primary phone number | |
Fax Number | String | False | No | A contact's primary fax number | |
Time First Seen | Datetime | True | No | First time the contact has been seen. Set automatically. | |
Last marketing email name | String | True | No | 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 | No | 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 | No | The number clicks on links shared on Facebook | |
Street Address | String | False | No | Contact's street address_ including apartment or unit number. | |
Date of last meeting booked in meetings tool | Datetime | True | No | 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 | No | 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 | No | 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 | No | 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 | No | First time the contact visited your website. Set automatically. | |
Last marketing email open date | Datetime | True | No | 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 | No | 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 | No | 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 | No | The number clicks on links shared on LinkedIn | |
Contact owner | String | False | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | This field is meaningless on its own_ and is solely used for triggering dynamic list updates when webinar information is updated | |
City | String | False | No | A contact's city of residence | |
Time Last Seen | Datetime | True | No | Timestamp for most recent webpage view on your website. | |
Last marketing email click date | Datetime | True | No | 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 | No | The number clicks on links shared on Google Plus | |
HubSpot Team | String | True | No | The team of the owner of a contact. | |
LinkedIn Bio | String | False | No | A contact's LinkedIn bio | |
Twitter Bio | String | False | No | The contact's Twitter bio. This is set by HubSpot using the contact's email address. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
Time of Last Session | Datetime | True | No | Timestamp for start of the most recent session for this contact to your website. | |
First marketing email send date | Datetime | True | No | 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 | No | The number of clicks on published social messages. This is set automatically by HubSpot for each contact. | |
State_Region | String | False | No | The contact's state of residence. This might be set via import* form* or integration. | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom | |
Original Source | String | False | No | First known source the contact used to find your website. Set automatically_ but may be updated manually. | |
First marketing email open date | Datetime | True | No | 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 | No | The source of the latest session for a contact | |
Postal Code | String | False | No | The contact's zip code. This might be set via import* form* or integration. | |
Country_Region | String | False | No | The contact's countryregion of residence. This might be set via import form_ or integration. | |
All accessible team ids | String | True | No | 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 | No | Additional information about the source the contact used to find your website. Set automatically. | |
First marketing email click date | Datetime | True | No | 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 | No | Additional information about the latest source for the last session the contact used to find your website. Set automatically. | |
LinkedIn Connections | Decimal | False | No | How many LinkedIn connections they have | |
Original Source DrillDown 2 | String | True | No | Additional information about the source the contact used to find your website. Set automatically. | |
Is globally ineligible | Bool | True | No | Indicates the contact is globally ineligible for email. | |
Preferred language | String | False | No | 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 | No | Additional information about the source for the last session the contact used to find your website. Set automatically. | |
Klout Score | Decimal | False | No | A contact's Klout score_ a measure of Internet influence | |
First Referring Site | String | True | No | URL that referred the contact to your website. Set automatically. | |
First marketing email reply date | Datetime | True | No | 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 | No | A contact's job title | |
Photo | String | False | No | Social Media photo | |
Last Referring Site | String | True | No | Last URL that referred contact to your website. Set automatically. | |
Last marketing email reply date | Datetime | True | No | The date of the latest reply for any marketing email to the current email address. This is automatically set by HubSpot. | |
Message | String | False | No | A default property to be used for any message or comments a contact may want to leave on a form. | |
Close Date | Datetime | False | No | 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 | No | Average number of pageviews per session for this contact. Set automatically. | |
Marketing emails replied | Decimal | True | No | The number of marketing emails replied to by the current email address. This is automatically set by HubSpot. | |
Event Revenue | Decimal | True | No | 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 | No | 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 | No | 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 | No | The date when a contact's lifecycle stage changed to Opportunity. This is automatically set by HubSpot for each contact. | |
Lifecycle Stage | String | False | No | 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 | No | The date when a contact's lifecycle stage changed to SQL. This is automatically set by HubSpot for each contact. | |
Create Date | Datetime | True | No | The date that a contact entered the system | |
Became an Evangelist Date | Datetime | True | No | 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 | No | The date when a contact's lifecycle stage changed to Customer. This is automatically set by HubSpot for each contact. | |
HubSpot Score | Decimal | True | No | The number that shows qualification of contacts to sales readiness. It can be set in HubSpot's Lead Scoring app. | |
Company Name | String | False | No | 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 | No | 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 | No | The date when a contact's lifecycle stage changed to Other. This is automatically set by HubSpot for each contact. | |
Website URL | String | False | No | Associated company website. | |
Number of Employees | String | False | No | The number of company employees | |
Annual Revenue | String | False | No | Annual company revenue | |
Industry | String | False | No | The Industry a contact is in | |
Primary Associated Company ID | Decimal | False | No | HubSpot defined ID of a contact's primary associated company in HubSpot. | |
Associated Company Last Updated | Decimal | True | No | 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 | No | The rating of this contact based on their predictive lead score | |
Predictive Lead Score | Decimal | True | No | A score calculated by HubSpot that represents a contact's likelihood to become a customer |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ContactsId [KEY] | Long | False | Contacts.Id | No | Contacts ID |
DealsId [KEY] | Long | False | Deals.Id | No | Deals ID |
Type | String | False | No | Association type between associated objects. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | A unique ID for this association. | |
ObjectFullyQualifiedName [KEY] | String | False | No | A unique ID for this schema's object type. It is defined as _meta_type*__unique ID*. | |
ObjectTypeId | String | True | No | The ID of the custom object type. | |
ObjectId | String | True | No | An assigned unique ID for the object_ including portal ID and object name. | |
ObjectName | String | True | No | A unique name for the schema's object type. | |
ObjectLabelSingular | String | True | No | Singular label for the object. Used in CRM display. | |
ObjectLabelPlural | String | True | No | Plural label for the object. Used in CRM display. | |
Name | String | False | No | A unique name for this association. | |
Cardinality | String | False | No | The cardinality type. | |
InverseCardinality | String | False | No | The inverseCardinality type. | |
FromObjectTypeId | String | False | No | ID of the primary object type to link from. | |
ToObjectTypeId | String | False | No | ID of the target object type ID to link to. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
ObjectId | String | False | No | An assigned unique ID for the object_ including portal ID and object name. | |
ObjectFullyQualifiedName [KEY] | String | False | No | A unique ID for this schema's object type. It is defined as _meta_type*__unique ID*. | |
ObjectName | String | False | No | A unique name for the schema's object type. | |
ObjectLabelSingular | String | False | No | Singular label for the object. Used in CRM display. | |
ObjectLabelPlural | String | False | No | Plural label for the object. Used in CRM display. | |
Name [KEY] | String | False | No | The internal property name_ which must be used when referencing the property via the API. | |
Label | String | False | No | A human_readable property label that will be shown in HubSpot. | |
UpdatedAt | Datetime | False | No | When the Custom Object was last updated. | |
CreatedAt | Datetime | False | No | When the Custom Object was created. | |
ArchivedAt | Datetime | False | No | When the Custom Object was archived. | |
Type | String | False | No | The property data type. | |
FieldType | String | False | No | Controls how the property appears in HubSpot. | |
Description | String | False | No | A description of the property that will be shown as help text in HubSpot. | |
GroupName | String | False | No | The name of the property group the property belongs to. | |
Options | String | False | No | 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 | No | 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 | No | 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 | No | If this property is related to other object_s__ they'll be listed here. | |
DisplayOrder | Int | False | No | 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 | No | For default properties_ true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties. | |
ExternalOptions | Bool | False | No | For default properties_ true indicates that the options are stored externally to the property settings. | |
Archived | Bool | False | No | Whether or not the property is archived. | |
HasUniqueValue | Bool | False | No | Whether or not the property's value must be unique. Once set_ this can't be changed. | |
Hidden | Bool | False | No | Whether or not the property is hidden. | |
HubspotDefined | Bool | False | No | This will be true for default object properties built into HubSpot. | |
ShowCurrencySymbol | Bool | False | No | Whether the property will display the currency symbol set in the account settings. | |
ModificationMetadata | String | False | No | The properties' modification metadata. | |
FormField | Bool | False | No | Whether or not the property can be used in a HubSpot form. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id | String | False | No | An assigned unique ID for the object_ including portal ID and object name. | |
FullyQualifiedName [KEY] | String | False | No | A unique ID for this schema's object type. It is defined as _meta_type*__unique ID*. | |
Name | String | False | No | A unique name for the schema's object type. | |
LabelSingular | String | False | No | Singular label for the object. Used in CRM display. | |
LabelPlural | String | False | No | Plural label for the object. Used in CRM display. | |
CreatedAt | Datetime | False | No | When the Custom Object was created. | |
UpdatedAt | Datetime | False | No | When the Custom Object was last updated. | |
PropertiesAggregate | String | False | No | 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 | No | 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 | No | The names of properties that should be required when creating an object of this type. | |
SearchableProperties | String | False | No | Names of properties that will be indexed for this object type in by HubSpot's product search. | |
PrimaryDisplayProperty | String | False | No | 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 | No | 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 | No | The ID of the custom object type. | |
MetaType | String | False | No | The custom object type description. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Deals.Id | No | Deals ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Deals object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object* which can be a contact* deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identified of the pipeline. | |
Label | String | False | No | The label name of the pipeline. | |
Archived | Bool | True | No | Whether the pipeline is archived or not. | |
CreatedAt | Datetime | True | No | When the pipeline was created. | |
UpdatedAt | Datetime | True | No | When the pipeline was last updated. | |
DisplayOrder | Int | False | No | The order of this specific pipeline in the collection of pipelines for this table. | |
StagesAggregate | String | False | No | An aggregate of the stages included in this pipeline. This information can be viewed in more detail in DealPipelineStages table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier of the stage in the pipeline. | |
PipelineId [KEY] | String | False | DealPipelines.Id | No | Unique identifier of the pipeline. |
Label | String | False | No | Label name of the pipeline stage. | |
PipelineLabel | String | True | DealPipelines.Label | No | The label name of the pipeline. |
IsClosed | Bool | False | No | Whether this stage is open or closed. | |
Probability | Decimal | False | No | Current state of the pipeline stage. | |
Archived | Bool | True | No | Whether the stage is archived or not. | |
CreatedAt | Datetime | True | No | Time the stage was created. | |
UpdatedAt | Datetime | True | No | Time the stage was last updated. | |
DisplayOrder | Int | False | No | The order of the stage in the collection of stages for this pipeline. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. | |
HasUniqueValue | Bool | False | No | Boolean indicating if the value of the property is unique. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
PropertyName | String | True | No | The name of the property. | |
Value | String | True | No | The historical value of the property. | |
SourceType | String | True | No | The method by which the property was changed. | |
SourceId | String | True | No | Additional data related to the source. May not be populated for all sources. | |
Timestamp | Datetime | True | No | Datetime when the property was updated. | |
DealId | Long | True | No | The deal identifier. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | The name of the property group. | |
Label | String | False | No | The label of the group. | |
DisplayOrder | Int | False | No | The numerical order of the group with respect to other groups. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
ItemURL | String | True | No | Url that points directly to the HubSpot item. | |
Amount in company currency | Decimal | True | No | The amount of the deal* using the exchange rate* in your company's currency | |
Days to close | Decimal | True | No | The number of days the deal took to close | |
Currency | String | False | No | Currency code for the deal. | |
Annual contract value | Decimal | True | No | The annual contract value ACV of this deal. | |
Business units | String | False | No | The business units this record is assigned to. | |
Deal Collaborator | String | True | No | Owner ids of the users involved in closing the deal | |
Deal Split Users | String | True | No | The owner ids of all associated Deal Splits. This property is set automatically by HubSpot. | |
Latest Source | String | True | No | Source for the contact either directly or indirectly associated with the last session activity for this deal | |
Latest Source Company | String | True | No | Source for the company with an associated contact with the last session activity for this deal | |
Latest Source Contact | String | True | No | Source for the directly associated contact with the last session activity for this deal | |
Latest Source Data 1 | String | True | No | 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 | No | 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 | No | Additional source details of the last session attributed to any contacts that are directly associated with this deal | |
Latest Source Data 2 | String | True | No | 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 | No | 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 | No | Additional source details of the last session attributed to any contacts that are directly associated with this deal | |
Latest Source Timestamp | Datetime | True | No | Timestamp of when latest source occurred for either a directly or indirectly associated contact | |
Latest Source Timestamp Company | Datetime | True | No | Timestamp of when latest source occurred for an indirectly associated contact | |
Latest Source Timestamp Contact | Datetime | True | No | Timestamp of when latest source occurred for a directly associated contact | |
Original Source Type | String | False | No | Original source for the contact with the earliest activity for this deal. | |
Original Source Data 1 | String | True | No | 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 | No | 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 | No | The annual recurring revenue ARR of this deal. | |
HubSpot Campaign | String | False | No | The marketing campaign the deal is associated with | |
Closed Deal Amount | Decimal | True | No | Returns the amount if the deal is closed. Else_ returns 0. | |
Closed Deal Amount In Home Currency | Decimal | True | No | Returns the amount in home currency if the deal is closed. Else_ returns 0. | |
Created by user ID | Decimal | True | No | 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 | No | The date and time when the deal entered the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline | |
Date entered 'Closed Lost Sales Pipeline' | Datetime | True | No | The date and time when the deal entered the 'Closed Lost' stage_ 'Sales Pipeline' pipeline | |
Date entered 'Closed Won Sales Pipeline' | Datetime | True | No | The date and time when the deal entered the 'Closed Won' stage_ 'Sales Pipeline' pipeline | |
Date entered 'Contract Sent Sales Pipeline' | Datetime | True | No | The date and time when the deal entered the 'Contract Sent' stage_ 'Sales Pipeline' pipeline | |
Date entered 'Decision Maker BoughtIn Sales Pipeline' | Datetime | True | No | The date and time when the deal entered the 'Decision Maker BoughtIn' stage 'Sales Pipeline' pipeline | |
Date entered 'Presentation Scheduled Sales Pipeline' | Datetime | True | No | The date and time when the deal entered the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline | |
Date entered 'Qualified To Buy Sales Pipeline' | Datetime | True | No | The date and time when the deal entered the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline | |
Date exited 'Appointment Scheduled Sales Pipeline' | Datetime | True | No | The date and time when the deal exited the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline | |
Date exited 'Closed Lost Sales Pipeline' | Datetime | True | No | The date and time when the deal exited the 'Closed Lost' stage_ 'Sales Pipeline' pipeline | |
Date exited 'Closed Won Sales Pipeline' | Datetime | True | No | The date and time when the deal exited the 'Closed Won' stage_ 'Sales Pipeline' pipeline | |
Date exited 'Contract Sent Sales Pipeline' | Datetime | True | No | The date and time when the deal exited the 'Contract Sent' stage_ 'Sales Pipeline' pipeline | |
Date exited 'Decision Maker BoughtIn Sales Pipeline' | Datetime | True | No | The date and time when the deal exited the 'Decision Maker BoughtIn' stage 'Sales Pipeline' pipeline | |
Date exited 'Presentation Scheduled Sales Pipeline' | Datetime | True | No | The date and time when the deal exited the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline | |
Date exited 'Qualified To Buy Sales Pipeline' | Datetime | True | No | The date and time when the deal exited the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline | |
Deal amount calculation preference | String | False | No | Specifies how deal amount should be calculated from line items | |
Deal probability | Decimal | False | No | The probability a deal will close. This defaults to the deal stage probability setting. | |
Deal stage probability shadow | Decimal | True | No | 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 | No | This is the exchange rate used to convert the deal amount into your company currency. | |
Forecast amount | Decimal | True | No | The custom forecasted deal value calculated by multiplying the forecast probability and deal amount in your company_s currency. | |
Forecast probability | Decimal | False | No | The custom percent probability a deal will close. | |
Is Deal Closed_ | Bool | True | No | True if the deal was won or lost. | |
Is Closed Won | Bool | True | No | True if the deal is in the closed won state_ false otherwise | |
Deal Split Added | Bool | True | No | Indicates if the deal is split between multiple users. | |
Last Modified Date | Datetime | True | No | 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 | No | Hubspot predicted likelihood between 0 and 1 of the deal to close by the close date. | |
Global Term Line Item Discount Percentage | String | False | No | For internal HubSpot Application use only. Global term for the discount percentage applied. | |
Global Term Line Item Discount Percentage Enabled | Bool | False | No | 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 | No | For internal HubSpot Application use only. Global term for product recurring billing duration. | |
Global Term Line Item Recurring Billing Period Enabled | Bool | False | No | 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 | No | 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 | No | 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 | No | 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 | No | For internal HubSpot Application use only. Indicates if the Global term for how frequently the product is billed is enabled | |
Forecast category | String | False | No | The likelihood a deal will close. This property is used for manual forecasting your deals. | |
Merged object IDs | String | True | No | 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 | No | The monthly recurring revenue MRR of this deal. | |
Next step | String | False | No | A short description of the next step for the deal | |
Number of Active Deal Registrations | Decimal | True | No | The number of active deal registrations associated with this deal. This property is set automatically by HubSpot. | |
Number of Deal Registrations | Decimal | True | No | The number of deal registrations associated with this deal. This property is set automatically by HubSpot. | |
Number of Deal Splits | Decimal | True | No | The number of deal splits associated with this deal. This property is set automatically by HubSpot. | |
Number of target accounts | Decimal | True | No | The number of target account companies associated with this deal. This property is set automatically by HubSpot. | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Pinned Engagement ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | ||
Weighted amount | Decimal | True | No | Returns the multiplication of the amount times the probability of the deal closing. | |
Weighted amount in company currency | Decimal | True | No | Returns the multiplication of the amount in home currency times the probability of the deal closing. | |
Read Only Object | Bool | True | No | Is the object read only | |
Total contract value | Decimal | True | No | The total contract value TCV of this deal. | |
Time in 'Appointment Scheduled Sales Pipeline' | Decimal | True | No | 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 | No | 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 | No | 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 | No | 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 | No | The total time in seconds spent by the deal in the 'Decision Maker BoughtIn' stage 'Sales Pipeline' pipeline | |
Time in 'Presentation Scheduled Sales Pipeline' | Decimal | True | No | 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 | No | The total time in seconds spent by the deal in the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner Assigned Date | Datetime | True | No | The date the most recent deal owner was assigned to a deal. This is updated automatically by HubSpot. | |
Deal Name | String | False | No | The name given to this deal. | |
Amount | Decimal | False | No | The total amount of the deal | |
Deal Stage | String | False | No | 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 | No | The pipeline the deal is in. This determines which stages are options for the deal. | |
Close Date | Datetime | False | No | Date the deal was closed. This property is set automatically by HubSpot. | |
Create Date | Datetime | False | No | Date the deal was created. This property is set automatically by HubSpot. | |
Date of last meeting booked in meetings tool | Datetime | True | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | The last time a tracked sales email was replied to for this deal | |
Deal owner | String | False | No | User the deal is assigned to. Assign additional users to a deal record by creating a custom user property. | |
Last Contacted | Datetime | True | No | 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 | No | 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 | No | 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 | No | 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 | No | 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 | No | The date the deal was created. This property is set automatically by HubSpot. | |
HubSpot Team | String | True | No | Primary team of the deal owner. This property is set automatically by HubSpot. | |
Deal Type | String | False | No | The type of deal. By default_ categorize your deal as either a New Business or Existing Business. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
Deal Description | String | False | No | Description of the deal | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom | |
All accessible team ids | String | True | No | 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 | No | The number of contacts associated with this deal. This property is set automatically by HubSpot. | |
Closed Lost Reason | String | False | No | Reason why this deal was lost | |
Closed Won Reason | String | False | No | Reason why this deal was won |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Emails ID | |
AssociationId [KEY] | Long | False | No | ID of the object that this Emails object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object, which can be a contact, deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Call and meeting type | String | False | No | The activity type of the engagement | |
Business units | String | False | No | The business units this record is assigned to. | |
AtMentioned Owner Ids | String | False | No | The owners that have been at_mentioned on the engagement | |
Attached file IDs | String | False | No | The IDs of the files that are attached to the engagement | |
Call notes preview | String | True | No | A truncated preview of the call notes | |
HTML Body Preview | String | True | No | The HTML representation of the engagement body preview | |
Body Preview Truncated | Bool | True | No | Indicates if the engagement body was truncated for the preview | |
Integrating App ID | Decimal | False | No | The App ID associated with the integrating app | |
Authenticated recording files url provider | String | True | No | URL which returns Authenticated audio_video URL of the recording | |
Call notes | String | False | No | The body of the call | |
Callee object id | Decimal | False | No | The id of the callee | |
Callee object type | String | False | No | The type of callee | |
Call direction | String | False | No | The direction of a call | |
Call outcome | String | False | No | The outcome of the call | |
Call duration | Decimal | False | No | The duration of the call_ in milliseconds | |
External Account ID | String | False | No | External Account ID | |
External ID | String | False | No | The external ID of the call | |
From Number | String | False | No | The phone number of the person that initiated the call | |
From Number Name | String | True | No | The name of the phone number that initiated the call | |
Transcript Available | Bool | False | No | Flag to indicate if the call has an associated transcript | |
Voicemail Available | String | True | No | Flag to indicate if the call has an associated voicemail | |
Recording URL | String | False | No | The URL of the recorded call audio | |
Call Source | String | False | No | The source of the call to differentiate VoIP vs Video Conferencing Apps | |
Call status | String | False | No | The status of the call | |
Call Title | String | False | No | The title of the call | |
To Number | String | False | No | The phone number of the person that was called | |
To Number Name | String | True | No | The name of the phone number that was called | |
Tracked terms | String | True | No | A list of any tracked terms contained in the call transcript | |
Call transcription id | Decimal | False | No | The id of the transcription | |
Video url | String | False | No | Video URL of the recording | |
Unique Zoom Meeting ID | String | False | No | The Zoom meeting unique identifier of the call | |
Calls Service Call ID | Decimal | True | No | The Calls Service specific global unique identifier for a call | |
Activity created by | Decimal | True | No | The user who created the engagement | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Create date | Datetime | True | No | The date that an engagement was created | |
Engagement Source | String | False | No | The source that created this engagement | |
Engagement Source ID | String | False | No | The specific ID of the process that created this engagement | |
Follow up action | String | False | No | What action should be performed during follow up | |
GDPR deleted | Bool | True | No | Indicates the body of this engagement has been cleared because of a GDPR delete request | |
Last modified date | Datetime | True | No | The date any property on this engagement was modified | |
Merged object IDs | String | True | No | 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 | No | The user who last updated the engagement | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Product name | String | False | No | The name of the product associated with this engagement | |
Queue Memberships | String | False | No | The list of queues that contain this engagement | |
Read Only Object | Bool | True | No | Is the object read only | |
Activity date | Datetime | False | No | The date that an engagement occurred | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Unique ID | String | False | No | The unique ID of the engagement | |
Unknown Visitor Conversation | Bool | False | No | Whether or not this communication was made with an unknown visitor | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner Assigned Date | Datetime | True | No | The timestamp when an owner was assigned to this engagement | |
Activity assigned to | String | False | No | 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 | No | The team of the owner of an engagement. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom | |
All accessible team ids | String | True | No | The team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Business units | String | False | No | The business units this record is assigned to. | |
AtMentioned Owner Ids | String | False | No | The owners that have been at_mentioned on the engagement | |
Attached file IDs | String | False | No | The IDs of the files that are attached to the engagement | |
Body preview | String | True | No | A truncated preview of the engagegement body | |
HTML Body Preview | String | True | No | The HTML representation of the engagement body preview | |
Body Preview Truncated | Bool | True | No | Indicates if the engagement body was truncated for the preview | |
Activity created by | String | True | No | The user who created the engagement | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Create date | Datetime | True | No | The date that an engagement was created | |
Email direction and unique ID | String | True | No | The direction and unique ID of the email | |
Attached Video | String | False | No | The ID of a video optionally attached to an email | |
Attached Video Name | String | False | No | The name of a video optionally attached to an email | |
Attached Video Opened | Bool | False | No | Has the video attachment been opened | |
Attached Video Watched | Bool | False | No | Has the video attachement been watched | |
Email BCC Address | String | True | No | Email addresses of the email's BCC recipients | |
Email BCC First Name | String | True | No | First names of the email's BCC recipients | |
Email BCC Last Name | String | True | No | Last names of the email's BCC recipients | |
Email BCC | String | True | No | Raw header values of the email's BCC recipients | |
Email Bounce Error Detail Message | String | False | No | The message from the bounce error. | |
Email Bounce Error Detail Status Code | Decimal | False | No | The status code from the bounce error. | |
Email CC Address | String | True | No | Email addresses of the email's CC recipients | |
Email CC First Name | String | True | No | First names of the email's CC recipients | |
Email CC Last Name | String | True | No | Last names of the email's CC recipients | |
Email CC | String | True | No | Raw header values of the email's CC recipients | |
Email Direction | String | False | No | The direction the email was sent in | |
Encoded Email Associations Request | String | True | No | Encoded email associations request | |
Error Message | String | False | No | The error that occurred while sending the email | |
Email Send Id | String | True | No | The ID of the email send event sent through Facsimile | |
Email From Address | String | True | No | Email address of the email's sender | |
Email From First Name | String | True | No | First name of the email's sender | |
Email From Last Name | String | True | No | Last name of the email's sender | |
Email From | String | True | No | Raw header value of the email's sender | |
Email Headers | String | False | No | The sender and receivers of the email | |
Email body | String | False | No | This is the body of any email sent from a record. It doesn't include emails received from contacts. | |
Logged From | String | False | No | Where the email was logged | |
Media Processing Status | String | False | No | Processing status for this email's images and attachments | |
Email is member of forwarded subthread | Bool | False | No | Whether this email is a member of a forwarded subthread | |
Message ID | String | False | No | The ID of the message | |
EmailMigratedViaPortalDataMigration | String | False | No | Indicates that the email was migrated from another portal using DataMigration tool | |
Email pending inline image file IDs | String | False | No | File IDs of pending inline images in the email's HTML | |
PostSend Status | String | False | No | A description of what happened to the email successful send bounced* dropped* and why | |
RecipientDrop Reasons | String | False | No | A list of the dropped recipients paired with the reason each was dropped | |
Email Send Event Id | String | False | No | The ID of the email send event | |
Email Send Event Id Created | Datetime | False | No | The date when the email send event ID was created | |
Email Sender Address | String | True | No | Email address of the email's sender | |
Email Sender First Name | String | True | No | First name of the email's sender | |
Email Sender Last Name | String | True | No | Last name of the email's sender | |
Email Sender | String | True | No | Raw header value of the email's sender | |
Sent Via | String | False | No | How the email was sent | |
Email send status | String | False | No | The send status of the email | |
Email subject | String | False | No | The subject of the email | |
Text | String | False | No | The plaintext of the email | |
Thread ID | String | False | No | The thread that the email belongs to | |
Email To Address | String | True | No | Email addresses of the email's recipients | |
Email To First Name | String | True | No | First names of the email's recipients | |
Email To Last Name | String | True | No | Last names of the email's recipients | |
Email To | String | True | No | Raw header values of the email's recipients | |
Tracker Key | String | False | No | The tracker key of the email | |
Validation Skipped | String | False | No | Validation skipped that would have otherwise rejected logging | |
Engagement Source | String | False | No | The source that created this engagement | |
Engagement Source ID | String | False | No | The specific ID of the process that created this engagement | |
Follow up action | String | False | No | What action should be performed during follow up | |
GDPR deleted | Bool | True | No | Indicates the body of this engagement has been cleared because of a GDPR delete request | |
Last modified date | Datetime | True | No | The date any property on this engagement was modified | |
Merged object IDs | String | True | No | 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 | No | The user who last updated the engagement | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Product name | String | False | No | The name of the product associated with this engagement | |
Queue Memberships | String | False | No | The list of queues that contain this engagement | |
Read Only Object | Bool | True | No | Is the object read only | |
Activity date | Datetime | False | No | The date that an engagement occurred | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Unique ID | String | False | No | The unique ID of the engagement | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner Assigned Date | Datetime | True | No | The timestamp when an owner was assigned to this engagement | |
Activity assigned to | String | False | No | 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 | No | The team of the owner of an engagement. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom | |
All accessible team ids | String | True | No | The team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Call and meeting type | String | False | No | The activity type of the engagement | |
Business units | String | False | No | The business units this record is assigned to. | |
AtMentioned Owner Ids | String | False | No | The owners that have been at_mentioned on the engagement | |
Attached file IDs | String | False | No | The IDs of the files that are attached to the engagement | |
HubSpot attendee owner IDs | String | False | No | List of HubSpot owner IDs for additional attendees | |
Body preview | String | True | No | A truncated preview of the engagegement body | |
HTML Body Preview | String | True | No | The HTML representation of the engagement body preview | |
Body Preview Truncated | Bool | True | No | Indicates if the engagement body was truncated for the preview | |
Activity created by | Decimal | True | No | The user who created the engagement | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Create date | Datetime | True | No | The date that an engagement was created | |
Engagement Source | String | False | No | The source that created this engagement | |
Engagement Source ID | String | False | No | The specific ID of the process that created this engagement | |
Follow up action | String | False | No | What action should be performed during follow up | |
GDPR deleted | Bool | True | No | Indicates the body of this engagement has been cleared because of a GDPR delete request | |
iCalUid | String | True | No | The iCalUid of the synced event | |
Internal Meeting Notes | String | False | No | ||
Last modified date | Datetime | True | No | The date any property on this engagement was modified | |
Meeting description | String | False | No | The text description of the meeting | |
Meeting calendar event hash | String | False | No | The unique hash for the meeting | |
Meeting change id | String | False | No | The unique change id for the meeting | |
Created From Link ID | String | False | No | Created From Link ID | |
Meeting end time | Datetime | False | No | The date when the meeting ends | |
External URL | String | False | No | The external URL for the meeting | |
Meeting location | String | False | No | Where the meeting takes place | |
Location type | String | False | No | The type of location for the meeting event | |
Meeting outcome | String | False | No | The outcome of this meeting | |
Payments session id | String | False | No | The payments session id for the meeting | |
PreMeeting prospect reminders | String | False | No | A list of dates when meeting reminders should be sent to prospects | |
Meeting source | String | True | No | The source where the meeting was booked | |
Source ID | String | False | No | The source ID of the meeting | |
Meeting start time | Datetime | False | No | The date when the meeting starts | |
Meeting name | String | False | No | The title of the meeting | |
Web conference meeting ID | String | False | No | The meeting ID of the web conference | |
Merged object IDs | String | True | No | 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 | No | The user who last updated the engagement | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Product name | String | False | No | The name of the product associated with this engagement | |
Queue Memberships | String | False | No | The list of queues that contain this engagement | |
Read Only Object | Bool | True | No | Is the object read only | |
Scheduled tasks | String | True | No | ||
Activity date | Datetime | False | No | The date that an engagement occurred | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Unique ID | String | False | No | The unique ID of the engagement | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner Assigned Date | Datetime | True | No | The timestamp when an owner was assigned to this engagement | |
Activity assigned to | String | False | No | 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 | No | The team of the owner of an engagement. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom | |
All accessible team ids | String | True | No | The team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Business units | String | False | No | The business units this record is assigned to. | |
AtMentioned Owner Ids | String | False | No | The owners that have been at_mentioned on the engagement | |
Attached file IDs | String | False | No | The IDs of the files that are attached to the engagement | |
Body preview | String | True | No | A truncated preview of the engagegement body | |
HTML Body Preview | String | True | No | The HTML representation of the engagement body preview | |
Body Preview Truncated | Bool | True | No | Indicates if the engagement body was truncated for the preview | |
Activity created by | Decimal | True | No | The user who created the engagement | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Create date | Datetime | True | No | The date that an engagement was created | |
Engagement Source | String | False | No | The source that created this engagement | |
Engagement Source ID | String | False | No | The specific ID of the process that created this engagement | |
Follow up action | String | False | No | What action should be performed during follow up | |
GDPR deleted | Bool | True | No | Indicates the body of this engagement has been cleared because of a GDPR delete request | |
Last modified date | Datetime | True | No | The date any property on this engagement was modified | |
Merged object IDs | String | True | No | 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 | No | The user who last updated the engagement | |
Note body | String | False | No | The body of the note | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Product name | String | False | No | The name of the product associated with this engagement | |
Queue Memberships | String | False | No | The list of queues that contain this engagement | |
Read Only Object | Bool | True | No | Is the object read only | |
Activity date | Datetime | False | No | The date that an engagement occurred | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Unique ID | String | False | No | The unique ID of the engagement | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner Assigned Date | Datetime | True | No | The timestamp when an owner was assigned to this engagement | |
Activity assigned to | String | False | No | 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 | No | The team of the owner of an engagement. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom | |
All accessible team ids | String | True | No | The team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Business units | String | False | No | The business units this record is assigned to. | |
AtMentioned Owner Ids | String | False | No | The owners that have been at_mentioned on the engagement | |
Attached file IDs | String | False | No | The IDs of the files that are attached to the engagement | |
Notes preview | String | True | No | A plain_text preview of the notes field on a task | |
HTML Body Preview | String | True | No | The HTML representation of the engagement body preview | |
Body Preview Truncated | Bool | True | No | Indicates if the engagement body was truncated for the preview | |
Calendar Event ID | String | True | No | The event ID for the synced task. | |
Created by | Decimal | True | No | The user who created the engagement | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Created at | Datetime | True | No | The date that an engagement was created | |
Source | String | False | No | The source that created this engagement | |
Source ID | String | False | No | The specific ID of the process that created this engagement | |
Follow up action | String | False | No | What action should be performed during follow up | |
GDPR deleted | Bool | True | No | Indicates the body of this engagement has been cleared because of a GDPR delete request | |
Last modified at | Datetime | True | No | The date any property on this engagement was modified | |
Merged object IDs | String | True | No | 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 | No | The user who last updated the engagement | |
MS Teams message ID | String | True | No | The message ID for the created task. | |
Associated Companies | Decimal | True | No | The number of companies associated with this task | |
Associated Contacts | Decimal | True | No | The number of contacts associated with this task | |
Associated Deals | Decimal | True | No | The number of deals associated with this task | |
Associated Queue Objects | Decimal | True | No | The number of objects associated with this task that support task queues | |
Associated Tickets | Decimal | True | No | The number of tickets associated with this task | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Product name | String | False | No | The name of the product associated with this engagement | |
Queue | String | False | No | The list of queues that contain this engagement | |
Read Only Object | Bool | True | No | Is the object read only | |
Task repeat status | String | True | No | Indicates whether the task is currently repeating | |
Scheduled tasks | String | True | No | ||
Notes | String | False | No | The content in the notes field on a task | |
Completed at | Datetime | True | No | The date that the task was completed | |
Contact Time Zone | String | True | No | The time zone of the associated contact | |
For Object Type | String | False | No | The object type for the task | |
Task is all day | Bool | False | No | Determines if the task is due all day or at a specific time | |
Last contacted | Datetime | True | No | 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 | No | 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 | No | The priority of the task | |
Task probability to complete | Decimal | True | No | The probability the task will be completed | |
Relative Task Reminders | String | False | No | The dates relative to the due date when reminders will be sent | |
Reminder | String | False | No | The dates when reminders will be sent | |
Interval | String | True | No | How often the task should repeat | |
Send Default Reminder | Bool | False | No | Whether or not a reminder should be sent when the task is due | |
Sequence Enrollment Is Active | Bool | True | No | Whether the sequence enrollment this task is a part of is currently active | |
Sequence step enrollment Id | String | True | No | The id of the sequence step that created the task | |
Sequence step number | Decimal | True | No | The order of this task in the sequence at time of enrollment | |
Task Status | String | False | No | The status of the task | |
Task Title | String | False | No | The subject text for the task | |
Task template id | Decimal | True | No | The id of template the task was created from | |
Task Type | String | False | No | The type of task | |
Due date | Datetime | False | No | The date that an engagement occurred | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Unique ID | String | False | No | The unique ID of the engagement | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner Assigned Date | Datetime | True | No | The timestamp when an owner was assigned to this engagement | |
Assigned to | String | False | No | 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 | No | The team of the owner of an engagement. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom | |
All accessible team ids | String | True | No | The team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Feedbacksubmissions.Id | No | Feedbacksubmissions ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Feedbacksubmissions object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object* which can be a contact* deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Agent email | String | True | No | Conversation agent's email | |
Agent responsible for the conversation | Decimal | True | No | Agent responsible for the conversation which led to the feedback | |
Agent name | String | True | No | Conversation agent's full name | |
All accessible team IDs | String | True | No | 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 | No | The business units this record is assigned to. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom. | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom. | |
Chatflow ID | Decimal | True | No | Chatflow ID of the conversation associated to the submission | |
Chatflow name | String | True | No | The name of the chatflow associated to the submission | |
Chatflow object id | Decimal | True | No | Chatflow object id of the conversation associated to the submission | |
Contact first name | String | True | No | First name of the contact associated with the submission | |
Contact Id | Decimal | True | No | The id of the contact most recently associated with this submission | |
Contact last name | String | True | No | Last name of the contact associated with the submission | |
Conversation thread id | Decimal | True | No | Thread id of the conversation associated to the submission | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Object create date_time | Datetime | True | No | 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 | No | 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 | No | 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 | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Read Only Object | Bool | True | No | Is the object read only | |
Tag IDs | String | True | No | Tag IDs assigned to this submission. | |
Tags | String | True | No | Tags assigned to this submission. | |
Ticket id | Decimal | True | No | ID of the ticket associated with the submission | |
Ticket owner avatar uri | String | True | No | Avatar URI of the ticket associated to the feedback's owner | |
Ticket owner | Decimal | True | No | User the ticket is assigned to which is associated to feedback submission | |
Ticket name | String | True | No | Short summary of ticket associated with the submission | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner Assigned Date | Datetime | True | No | 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 | No | The owner of the object. | |
HubSpot Team | String | True | No | The primary team of the owner. | |
Industry Standard Question Type | String | True | No | Industry standard question type for custom surveys | |
Sentiment | String | True | No | This column is a custom field. Sentiment of feedback submission based on survey type | |
Survey ID | Decimal | True | No | The survey id that the feedback submission is linked with | |
Survey Type | String | True | No | The type of the survey | |
Source | String | True | No | The channel of the survey when the feedback submission occurred | |
Date | Datetime | True | No | The timestamp of the feedback submission | |
Rating | Decimal | True | No | The value of the feedback submission | |
Feedback sentiment | String | True | No | The sentiment of the feedback submission | |
Response | String | False | No | The follow_up response of the feedback submission | |
Ingestion id | String | True | No | The identifier we use when we initially capture a feedback submission | |
Knowledge article id | Decimal | True | No | The id of the knowledge article this submission was for | |
Visitor id | Decimal | True | No | The id of the visitor who submitted this feedback | |
Engagement id | Decimal | True | No | The id of the equivalent engagement object | |
Submission URL | String | True | No | The URL of the page the submission was made from | |
Survey Name | String | True | No | The name of the feedback survey the submission is linked with | |
Form guid | String | True | No | The form guid that the feedback submission is linked with | |
String | True | No | The email of the contact associated with a feedback submission | ||
Submission Name | String | True | No | The email of the contact associated with a feedback submission |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | False | No | File ID. | |
Name | String | False | No | Name of the file. | |
Extension | String | False | No | Extension of the file. For example png. | |
Access | String | False | No | File access. | |
CreatedAt | Datetime | False | No | Creation time of the file object. | |
UpdatedAt | Datetime | False | No | Timestamp of the latest update to the file. | |
Archived | Bool | False | No | If the file is deleted. | |
ArchivedAt | Datetime | False | No | Deletion time of the file object. | |
Type | String | False | No | Type of the file. | |
IsUsableInContent | Bool | False | No | Indicates if the file should be used when creating new content like web pages. | |
Encoding | String | False | No | Encoding of the file. | |
Size | Long | False | No | Size in bytes of the file. | |
Height | Int | False | No | For image and video files, the height of the content. | |
Width | Int | False | No | For image and video files, the width of the content. | |
Path | String | False | No | Path of the file in the file manager. | |
ParentFolderId | Long | False | No | Id of the folder the file is in. | |
Url | String | False | No | 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 | False | No | Default hosting URL of the file. This will use one of HubSpot's provided URLs to serve the file. | |
AllowsAnonymousAccess | Bool | False | No | If 'true' will show private files; if 'false' will show public files. The output will mirror the input value. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | False | No | Id of the folder. | |
Name | String | False | No | Name of the folder. | |
Path | String | False | No | Path of the folder in the file manager. | |
ParentFolderId | Long | False | No | Id of the parent folder. | |
CreatedAt | Datetime | False | No | Timestamp of folder creation. | |
UpdatedAt | Datetime | False | No | Timestamp of the latest update to the folder. | |
Archived | Bool | False | No | Marks weather the folder is deleted or not. | |
ArchivedAt | Datetime | False | No | Timestamp of folder deletion. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | ID of Marketing Form. | |
Name | String | False | No | The title of the Form. | |
FormType | String | False | No | Form Type. Possible values: blog_comment, captured, hubspot, flow. | |
FieldGroups | String | False | No | Field Groups aggregate. | |
Language | String | False | No | Language. | |
Cloneable | Bool | False | No | Cloneable. | |
Editable | Bool | False | No | Editable. | |
Archivable | Bool | False | No | Archivable. | |
RecaptchaEnabled | Bool | False | No | Recaptcha Enabled. | |
NotifyContactOwner | Bool | False | No | Notify Contact Owner. | |
NewContactNewEmail | Bool | False | No | Create new contact for new email. | |
PrePopulate | Bool | False | No | Prepopulate known values. | |
AllowLinkToReset | Bool | False | No | Allow link to reset known values. | |
RenderRawHtml | Bool | False | No | Render raw HTML. | |
Theme | String | False | No | Theme. | |
SubmitButtonText | String | False | No | Submit Button Text. | |
CssClass | String | False | No | CSS Class. | |
Style | String | False | No | Form Type. | |
CreatedAt | Datetime | False | No | When the meeting was created. | |
UpdatedAt | Datetime | False | No | When the meeting was last updated. | |
Archived | Bool | True | No | Determines whether the meeting is archived. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
MigrationSoftDeleteDeprecated | String | False | No | Describes if the goal target can be treated as deleted. | |
Ad account asset IDs | String | False | No | A list of ';'-separated universally unique IDs of ad accounts, each formatted: {AD_NETWORK}-{ACCOUNT_ID} | |
Ad campaign asset ids | String | False | No | A list of ';'-separated universally unique IDs of ad campaigns, each formatted: {NETWORK}-{CAMPAIGN_ID} | |
All teams | String | True | No | 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 | No | The business units this record is assigned to. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object, both default and custom. | |
Team ids | String | False | No | Which team owns the goal (there should only ever be one team) | |
Assignee team ID | Decimal | False | No | 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 | False | No | The user ID of the assigned user of the goal (unpopulated if the goal is not user-assigned) | |
Campaign asset ids | String | False | No | List of marketing campaign asset ids | |
Contact lifecycle stage | String | False | No | The lifecycle stage selected for the contact lifecycle goal | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Object create date/time | Datetime | True | No | The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified. | |
currency | String | False | No | DEPRECATED - DO NOT USE! Code for the currency conversion | |
Currency Exchange Rate | Decimal | False | No | 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 | False | No | A serialized list of DEAL pipeline IDs used to filter the KPI value calculation. | |
Edit updates notification frequency | String | False | No | The frequency of goal edit update notifications | |
End date | Date | False | No | The last day covered by the Goal Target's date range. | |
End datetime | Datetime | False | No | The last day covered by the Goal Target's date range. | |
Fiscal year offset | Decimal | False | No | 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 | False | No | The name of the goal. | |
Goal target currency code | String | False | No | Currency code for the goal target | |
Goal Target Group ID | Decimal | False | No | Object ID of the associated Goal Target Group | |
Goal type | String | False | No | The goal type | |
Group correlation UUID | String | False | No | Unique ID set on all Goal Targets and Goal Target Groups created by a single request | |
Is forecastable | String | False | No | 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 | False | No | Describes if the object was created during the migration process and it comes from the old app. | |
KPI Display Unit | String | False | No | Display units for goals based on duration properties | |
KpiFilterGroups | String | False | No | Filter groups for KPI calculations | |
KPI is team rollup | Bool | False | No | Indicates whether this is a rollup goal: whether the KPI allows contributions from child teams (in addition to the assigned team) | |
KpiMetricType | String | False | No | Type of metric used to aggregate the property name | |
KpiObjectType | String | False | No | The name of the CrmObject the KPI values are based on | |
Kpi object type id | String | False | No | The ObjectTypeId of the object the KPI values are based on | |
KpiPropertyName | String | False | No | Name of the property on the object type aggregated as the KPI value. | |
KpiSingleObjectCustomGoalTypeName | String | False | No | Single object custom goal components (metric type, object type, property name) | |
KpiTimePeriodProperty | String | False | No | Time period property | |
KpiTrackingMethod | String | False | No | Tracking method for progress directionality | |
Kpi unit type | String | False | No | Unit type of the kpi calculation | |
KPI value | Decimal | False | No | The latest KPI value for this goal target | |
KPI value calculated at | Decimal | False | No | The time that latest KPI value was calculated | |
KPI value last calculated at | Datetime | False | No | The time that latest KPI value was calculated | |
Object last modified date/time | Datetime | True | No | 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 | False | No | Migrated value describing if the goal is active or soft deleted. | |
LegacyCreatedAt | Decimal | False | No | Migrated value of created at. | |
LegacyCreatedBy | Decimal | False | No | Migrated value of created by. | |
LegacyQuarterlyTargetCompositeId | String | False | No | 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 | False | No | Id of the migrated goal target in the old system. This has been deprecated for legacy_unique_sql_id. | |
LegacyUniqueSqlId | Decimal | False | No | Id of the migrated goal target in the old system. This property has a unique value to ensure no duplicate migrated goals. | |
LegacyUpdatedAt | Decimal | False | No | Migrated value of updated at. | |
LegacyUpdatedBy | Decimal | False | No | Migrated value of updated by. | |
Merged record IDs | String | True | No | 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 | False | No | Describes if the goal target can be treated as deleted. | |
Milestone | String | False | No | The period during which a Goal Target is active | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Record Creation Source | String | True | No | Source (PropertySource) that created this object record | |
Record Creation Source ID | String | True | No | The sourceId -- further detail -- of the source that created this object record | |
Record Creation Source User ID | Decimal | True | No | User ID of the user who initiated creation of this object record | |
Outcome | String | False | No | Goal Target outcome | |
Owner ids of all owners | String | False | No | The owner IDs of all owners of this object | |
Participant type | String | False | No | The type of participant for the Goal Target | |
Pipeline ids | String | False | No | List of deal pipelines that the quota applies to. Used to calculate kpi values | |
Pipelines | String | False | No | A serialized list of pipeline IDs used to filter the KPI value calculation | |
Progress updates notification frequency | String | False | No | The frequency of goal progress update notifications | |
Read Only Object | Bool | True | No | Is the object read only | |
Notify on goal achieved | String | False | No | Opt into notifications when goal is achieved | |
Notify with goal edit updates | String | False | No | Opt into goal edit update notifications | |
Notify on goal exceeded | String | False | No | Opt into notifications when goal is exceeded | |
Notify on goal kickoff | String | False | No | Opt into notifications when a goal is kicked off | |
Notify on goal missed | String | False | No | Opt into notifications when a goal is missed | |
Notify with progress updates | String | False | No | Opt into goal progress updates notifications | |
ShouldRecalculate | String | False | No | Property used to flag Goal targets that need to be recalculated | |
Start datetime | Datetime | False | No | The first day that goal target's date range covers | |
Static KPI Filter Groups | String | False | No | Goal Target Filter Group(s) for all filters except time-based filters | |
Status | String | False | No | The status of the Goal Target | |
Status display order | Decimal | True | No | The goal status display order. | |
Target amount | Decimal | False | No | The target amount for this goal target | |
Target amount in company currency | Decimal | True | No | The amount of the goal target, using the exchange rate, in your company's currency | |
Team ID | Decimal | False | No | The team ID associated with the Goal Target | |
Ticket pipelines | String | False | No | A serialized list of TICKET pipeline IDs used to filter the KPI value calculation. | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | The user that last updated this object. This value is automatically set by HubSpot and may not be modified. | |
User ID | Decimal | False | No | The user ID associated with the Goal Target | |
User IDs of all notification followers | String | True | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Performed in an import | Bool | True | No | Object is part of an import | |
Owner Assigned Date | Datetime | True | No | 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 | No | The owner of the object. | |
HubSpot Team | String | True | No | The primary team of the owner. | |
Start date | Date | False | No | The first day that goal target's date range covers | |
Kpi progress percent | Decimal | True | No | Progress percent is represented by the kpi value as a percent of the target amount |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Leads.Id | No | Leads ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Leads object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object, which can be a contact, deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identified of the pipeline. | |
Label | String | False | No | The label (name) of the pipeline. | |
Archived | Bool | True | No | Whether the pipeline is archived or not. | |
CreatedAt | Datetime | True | No | When the pipeline was created. | |
UpdatedAt | Datetime | True | No | When the pipeline was last updated. | |
DisplayOrder | Int | False | No | The order of this specific pipeline in the collection of pipelines for this table. | |
StagesAggregate | String | False | No | An aggregate of the stages included in this pipeline. This information can be viewed in more detail in LeadPipelineStages table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier of the stage in the pipeline. | |
PipelineId [KEY] | String | False | LeadPipelines.Id | No | Unique identifier of the pipeline. |
Label | String | False | No | Label (name) of the pipeline stage. | |
PipelineLabel | String | False | LeadPipelines.Label | No | The label (name) of the pipeline. |
IsClosed | Bool | False | No | Whether this stage is open or closed. | |
State | String | False | No | Current state of the pipeline stage. | |
Archived | Bool | True | No | Whether the stage is archived or not. | |
CreatedAt | Datetime | True | No | Time the stage was created. | |
UpdatedAt | Datetime | True | No | Time the stage was last updated. | |
DisplayOrder | Int | False | No | The order of the stage in the collection of stages for this pipeline. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. | |
HasUniqueValue | Bool | False | No | Boolean indicating if the value of the property is unique. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
PropertyName | String | True | No | The name of the property. | |
Value | String | True | No | The historical value of the property. | |
SourceType | String | True | No | The method by which the property was changed. | |
SourceId | String | True | No | Additional data related to the source. May not be populated for all sources. | |
Timestamp | Datetime | True | No | Datetime when the property was updated. | |
LeadId | Long | True | No | The lead identifier. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | The name of the property group. | |
Label | String | False | No | The label of the group. | |
DisplayOrder | Int | False | No | The numerical order of the group with respect to other groups. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
All teams | String | True | No | 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 | No | The business units this record is assigned to. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object, both default and custom. | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object, both default and custom. | |
Associated Company Domain | String | True | No | Domain of the associated company if present. | |
Associated Company Name | String | True | No | Name of the associated company if present. | |
Associated Contact Email | String | True | No | Email of the associated contact if present. | |
Associated Contact First Name | String | True | No | First name of the associated contact if present. | |
Associated Contact Last Name | String | True | No | Last name of the associated contact if present. | |
Calls Connected Count | Decimal | True | No | The number of associated calls that are considered to be 'connected' | |
Primary company analytics source | String | True | No | The latest analytics source from the lead's primary company at the time when the company was associated with the lead. This property will not be updated after the first rollup. | |
Primary company analytics source first drilldown | String | True | No | The first drilldown of the latest analytics source from the lead's primary company at the time when the company was associated with the lead. This property will not be updated after the first rollup. | |
Primary company analytics source second drilldown | String | True | No | The second drilldown of the latest analytics source from the lead's primary company at the time when the company was associated with the lead. This property will not be updated after the first rollup. | |
Company Avatar FileManager key | String | True | No | The path in the FileManager CDN for the lead's primary company's avatar override image. | |
Is Target Account | String | True | No | Associated company's status about being marketed or sold to. | |
Company Last Activity Date | Datetime | True | No | The date of the last activity, rolled up from the primary associated company. | |
Company Last Engagement Date | Datetime | True | No | 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. | |
Company Last Engagement Type | String | True | No | The type of the last engagement a company performed. This doesn't include marketing emails or emails to multiple contacts. | |
Company Time of Last Session | Datetime | True | No | Time of the last session attributed to any contacts that are associated with this lead's primary company | |
Company Next Activity Date | Datetime | True | No | The date of the next activity, rolled up from the primary associated company. | |
Company Next Activity Type | String | True | No | The type of the next activity, rolled up from the primary associated company. | |
Company Number of Pageviews | Decimal | True | No | Total number of page views across all contacts associated with this lead's primary company | |
Associated company timezone | String | True | No | The associated company's timezone, if present. | |
Primary contact analytics source | String | True | No | The latest analytics source from the lead's primary contact at the time when the contact was associated with the lead. This property will not be updated after the first rollup. | |
Primary contact analytics source first drilldown | String | True | No | The first drilldown of the latest analytics source from the lead's primary contact at the time when the contact was associated with the lead. This property will not be updated after the first rollup. | |
Primary contact analytics source second drilldown | String | True | No | The second drilldown of the latest analytics source from the lead's primary contact at the time when the contact was associated with the lead. This property will not be updated after the first rollup. | |
Contact Avatar FileManager key | String | True | No | The path in the FileManager CDN for the lead's primary contact's avatar override image. | |
Contact Buying Role | String | True | No | Associated contact's role during the sales process. | |
Associated contact job title | String | True | No | Job title of the associated contact if present. | |
Contact Last Activity Date | Datetime | True | No | The date of the last activity, rolled up from the primary associated contact. | |
Contact Last Engagement Date | Datetime | True | No | 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. | |
Contact Last Engagement Type | String | True | No | The type of the last engagement a contact performed. This doesn't include marketing emails or emails to multiple contacts. | |
Contact Time of Last Session | Datetime | True | No | Timestamp for start of the most recent session for this lead's primary contact to your website. | |
Contact Next Activity Date | Datetime | True | No | The date of the next activity, rolled up from the primary associated contact. | |
Contact Next Activity Type | String | True | No | The type of the next activity, rolled up from the primary associated contact. | |
Contact Number of Pageviews | Decimal | True | No | Total number of page views this lead's primary contact has had on your website | |
Associated contact timezone | String | True | No | The associated contact's timezone, if present. | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Object create date/time | Datetime | True | No | The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified. | |
Emails Connected Count | Decimal | True | No | The number of associated emails that are considered to be 'connected' | |
Initial Assign Notification State | String | True | No | Determines the status of sending the initial lead assign notification upon object creation | |
Last Activity Date | Datetime | True | No | The date of the last activity. Defaults to the date of the primary associated contact. If not present, looks to the date of the primary associated company. | |
Last Engagement Date | Datetime | True | No | If primary contact exists, the last time the 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. Otherwise it is the last time for the associated company | |
Last Engagement Type | String | True | No | If primary contact exists, the type of the last engagement the contact performed. This doesn't include marketing emails or emails to multiple contacts. Otherwise it is the type of the last engagement for the associated company | |
Lead Time of Last Session | Datetime | True | No | If the associated contact exists, the timestamp for the start of the most recent session for this contact to your website. Otherwise the timestamp for the start of the most recent session for the associated company to your website. | |
Object last modified date/time | Datetime | True | No | 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. | |
Associated Deal Pipeline Stage | String | True | No | The pipeline stage of the primary associated deal | |
Associated deals | Decimal | True | No | Number of associated deals for a given lead. | |
Call Count | Decimal | True | No | The number of calls made to this lead | |
Closed won deal amount | Decimal | True | No | The total amount of the lead's associated deals that are closed-won | |
Message Thread Count | Decimal | True | No | The number of message threads (SMS, LinkedIn, WhatsApp) opened with this lead | |
Currency | String | True | No | Currency code for most recent associated deal | |
Lead Disqualification Note | String | False | No | A note on why the lead was disqualified | |
Disqualification Reason | String | False | No | Dropdown list of reasons for disqualification | |
Email Count | Decimal | True | No | The number of emails sent to this lead | |
First Outreach Date | Datetime | True | No | The date of the first outreach (call, email, meeting or other communication) from the sales rep to the lead. | |
Lead Inferred Pseudostage | String | True | No | This indicates the inferred lead pipeline pseudostage based on underlying activities taken by the user or lead. | |
Is Disqualified | Decimal | True | No | Indicates whether the lead is disqualified (with a value of 1) or not (with a value of 0). Hidden property that exists for the purpose of reporting. | |
In progress leads | Decimal | True | No | Indicates whether the lead is in progress (with a value of 1) or not (with a value of 0). Hidden property that exists for the purpose of reporting. | |
Is New | Decimal | True | No | Indicates whether the lead is new (with a value of 1) or not (with a value of 0). Hidden property that exists for the purpose of reporting. | |
Open leads | Decimal | True | No | Whether the lead's pipeline stage has any category other than QUALIFIED or UNQUALIFIED | |
Is Qualified | Decimal | True | No | Indicates whether the lead is qualified (with a value of 1) or not (with a value of 0). Hidden property that exists for the purpose of reporting. | |
Lead Label | String | False | No | Current status of a given lead | |
Meeting Count | Decimal | True | No | The number of meetings booked with this lead | |
Lead Name | String | False | No | The full name of the lead. | |
Lead name calculated | String | True | No | The calculated full name of the lead. | |
Outreach activity count | Decimal | True | No | The total number of outreach activities (call, email, meeting or other communication) from the sales rep to the lead. | |
Open deal amount | Decimal | True | No | The total value of any open deals associated with this lead | |
Primary Company Owner | String | True | No | The owner ID of the associated primary company | |
Primary Contact Owner | String | True | No | The owner ID of the associated primary contact | |
Lead Source | String | True | No | The analytics source of the lead, inherited from primary associated contact or company at the time of lead creation | |
Initial company lifecycle stage | String | True | No | The first detected lifecycle stage on a company associated with the lead as that lead's primary company. Not updated after initial value set. | |
Initial contact lifecycle stage | String | True | No | The first detected lifecycle stage on a contact associated with the lead as that lead's primary contact. Not updated after initial value set. | |
Lead Source DrillDown 1 | String | True | No | Second tier of specificity on the lead source | |
Lead Source DrillDown 2 | String | True | No | Third tier of specificity on the lead source | |
Initial source lifecycle stage | String | True | No | The lifecycle stage of the primary associated contact or company at the time of lead creation | |
Time to First Touch | Decimal | True | No | Time between lead creation and first outreach activity | |
Lead Title (DEPRECATEDUse hsLeadName) | String | True | No | The title of the lead | |
Lead Type | String | False | No | The type of lead. By default, categorize your lead as either a New Business, Existing Business, or Re-attempting | |
Meetings Connected Count | Decimal | True | No | The number of associated meetings that are considered to be 'connected' | |
Merged record IDs | String | True | No | The list of record IDs that have been merged into this record. This value is automatically set by HubSpot and may not be modified. | |
Next Activity Date | Datetime | True | No | The date of the next activity. Defaults to the date of the primary associated contact. If not present, looks to the date of the primary associated company. | |
Next Activity Type | String | True | No | The type of the next activity. Defaults to the type of the primary associated contact. If not present, looks to the type of the primary associated company. | |
Lead Number of Pageviews | Decimal | True | No | Number of pageviews for the associated contact if it exists. Otherwise the number of pageviews for the associated company. | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Record Creation Source | String | True | No | Raw internal propertySource present in the RequestMeta when this record was created | |
Record Source Detail 1 | String | True | No | First level of detail on how this record was created | |
Record Source Detail 2 | String | True | No | Second level of detail on how this record was created | |
Record Source Detail 3 | String | True | No | Third level of detail on how this record was created | |
Record Creation Source ID | String | True | No | Raw internal sourceId present in the RequestMeta when this record was created | |
Record Source | String | True | No | How this record was created | |
Record Creation Source User ID | Decimal | True | No | Raw internal userId present in the RequestMeta when this record was created | |
Lead owner calculated | String | True | No | The calculated owner of the lead. Owner of the primary contact if it exists, owner of primary company otherwise. | |
Lead Pipeline | String | False | No | The pipeline that the lead is in | |
Lead Pipeline Stage | String | False | No | ||
Pipeline Stage Category | String | True | No | The category assigned to the lead's current pipeline stage | |
Pipeline Stage Category Last Updated At | Datetime | True | No | Timestamp of the most recent update to the lead's pipeline stage category | |
Primary Associated Object Name | String | True | No | The primary associated contact or company name | |
Primary Associated Company Object ID | Decimal | False | No | The object ID of the primary associated company | |
Primary contact enrolled in sequence | Bool | True | No | Indicates whether the lead's primary contact is currently enrolled in a sequence | |
Primary Associated Contact Object ID | Decimal | False | No | The object ID of the primary associated contact | |
Read Only Object | Bool | True | No | Is the object read only | |
Shared Team IDs | String | True | No | The team IDs of all teams that have shared access to this object | |
Shared User IDs | String | True | No | The user IDs of all users that have shared access to this object | |
Lead tags | String | True | No | List of tag ids applicable to a lead. This property is set automatically by HubSpot. | |
Time in 'Attempting (Lead pipeline)' | Decimal | True | No | The total time in seconds spent by the lead in the 'Attempting' stage, 'Lead pipeline' pipeline | |
Time in 'Connected (Lead pipeline)' | Decimal | True | No | The total time in seconds spent by the lead in the 'Connected' stage, 'Lead pipeline' pipeline | |
Time in 'New (Lead pipeline)' | Decimal | True | No | The total time in seconds spent by the lead in the 'New' stage, 'Lead pipeline' pipeline | |
Time in 'Qualified (Lead pipeline)' | Decimal | True | No | The total time in seconds spent by the lead in the 'Qualified' stage, 'Lead pipeline' pipeline | |
Time in 'Disqualified (Lead pipeline)' | Decimal | True | No | The total time in seconds spent by the lead in the 'Disqualified' stage, 'Lead pipeline' pipeline | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Cumulative time in Attempting (Lead pipeline) | Decimal | True | No | The cumulative time in seconds spent by the lead in the 'Attempting' stage, 'Lead pipeline' pipeline | |
Cumulative time in Connected (Lead pipeline) | Decimal | True | No | The cumulative time in seconds spent by the lead in the 'Connected' stage, 'Lead pipeline' pipeline | |
Cumulative time in New (Lead pipeline) | Decimal | True | No | The cumulative time in seconds spent by the lead in the 'New' stage, 'Lead pipeline' pipeline | |
Cumulative time in Qualified (Lead pipeline) | Decimal | True | No | The cumulative time in seconds spent by the lead in the 'Qualified' stage, 'Lead pipeline' pipeline | |
Cumulative time in Disqualified (Lead pipeline) | Decimal | True | No | The cumulative time in seconds spent by the lead in the 'Disqualified' stage, 'Lead pipeline' pipeline | |
Date entered Attempting (Lead pipeline) | Datetime | True | No | The date and time when the lead entered the 'Attempting' stage, 'Lead pipeline' pipeline | |
Date entered Connected (Lead pipeline) | Datetime | True | No | The date and time when the lead entered the 'Connected' stage, 'Lead pipeline' pipeline | |
Date entered New (Lead pipeline) | Datetime | True | No | The date and time when the lead entered the 'New' stage, 'Lead pipeline' pipeline | |
Date entered Qualified (Lead pipeline) | Datetime | True | No | The date and time when the lead entered the 'Qualified' stage, 'Lead pipeline' pipeline | |
Date entered Disqualified (Lead pipeline) | Datetime | True | No | The date and time when the lead entered the 'Disqualified' stage, 'Lead pipeline' pipeline | |
Date exited Attempting (Lead pipeline) | Datetime | True | No | The date and time when the lead exited the 'Attempting' stage, 'Lead pipeline' pipeline | |
Date exited Connected (Lead pipeline) | Datetime | True | No | The date and time when the lead exited the 'Connected' stage, 'Lead pipeline' pipeline | |
Date exited New (Lead pipeline) | Datetime | True | No | The date and time when the lead exited the 'New' stage, 'Lead pipeline' pipeline | |
Date exited Qualified (Lead pipeline) | Datetime | True | No | The date and time when the lead exited the 'Qualified' stage, 'Lead pipeline' pipeline | |
Date exited Disqualified (Lead pipeline) | Datetime | True | No | The date and time when the lead exited the 'Disqualified' stage, 'Lead pipeline' pipeline | |
Latest time in Attempting (Lead pipeline) | Decimal | True | No | The total time in seconds spent by the lead in the 'Attempting' stage, 'Lead pipeline' pipeline since it last entered this stage | |
Latest time in Connected (Lead pipeline) | Decimal | True | No | The total time in seconds spent by the lead in the 'Connected' stage, 'Lead pipeline' pipeline since it last entered this stage | |
Latest time in New (Lead pipeline) | Decimal | True | No | The total time in seconds spent by the lead in the 'New' stage, 'Lead pipeline' pipeline since it last entered this stage | |
Latest time in Qualified (Lead pipeline) | Decimal | True | No | The total time in seconds spent by the lead in the 'Qualified' stage, 'Lead pipeline' pipeline since it last entered this stage | |
Latest time in Disqualified (Lead pipeline) | Decimal | True | No | The total time in seconds spent by the lead in the 'Disqualified' stage, 'Lead pipeline' pipeline since it last entered this stage | |
Performed in an import | Bool | True | No | Object is part of an import | |
Workflow updated lifecycle stage of company | Bool | False | No | Indicates whether a workflow updated the lifecycle stage of the lead's associated company. | |
Workflow updated lifecycle stage of contact | Bool | False | No | Indicates whether a workflow updated the lifecycle stage of the lead's associated contact. | |
Owner Assigned Date | Datetime | True | No | 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. | |
Lead Owner | String | False | No | Owner of the lead. Defaults to the owner of the primary associated contact. If not present, looks to the owner of the primary associated company. | |
HubSpot Team | String | True | No | The primary team of the owner. | |
lead custom field | String | False | No | This column is a custom field. desc |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Lineitems.Id | No | Lineitems ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Lineitems object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object* which can be a contact* deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Net price | Decimal | True | No | The amount of a line item | |
Create Date | Datetime | False | No | The date the line item was created | |
Description | String | False | No | Full description of product | |
Unit discount | Decimal | False | No | The discount amount applied | |
Annual contract value | Decimal | True | No | The annual contract value ACV of this product | |
All accessible team IDs | String | True | No | 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 | No | The business units this record is assigned to. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom. | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom. | |
Allow buyer selected quantity | String | True | No | Whether buyer selected quantity is to be enabled or not for a LineItem | |
Annual recurring revenue | Decimal | True | No | The annual recurring revenue ARR of this product | |
Delayed billing start by days | Decimal | False | No | 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 | No | Number of months billing should be delayed by. It allows the customers to start billing sometime in the future. | |
Start billing terms | String | True | No | 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 | No | The amount that sold goods cost the HubSpot customer | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Object create date_time | Datetime | True | No | 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 | No | The discount percentage applied | |
External LineItem id | Decimal | True | No | The ID of a line item | |
Image URL | String | False | No | Product images. | |
Last Modified Date | Datetime | True | No | The date any property on this product was modified | |
Currency | String | False | No | Currency code for the line item. | |
Margin | Decimal | True | No | The margin value of this product | |
Annual contract value margin | Decimal | True | No | The margin annual contract value of this product | |
Annual recurring revenue margin | Decimal | True | No | The margin annual recurring revenue of this product | |
Monthly recurring revenue margin | Decimal | True | No | The margin monthly recurring revenue of this product | |
Total contract value margin | Decimal | True | No | The margin total contract value of this product | |
Merged object IDs | String | True | No | 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 | No | The monthly recurring revenue MRR of this product | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Position on quote | Decimal | False | No | The order which the line item appears on the quotes | |
Pre Discount Amount | Decimal | True | No | The pre_discount amount of a line item | |
Product ID | Decimal | False | No | ID of the product this was copied from | |
Read Only Object | Bool | True | No | Is the object read only | |
End Date | Date | True | No | Recurring billing end date for a line item | |
Number of payments | Decimal | True | No | Number of payments for the given period on a Line Item | |
Term | String | False | No | Product recurring billing duration | |
Billing start date | Date | False | No | Recurring billing start date for a line item | |
Billing terms | String | True | No | If there are fixed number payments or it goes on until cancelled | |
SKU | String | False | No | Unique product identifier | |
Sync amount | Decimal | True | No | The amount set by Ecommerce sync | |
Total contract value | Decimal | True | No | The total contract value TCV of this product | |
Term in months | Decimal | True | No | The number of months in the term of this product | |
Calculated Total Discount | Decimal | True | No | Calculated total Discount for the line item taking in consideration the flat amount and discount percentage. | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | The user that last updated this object. This value is automatically set by HubSpot and may not be modified. | |
URL | String | False | No | Product url. | |
User IDs of all notification followers | String | True | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Variant id of the product | Decimal | True | No | Varient id of the shopify product | |
Owner Assigned Date | Datetime | True | No | 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 | No | The owner of the object. | |
HubSpot Team | String | True | No | The primary team of the owner. | |
Name | String | False | No | Product name | |
Unit price | Decimal | False | No | Cost of product | |
Quantity | Decimal | False | No | How many units of a product are in this line item | |
Billing frequency | String | False | No | 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 | No | The tax amount applied |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Meetings ID | |
AssociationId [KEY] | Long | False | No | ID of the object that this Meetings object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object, which can be a contact, deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | False | No | Notes ID | |
AssociationId [KEY] | Long | False | No | ID of the object that this Notes object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object, which can be a contact, deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Orders.Id | No | Orders ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Orders object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object* which can be a contact* Order etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identified of the pipeline. | |
Label | String | False | No | The label (name) of the pipeline. | |
Archived | Bool | True | No | Whether the pipeline is archived or not. | |
CreatedAt | Datetime | True | No | When the pipeline was created. | |
UpdatedAt | Datetime | True | No | When the pipeline was last updated. | |
DisplayOrder | Int | False | No | The order of this specific pipeline in the collection of pipelines for this table. | |
StagesAggregate | String | False | No | An aggregate of the stages included in this pipeline. This information can be viewed in more detail in OrderPipelineStages table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier of the stage in the pipeline. | |
PipelineId [KEY] | String | False | OrderPipelines.Id | No | Unique identifier of the pipeline. |
Label | String | False | No | Label (name) of the pipeline stage. | |
PipelineLabel | String | True | OrderPipelines.Label | No | The label (name) of the pipeline. |
IsClosed | Bool | False | No | Whether this stage is open or closed. | |
State | String | False | No | Current state of the pipeline stage. | |
Archived | Bool | True | No | Whether the stage is archived or not. | |
CreatedAt | Datetime | True | No | Time the stage was created. | |
UpdatedAt | Datetime | True | No | Time the stage was last updated. | |
DisplayOrder | Int | False | No | The order of the stage in the collection of stages for this pipeline. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. | |
HasUniqueValue | Bool | False | No | Boolean indicating if the value of the property is unique. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
PropertyName | String | True | No | The name of the property. | |
Value | String | True | No | The historical value of the property. | |
SourceType | String | True | No | The method by which the property was changed. | |
SourceId | String | True | No | Additional data related to the source. May not be populated for all sources. | |
Timestamp | Datetime | True | No | Datetime when the property was updated. | |
OrderId | Long | True | No | The order identifier. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | The name of the property group. | |
Label | String | False | No | The label of the group. | |
DisplayOrder | Int | False | No | The numerical order of the group with respect to other groups. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
All teams | String | True | No | 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 | No | The business units this record is assigned to. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object, both default and custom. | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object, both default and custom. | |
Billing City | String | False | No | The city for the billing address. | |
Billing Country | String | False | No | The country for the billing address. | |
Billing Email | String | False | No | Customer's email from billing information | |
Billing First Name | String | False | No | Customer's first name from billing information | |
Billing Last Name | String | False | No | Customer's last name from billing information | |
Billing Phone Number | String | False | No | The phone number for the billing address. | |
Billing ZIP/Postal Code | String | False | No | The ZIP/postal code for the billing address. | |
Billing State | String | False | No | The state for the billing address. | |
Billing Street | String | False | No | The street for the billing address. | |
Buyer Accepts Marketing | Bool | False | No | Indicates if the customer has opted in/out of receiving marketing emails. | |
Cancellation Reason | String | False | No | The reason given for cancelling the order. | |
Closed Date | Datetime | True | No | Date when the order was closed, null otherwise, set automatically | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Object create date/time | Datetime | True | No | The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified. | |
Currency Code | String | False | No | The currency code used in the order. | |
Customer Phone | String | False | No | Phone number of Customer placing the Order | |
Date entered 'Stage 1 (Pipeline 1)' | Datetime | True | No | The date and time when the order entered the 'Stage 1' stage, 'Pipeline 1' pipeline | |
Date exited 'Stage 1 (Pipeline 1)' | Datetime | True | No | The date and time when the order exited the 'Stage 1' stage, 'Pipeline 1' pipeline | |
Discount Codes | String | False | No | Discount Codes on an order. | |
Exchange rate | Decimal | False | No | This is the exchange rate used to convert the cart amount into your company currency. | |
Canceled Date | Datetime | False | No | Date the order is canceled. | |
Cart ID | String | False | No | Unique identifier in an external system for the cart associated with the order. | |
Checkout ID | String | False | No | Unique identifier in an external system for the checkout associated with the order. | |
Created Date | Datetime | False | No | Date the order is created. | |
Modified Date | Datetime | False | No | Most recent order modified date. | |
Order ID | String | False | No | Unique identifier in an external system for the order. | |
Status | String | False | No | Current status of the order as recorded on the source system. | |
Order URL | String | False | No | An URL that links to an external site where the orders details can be viewed. | |
Fulfillment Status | String | False | No | Current fulfillment/shipping status of the order. | |
Amount in company currency | Decimal | False | No | The amount of the order, using the exchange rate, in your company's currency | |
Landing Site | String | False | No | The URL of the first page on the sellers site that the customer landed on prior to them placing the order. | |
Object last modified date/time | Datetime | True | No | Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically. | |
Merged record IDs | String | True | No | The list of record IDs that have been merged into this record. This value is automatically set by HubSpot and may not be modified. | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Record Creation Source | String | True | No | Raw internal propertySource present in the RequestMeta when this record was created | |
Record Source Detail 1 | String | True | No | First level of detail on how this record was created | |
Record Source Detail 2 | String | True | No | Second level of detail on how this record was created | |
Record Source Detail 3 | String | True | No | Third level of detail on how this record was created | |
Record Creation Source ID | String | True | No | Raw internal sourceId present in the RequestMeta when this record was created | |
Record Source | String | True | No | How this record was created | |
Record Creation Source User ID | Decimal | True | No | Raw internal userId present in the RequestMeta when this record was created | |
Discount | Decimal | False | No | Total Discount on an order as an amount. | |
Name | String | False | No | Unique ID as represented by a number. | |
Notes | String | False | No | A block of text associated with the order. | |
Payment Processing Method | String | False | No | Type of payment processing method. | |
Payment Status | String | False | No | Current Payment status of the order. | |
Pinned engagement ID | Decimal | False | No | The object ID of the current pinned engagement. This will only be shown if there is already an association to the engagement. | |
Pipeline | String | False | No | The pipeline that contains this order | |
Stage | String | False | No | The order pipeline stage. | |
Processed Date | Datetime | False | No | The date/time the order was imported into HubSpot. | |
Read Only Object | Bool | True | No | Is the object read only | |
Referring Site | String | False | No | The URL of the site that the customer came from to arrive at the sellers site prior to placing their order. | |
Refund Amount | Decimal | False | No | Refunded amount, if any, associated with an order. | |
Shared Team IDs | String | True | No | The team IDs of all teams that have shared access to this object | |
Shared User IDs | String | True | No | The user IDs of all users that have shared access to this object | |
Shipping City | String | False | No | The city for the shipping address. | |
Shipping Country | String | False | No | The country for the shipping address. | |
Shipping Phone Number | String | False | No | The phone number for the shipping address. | |
Shipping ZIP/Postal Code | String | False | No | The ZIP/postal code for the shipping address. | |
Shipping State | String | False | No | The state for the shipping address. | |
Shipping Street | String | False | No | The street for the shipping address. | |
Shipping Cost | Decimal | False | No | The base cost (i.e. undiscounted), in the orders associated currency, associated with shipping the order. | |
Shipping Status URL | String | False | No | URL to Shipping status for the order. | |
Shipping Tracking Number | String | False | No | List of Shipment tracking IDs associated with the order. | |
Source ID | Decimal | True | No | HubSpot developer App ID from where this order data is first synced. | |
Source Store | String | False | No | Data used to identify which store the order came from. | |
Subtotal Price | Decimal | False | No | Total order amount before discounts, tax, duties etc. | |
Tags | String | False | No | A collection of tag strings associated with the order. | |
Tax Price | Decimal | False | No | Tax amount associated with the order, including duties. | |
Time in 'Stage 1 (Pipeline 1)' | Decimal | True | No | The total time in seconds spent by the order in the 'Stage 1' stage, 'Pipeline 1' pipeline | |
Total Price | Decimal | False | No | Sum Total amount associated with this order. | |
Total Weight | String | False | No | The total weight of the order for shipping purposes. | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Performed in an import | Bool | True | No | Object is part of an import | |
Owner Assigned Date | Datetime | True | No | 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 | No | The owner of the object. | |
HubSpot Team | String | True | No | The primary team of the owner. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | False | No | Owner ID | |
FirstName | String | False | No | First name of the owner. | |
LastName | String | False | No | Last name of the owner. | |
UserId | String | False | No | User id of the owner. | |
String | False | No | Email of the owner. | ||
Teams | String | False | No | Teams of the owner. | |
CreatedAt | Datetime | False | No | Created date time. | |
UpdatedAt | Datetime | False | No | Updated date time. | |
Archived | Bool | False | No | Weather or not is archived. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
WorkflowId | Long | True | Workflows.Id | No | The id of the Workflow. |
Series | String | True | No | Type of series for Workflow | |
Bucket | Date | True | No | Bucket of the Workflow | |
TimePeriod | String | True | No | The time period used to group the data. Must be one of DAY, WEEK, or MONTH | |
Frequency | Integer | True | No | Frequency of the Workflow | |
StartDate | Datetime | True | No | The start date for the data you want. | |
EndDate | Datetime | True | No | The end date for the data you want. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Properties | String | True | No | An aggregate of the properties defined for a given object type. | |
All teams | String | True | No | The team IDs, including the team hierarchy, of all default and custom owner properties for this record. | |
Business units | String | False | No | The business units this record is assigned to. | |
All owner IDs | String | True | No | Values of all default and custom owner properties for this record. | |
All team IDs | String | True | No | The team IDs of all default and custom owner properties for this record. | |
AtMentioned Owner Ids | String | False | No | The owners that have been at-mentioned on the engagement | |
Attached file IDs | String | False | No | The IDs of the files that are attached to the postal mail | |
Body preview | String | True | No | A truncated preview of the engagement body | |
HTML Body Preview | String | True | No | The HTML representation of the engagement body preview | |
Body Preview Truncated | Bool | True | No | Indicates if the engagement body was truncated for the preview | |
Activity created by | Decimal | True | No | The user who created the postal mail | |
Created by user ID | Decimal | True | No | The user who created this record. This value is set automatically by HubSpot. | |
Object create date/time | Datetime | True | No | The date and time at which this object was created. This value is automatically set by HubSpot and may not be modified. | |
Engagement Source | String | False | No | The source that created this engagement | |
Engagement Source ID | String | False | No | The specific ID of the process that created this engagement | |
GDPR deleted | Bool | True | No | Indicates the body of this engagement has been cleared because of a GDPR delete request | |
Object last modified date/time | Datetime | True | No | Most recent timestamp of any property update for this object. This includes HubSpot internal properties, which can be visible or hidden. This property is updated automatically. | |
Merged record IDs | String | True | No | The list of record IDs that have been merged into this record. This value is set automatically by HubSpot. | |
Updated by | Decimal | True | No | The user who last updated the postal mail | |
Record ID | Decimal | True | No | The unique ID for this record. This value is set automatically by HubSpot. | |
Record creation source | String | True | No | Raw internal PropertySource present in the RequestMeta when this record was created. | |
Record source detail 1 | String | True | No | First level of detail on how this record was created. | |
Record source detail 2 | String | True | No | Second level of detail on how this record was created. | |
Record source detail 3 | String | True | No | Third level of detail on how this record was created. | |
Record creation source ID | String | True | No | Raw internal sourceId present in the RequestMeta when this record was created. | |
Record source | String | True | No | How this record was created. | |
Record creation source user ID | Decimal | True | No | Raw internal userId present in the RequestMeta when this record was created. | |
Postal Mail Body | String | False | No | Body text of the postal mail | |
Postal Mail Type | String | False | No | Category of postal mail, as defined by the user | |
Queue Memberships | String | False | No | The list of queues that contain this engagement | |
Read only object | Bool | True | No | Determines whether a record can be edited by a user. | |
Shared teams | String | True | No | Additional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs. | |
Shared users | String | True | No | Additional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs. | |
Activity date | Datetime | False | No | The date that an engagement occurred | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Unique ID | String | False | No | The unique ID of the engagement | |
Updated by user ID | Decimal | True | No | The user who last updated this record. This value is set automatically by HubSpot. | |
User IDs of all notification followers | String | True | No | 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 | No | 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 | No | The user IDs of all owners of this record. | |
Performed in an import | Bool | True | No | Object is part of an import | |
Owner assigned date | Datetime | True | No | The most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot. | |
Owner | String | False | No | The owner of the object. | |
Owner's main team | String | True | No | The main team of the record owner. This value is set automatically by HubSpot. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Products.Id | No | Products ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Products object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object, which can be a contact, deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Net price | Decimal | True | No | Internal placeholder to prevent conflicts with line item property of same name | |
Create Date | Datetime | False | No | The date the product was created | |
Product description | String | False | No | Full description of product | |
Unit discount | Decimal | False | No | The discount amount applied | |
All accessible team IDs | String | True | No | 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 | No | The business units this record is assigned to. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom. | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom. | |
Avatar FileManager key | String | True | No | The path in the FileManager CDN for this product's image. Automatically set by HubSpot. | |
Unit cost | Decimal | False | No | The amount that sold goods cost the HubSpot customer | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Object create date_time | Datetime | True | No | 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 | No | The discount percentage applied | |
Folder Id | Decimal | False | No | The ID of the folder that has this product | |
Image Url | String | False | No | Product images. | |
Last Modified Date | Datetime | True | No | The date any property on this product was modified | |
Merged object IDs | String | True | No | 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 | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Product Type | String | False | No | The type of product. By default* categorize your product as either Inventory* Non_Inventory or Service. | |
Read Only Object | Bool | True | No | Is the object read only | |
Term | String | False | No | Product recurring billing duration | |
Start Date | Date | False | No | Recurring billing start date for a line item | |
SKU | String | False | No | Unique product identifier | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | The user that last updated this object. This value is automatically set by HubSpot and may not be modified. | |
URL | String | False | No | Product url. | |
User IDs of all notification followers | String | True | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner Assigned Date | Datetime | True | No | 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 | No | The owner of the object. | |
HubSpot Team | String | True | No | The primary team of the owner. | |
Name | String | False | No | Product name | |
Unit price | Decimal | False | No | Cost of product | |
Quantity | Decimal | True | No | Internal placeholder to prevent conflicts with line item property of same name | |
Recurring billing frequency | String | False | No | 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 | No | The tax amount applied |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Quotes.Id | No | Quotes ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Quotes object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object* which can be a contact* deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. | |
HasUniqueValue | Bool | False | No | Boolean indicating if the value of the property is unique. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
Business units | String | False | No | The business units this record is assigned to. | |
Allowed Payment Methods | String | False | No | Accepted forms of payment if quote is using HubSpot Payment | |
Quote Approver | String | False | No | ||
Collect Billing Address | Bool | False | No | Indicates if billing address should be collected with this quote | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
Create date | Datetime | True | No | The date the quote was created | |
Quote Domain | String | False | No | Domain this quote should be served from | |
ESign Date | Datetime | True | No | The date and time the document was signed by all signers | |
Expiration Template Path | String | False | No | Path of the expiration template for the quote | |
Quote approval feedback | String | False | No | Feedback about this quote during the approval process | |
Language | String | False | No | The language for displaying this quote publicly | |
Last modified date | Datetime | True | No | The last time any property on the quote was modified | |
Global Term Line Item Discount Percentage | String | False | No | For internal HubSpot Application use only. Global term for the discount percentage applied. | |
Global Term Line Item Discount Percentage Enabled | Bool | False | No | 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 | No | For internal HubSpot Application use only. Global term for product recurring billing duration. | |
Global Term Line Item Recurring Billing Period Enabled | Bool | False | No | 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 | No | 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 | No | 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 | No | 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 | No | For internal HubSpot Application use only. Indicates if the Global term for how frequently the product is billed is enabled | |
Locale | String | False | No | The locale for displaying this quote publicly | |
Locked | Bool | True | No | Indicates if this quote is locked and can never be updated | |
Merged object IDs | String | True | No | 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 | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Payment date | Datetime | True | No | The date the quote was paid by the customer | |
Payment Status | String | True | No | Payment status for the quote | |
Payment Type | String | False | No | Payment type for the quote if payment is enabled | |
Quote PDF download link | String | True | No | The link to download a pdf of a quote | |
Proposal Domain | String | True | No | Domain this proposal should be served from | |
Proposal Slug | String | True | No | Path to serve this proposal from | |
Proposal Template | String | False | No | Template Path this proposal is rendered with | |
Public URL key | String | True | No | Key for accessing quote document URL | |
Quote Total Preference | String | False | No | What LineItem property will be used to calculate the Quote Amount | |
Read Only Object | Bool | True | No | Is the object read only | |
Sender image URL | String | False | No | URL to image of the sender avatar image to be set on the quote | |
Quote Slug | String | False | No | Path to serve this quote from | |
Template Type | String | False | No | Whether this Quote is rendered with the default templates | |
Test mode | Bool | False | No | Indicates if the quote is in test mode | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner assigned date | Datetime | True | No | The date an owner was assigned to the quote | |
Sender company name | String | False | No | The name of the company sending this quote | |
Sender first name | String | False | No | First name of the sender of this quote | |
Quote title | String | False | No | The title of this quote | |
Expiration date | Datetime | False | No | The date that this quote expires | |
Sender company domain | String | False | No | The domain of the company sending this quote | |
Sender last name | String | False | No | Last name of the sender of this quote | |
Comments to buyer | String | False | No | Comments to the buyer | |
Sender company street address | String | False | No | The street address of the company sending this quote | |
Sender email | String | False | No | Email address of the sender of this quote | |
Sender company street address 2 | String | False | No | The second line of the street address of the company sending this quote | |
Sender phone number | String | False | No | Phone number of the sender of this quote | |
Terms | String | False | No | Any relevant information about pricing* purchasing terms* and_or master agreements | |
Logo URL | String | False | No | URL to image of the logo displayed on the quote | |
Sender company city | String | False | No | The city in which the company sending this quote is located | |
Sender job title | String | False | No | Job title of the sender of this quote | |
Sender company state_region | String | False | No | The state_region in which the company sending this quote is located | |
Space for written signature | Bool | False | No | Indicates if the quote document should have a place for a written signature | |
Branding color | String | False | No | Color value used on the quote document | |
Recent Sales Email Replied Date | Datetime | True | No | The last time a tracked sales email was replied to for this quote | |
Sender company postal code | String | False | No | The zip code in which the company sending this quote is located | |
Space for written countersignature | Bool | False | No | Indicates if the quote document should have a place for a written countersignature | |
Quote owner | String | False | No | The owner of the quote | |
Last Contacted | Datetime | True | No | The last timestamp when a call_ email or meeting was logged for this quote | |
Last Activity Date | Datetime | True | No | 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 | No | The date of the next upcoming activity for this quote | |
Number of times contacted | Decimal | True | No | The number of times a call_ email or meeting was logged for this quote | |
Number of Sales Activities | Decimal | True | No | Number of sales activities for this quote | |
Currency | String | False | No | Currency code for the quote | |
Sender company country | String | False | No | The country in which the company sending this quote is located | |
HubSpot team | String | True | No | The name of the team associated with the owner of the quote | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
Sender company image URL | String | False | No | URL to image of the sender company image to be set on the quote | |
Time zone | String | False | No | Timezone for displaying dates on the quote | |
All team ids | String | True | No | The team ids corresponding to all owner referencing properties for this object_ both default and custom | |
Payment enabled | Bool | False | No | Indicates if payment can be collected via the quote link | |
All accessible team ids | String | True | No | 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 | No | Indicates if esign is enabled for quote | |
Associated Deals | Decimal | True | No | The number of deals associated with this quote. This is set automatically by HubSpot. | |
ESign number of signers required | Decimal | True | No | Total number of signers required for this quote to be fully signed | |
Legacy Quote Template | String | False | No | The legacy quote template used to generate a quote. These templates will be sunset on Dec. 12th 2022. | |
ESign completed signatures | Decimal | True | No | Number of completed signatures collected so far | |
Quote amount | Decimal | True | No | The total due for the quote | |
Quote approval status | String | False | No | Approval status of the quote | |
Quote number | String | False | No | Reference number shown on quote document | |
Collect shipping address | Bool | False | No | Indicates if shipping address should be collected with this quote |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | False | No | The role's unique ID | |
Name | String | False | No | The role's name | |
RequiresBillingWrite | Boolean | False | No | Whether this role has a paid seat and requires the billing-write scope to assign/unassign to users |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Tasks ID | |
AssociationId [KEY] | Long | False | No | ID of the object that this Tasks object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object, which can be a contact, deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | False | No | The team's unique ID. | |
Name | String | False | No | The team's name. | |
UserIds | String | False | No | Comma-separated list of user IDs representing team members. | |
SecondaryUserIds | String | False | No | Comma-separated list of user IDs representing secondary team members. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | The unique Id of the message. | |
Type | String | False | No | The type of the message. | |
CreatedAt | Datetime | False | No | Time the message was created. | |
UpdatedAt | Datetime | False | No | Time the message was updated. | |
CreatedBy | String | False | No | The Id of an actor/participant which created the message. | |
ClientType | String | False | No | The type of the client. | |
IntegrationAppId | Integer | False | No | The Id of the client if the client is an integration. | |
SendersId | String | False | No | The Id of an actor/participant which sent the message. | |
SendersName | String | False | No | The Name of an actor/participant which sent the message. | |
SendersField | String | False | No | The sender's field. | |
SendersDeliveryIdentifierType | String | False | No | The delivery identifier type for sender. | |
SendersDeliveryIdentifierValue | String | False | No | The delivery identifier value for sender. | |
RecipientsId | String | False | No | The Id of an actor/participant which received the message. | |
RecipientsName | String | False | No | The Name of an actor/participant which received the message. | |
RecipientsField | String | False | No | The recipient's field. | |
RecipientsDeliveryIdentifierType | String | False | No | The delivery identifier type for recipient. | |
RecipientsDeliveryIdentifierValue | String | False | No | The delivery identifier value for recipient. | |
ChannelId | String | False | No | The Id of the channel. | |
ChannelAccountId | String | False | No | The Account Id of the channel. | |
Archived | Bool | False | No | The status of archived. | |
AssignedTo | String | False | No | To which it is assigned. | |
AssignedFrom | String | False | No | From whom it is assigned. | |
Text | String | False | No | The content of the message. | |
RichText | String | False | No | The content of the message in HTML format. | |
AttachmentsFileId | String | False | No | The Id of the attachment to the comment. | |
AttachmentsUrl | String | False | No | The URL of the attachment to the comment. | |
Subject | String | False | No | The subject of the message. | |
TruncationStatus | String | False | No | The truncation status of the message. | |
InReplyToId | String | False | No | The Id value being replied to. | |
StatusType | String | False | No | The status type. | |
Direction | String | False | No | The direction of the message. | |
NewStatus | String | False | No | The value of the new status. | |
ThreadId | String | False | Yes | Id of the thread that contains the messages. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique Id of the thread. | |
CreatedAt | Datetime | True | No | Time the thread was created. | |
ClosedAt | Datetime | True | No | Time the thread was closed. | |
Status | String | False | No | The thread's status: open or closed. | |
LatestMessageTimestamp | Datetime | True | No | The time that the latest message was sent or received on the thread. | |
LatestMessageSentTimestamp | Datetime | True | No | The time that the latest message was sent on the thread. | |
LatestMessageReceivedTimestamp | Datetime | True | No | The time that the latest message was received on the thread. | |
AssignedTo | String | True | No | The Id of an actor/participant in a conversation. | |
Spam | Bool | True | No | Whether the thread is marked as spam. | |
InboxId | String | True | No | The Id of the conversations' inbox containing the thread. | |
AssociatedContactId | String | True | No | The Id of teh assoicated Contact in the CRM. | |
Archived | Bool | False | No | Whether the thread is archived. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | Tickets.Id | No | Tickets ID |
AssociationId [KEY] | Long | False | No | ID of the object that this Tickets object is associated with. | |
Type [KEY] | String | False | No | Type of the associated object* which can be a contact* deal etc. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | The unique identified of the pipeline. | |
Label | String | False | No | The label name of the pipeline. | |
Archived | Bool | True | No | Whether the pipeline is archived or not. | |
CreatedAt | Datetime | True | No | When the pipeline was created. | |
UpdatedAt | Datetime | True | No | When the pipeline was last updated. | |
DisplayOrder | Int | False | No | The order of this specific pipeline in the collection of pipelines for this table. | |
StagesAggregate | String | False | No | An aggregate of the stages included in this pipeline. This information can be viewed in more detail in TicketPipelineStages table. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | True | No | Unique identifier of the stage in this pipeline. | |
PipelineId [KEY] | String | False | TicketPipelines.Id | No | Unique identifier of the pipeline. |
Label | String | False | No | Label name of the pipeline stage. | |
PipelineLabel | String | True | TicketPipelines.Label | No | The label name of the pipeline. |
IsClosed | Bool | False | No | Whether this stage is open or closed. | |
State | String | False | No | Current state of the pipeline stage. | |
Archived | Bool | True | No | Whether the stage is archived or not. | |
CreatedAt | Datetime | True | No | Time the stage was created. | |
UpdatedAt | Datetime | True | No | Time the stage was last updated. | |
DisplayOrder | Int | False | No | The order of the stage in the collection of stages for this pipeline. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | 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 | No | The human readable label for the property that will display in the HubSpot UI. | |
FieldType | String | False | No | The type of field that will display on the screen for the property. | |
Type | String | False | No | The stored machine type for the property. | |
GroupName | String | False | No | The group that the property is a part of. | |
Description | String | False | No | A description of what the property is for. | |
DisplayOrder | Int | False | No | The order in which the property should be displayed in relation to other properties in the same group. | |
ExternalOptions | Bool | False | No | Boolean indicating if there are external options associate with the company property. | |
IsFormField | Bool | False | No | Boolean indicating if the property is a field that is part of a form. | |
IsCalculated | Bool | False | No | Boolean indicating if the property is calculated. | |
IsHidden | Bool | False | No | Boolean indicating if the property is hidden. | |
IsHubspotDefined | Bool | False | No | Boolean indicating if the definition is defined from HubSpot. | |
Archivable | Bool | False | No | Boolean indicating if the definition is archivable. | |
ReadOnlyDefinition | Bool | False | No | Boolean indicating if the definition for the property is read only. | |
ReadOnlyValue | Bool | False | No | Boolean indicating if the value of the property is read only. | |
OptionsAggregate | String | False | No | An aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox. | |
HasUniqueValue | Bool | False | No | Boolean indicating if the value of the property is unique. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
PropertyName | String | True | No | The name of the property. | |
Value | String | True | No | The historical value of the property. | |
SourceType | String | True | No | The method by which the property was changed. | |
SourceId | String | True | No | Additional data related to the source. May not be populated for all sources. | |
Timestamp | Datetime | True | No | Datetime when the property was updated. | |
TicketId | Long | True | No | The ticket identifier. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Name [KEY] | String | False | No | The name of the property group. | |
Label | String | False | No | The label of the group. | |
DisplayOrder | Int | False | No | The numerical order of the group with respect to other groups. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier of the object. | |
Archived | Bool | True | No | Whether the object is archived or not. | |
CreatedAt | Datetime | True | No | When the object was created. | |
UpdatedAt | Datetime | True | No | When the object was last updated. | |
ItemURL | String | True | No | Url that points directly to the HubSpot item. | |
Close date | Datetime | False | No | The date the ticket was closed | |
Created by | Decimal | False | No | VID of contact that created the ticket | |
Create date | Datetime | False | No | The date the ticket was created | |
First agent email response date | Datetime | True | No | The date of the first email response from an agent after a ticket was created | |
Business units | String | False | No | The business units this record is assigned to. | |
Assignment Method | String | False | No | defines how the Object Assignment is done | |
AutoGenerated from thread id | Decimal | True | No | Thread that this ticket was automatically created for using ticket rules | |
Originating Conversations Message Id | String | False | No | Conversations Message Id of the message that originated this ticket | |
Conversations originating thread id | Decimal | False | No | Thread that this ticket was originally created for | |
Created by user ID | Decimal | True | No | The user that created this object. This value is automatically set by HubSpot and may not be modified. | |
HubSpot create date | Datetime | True | No | Internal read_only property representing the date the ticket was created in HubSpot | |
Custom inbox ID | Decimal | False | No | ID of the custom inbox the ticket is associated with | |
Date entered 'New Support Pipeline' | Datetime | True | No | The date and time when the ticket entered the 'New' stage_ 'Support Pipeline' pipeline | |
Date entered 'Waiting on contact Support Pipeline' | Datetime | True | No | 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 | No | The date and time when the ticket entered the 'Waiting on us' stage_ 'Support Pipeline' pipeline | |
Date entered 'Closed Support Pipeline' | Datetime | True | No | The date and time when the ticket entered the 'Closed' stage_ 'Support Pipeline' pipeline | |
Date exited 'New Support Pipeline' | Datetime | True | No | The date and time when the ticket exited the 'New' stage_ 'Support Pipeline' pipeline | |
Date exited 'Waiting on contact Support Pipeline' | Datetime | True | No | 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 | No | The date and time when the ticket exited the 'Waiting on us' stage_ 'Support Pipeline' pipeline | |
Date exited 'Closed Support Pipeline' | Datetime | True | No | The date and time when the ticket exited the 'Closed' stage_ 'Support Pipeline' pipeline | |
External object ids | String | False | No | Unique ids corresponding to tickets in a system outside of HubSpot | |
Last CES survey comment | String | True | No | Last CES survey comment that this contact gave for this ticket | |
Last CES survey rating | String | True | No | Last CES survey rating that this contact gave for this ticket | |
Last CES survey date | Datetime | True | No | The time that this contact last submitted a CES survey response. This is automatically set by HubSpot. | |
File upload | String | False | No | Files attached to a support form by a contact. | |
First agent response date | Datetime | True | No | The date of the first response from an agent out of all associated conversations | |
In Help Desk | Bool | False | No | Is this Ticket rendered in the Help Desk | |
Inbox ID | Decimal | True | No | Inbox the ticket is in | |
Last email activity | String | True | No | The type of the last email activity with the contact associated with the ticket. | |
Last email date | Datetime | True | No | The date of the last email activity with the contact associated with the ticket. | |
Last message received date | Datetime | True | No | The date of the last response from the visitor | |
Last response date | Datetime | True | No | The date of the last response from an agent or bot | |
Last activity date | Datetime | True | No | 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 | No | 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 | No | 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 | No | Agents who have seen the newest message across all conversations associated to the ticket | |
Merged ticket ids | String | True | No | All ticket ids for this ticket | |
Microsoft Teams message ID for this ticket. | String | True | No | Microsoft Teams message ID for this ticket. | |
Next activity date | Datetime | True | No | 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 | No | Number of companies associated with this ticket | |
Number of times contacted | Decimal | True | No | The number of times a call* email* or meeting was logged on the ticket | |
Record ID | Decimal | True | No | The unique ID for this record. This value is automatically set by HubSpot and may not be modified. | |
Originating channel account | String | True | No | First channel account used when conversation was started | |
Originating email engagement id | Decimal | True | No | Engagement id of the email originating this ticket | |
Originating channel type | String | True | No | The channel the conversation is in | |
Pinned Engagement ID | Decimal | True | No | The object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified. | |
Pipeline | String | False | No | The pipeline that contains this ticket | |
Ticket status | String | False | No | The pipeline stage that contains this ticket | |
Read Only Object | Bool | True | No | Is the object read only | |
Resolution | String | False | No | The action taken to resolve the ticket | |
Thread IDs To Restore | String | False | No | Thread IDs from cv_threads used to implement custom cascading delete_restore | |
Category | String | False | No | Main reason customer reached out for help | |
Ticket ID | Decimal | True | No | The unique id for this ticket. This unique id is automatically populated by HubSpot. | |
Priority | String | False | No | The level of attention needed on the ticket | |
Time in 'New Support Pipeline' | Decimal | True | No | 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 | No | 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 | No | 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 | No | The total time in seconds spent by the ticket in the 'Closed' stage_ 'Support Pipeline' pipeline | |
Time to Close SLA Due Date | Datetime | True | No | When the ticket falls out of Time to Close SLA. | |
Time to Close SLA Ticket Status | String | True | No | Current Time to Close SLA status of ticket | |
Time to First Response SLA Due Date | Datetime | True | No | When the ticket falls out of the Time to First Response SLA | |
Time to First Response SLA Status | String | True | No | Current Time to First Response SLA status. | |
Unique creation key | String | True | No | Unique property used for idempotent creates | |
Updated by user ID | Decimal | True | No | 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 | No | 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 | No | 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 | No | The user IDs of all owners of this object | |
Owner assigned date | Datetime | True | No | The date an owner was assigned to the ticket | |
Date of last engagement | Datetime | True | No | The date of the last reply or note | |
Last customer reply date | Datetime | True | No | The date of the last customer response | |
NPS follow up | String | False | No | Answer to NPS follow up question | |
NPS follow up question | Decimal | False | No | Specific version of NPS follow up question that was asked | |
Conversation NPS score | String | False | No | NPS score received after ticket resolution | |
Reference to email thread | String | False | No | The id of an email thread with ticket conversation | |
Time to close | Decimal | True | No | The time between when the ticket was created and closed | |
Time to first agent email reply | Decimal | True | No | The time from the ticket create date to the first agent email reply | |
Ticket name | String | False | No | Short summary of ticket | |
Ticket description | String | False | No | Description of the ticket | |
Source | String | False | No | Channel where ticket was originally submitted | |
Reference to sourceSpecific object | String | False | No | The id of a connected source object | |
Tags | String | False | No | Tags associated with your tickets | |
Recent Sales Email Replied Date | Datetime | True | No | The last time a tracked sales email was replied to for this ticket | |
Ticket owner | String | False | No | 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 | No | The last timestamp when a call_ email or meeting was logged for this ticket | |
Last Activity Date Ticket Note | Datetime | True | No | 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 | No | The date of the next upcoming activity for this ticket | |
Number of times contacted Ticket Note | Decimal | True | No | The number of times a call_ email or meeting was logged for this ticket | |
Number of Sales Activities | Decimal | True | No | Number of sales activities for this ticket | |
HubSpot team | String | True | No | Primary team of the ticket owner. This property is set automatically by HubSpot. | |
All owner ids | String | True | No | The value of all owner referencing properties for this object_ both default and custom | |
All team ids | String | True | No | 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 | No | The team IDs* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | False | No | The user's unique ID. | |
FirstName | String | False | No | The user's firstname. | |
LastName | String | False | No | The user's lastname. | |
String | False | No | The user's email. | ||
RoleId | Long | False | Roles.Id | No | The user's role. |
PrimaryTeamId | Long | False | Teams.Id | No | The user's primary team. |
SecondaryTeamIds | String | False | No | Comma-separated list of user IDs representing secondary team members. | |
IsSuperAdmin | Boolean | False | No | Boolean indicating if the user is a super admin. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | String | False | No | Id of the event. | |
ObjectId | String | False | No | Id of the object. | |
ObjectType | String | False | No | Type of the selected object. | |
EventType | String | False | No | Type of the event. | |
OccurredAt | Datetime | False | No | Time when the event occurred. | |
Properties | String | False | No | Additional properties. | |
ObjectProperty | String | False | Yes | 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 | False | Yes | The starting time as an ISO 8601 timestamp. | |
OccurredBefore | Datetime | False | Yes | The ending time as an ISO 8601 timestamp. | |
Sort | String | False | Yes | Selects the sort field and order. Defaults to ascending* prefix with * for descending order. 'occurredAt' is the only field supported for sorting. |
Name | Type | ReadOnly | References | FilterOnly | Description |
---|---|---|---|---|---|
Id [KEY] | Long | True | No | Unique identifier for the workflow. | |
Name | String | False | No | Name assigned to the workflow. | |
Description | String | False | No | Brief explanation of the workflow's purpose or function. | |
Enabled | Boolean | False | No | Indicates whether the workflow is currently active. | |
CreatedAt | Long | True | No | Timestamp showing when the workflow was initially created. | |
UpdatedAt | Long | True | No | Timestamp indicating the most recent time the workflow was updated. | |
PortalId | Integer | True | No | Identifier for the portal where the workflow was created. | |
Type | String | False | No | Specifies the category or type of the workflow. | |
ActiveContacts | Integer | True | No | Number of active contacts in the workflow. | |
EnrolledContacts | Integer | True | No | Number of contacts enrolled in the workflow. | |
ContactListIdsActive | Integer | True | No | ID of the active contact list associated with the workflow. | |
ContactListIdsCompleted | Integer | True | No | ID of the completed contact list associated with the workflow. | |
ContactListIdsEnrolled | Integer | True | No | ID of the enrolled contact list associated with the workflow. | |
ContactListIdsSucceeded | Integer | True | No | ID of the contact list that successfully completed the workflow. | |
CreationSource | String | True | No | Source or method used to create the workflow. | |
MigrationStatus | String | True | No | Status of any migration process related to the workflow. | |
UpdateSource | String | True | No | Source or method used for the most recent update to the workflow. | |
Actions | String | False | No | An array of actions associated with the workflow. |