HubSpot Connector Objects (hubspotv3 Schema)

NameDescription
AssociationsTypesRetrieve all available association types between a pair of CRM objects.
CallAssociationsRetrieve the IDs of all the objects associated to specific Calls objects in HubSpot.
CallPropertiesRetrieve the available Quote properties in HubSpot.
CommunicationPropertiesRetrieve the available Communications properties in HubSpot.
CommunicationsRetrieve the available Communications in HubSpot.
CompaniesRetrieve the available Companies in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
CompanyAssociationsRetrieve the IDs of all the objects associated to specific Companies objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
CompanyPipelinesPipelines of companies in HubSpot.
CompanyPipelineStagesPipeline stages of companies in HubSpot.
CompanyPropertiesRetrieve the available CompanyProperties in HubSpot.
CompanyPropertiesHistoryRetrieve the available Company properties history in HubSpot.
CompanyPropertyGroupsRetrieve the available Companypropertygroups in HubSpot.
ContactAssociationsRetrieve the IDs of all the objects associated to specific Contacts objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
ContactPipelinesPipelines of contacts in HubSpot.
ContactPipelineStagesPipeline stages of deals in HubSpot.
ContactPropertiesRetrieve the available ContactProperties in HubSpot.
ContactPropertiesHistoryRetrieve the available Contact properties history in HubSpot.
ContactPropertyGroupsRetrieve the available Contactpropertygroups in HubSpot.
ContactsRetrieve available contacts in HubSpot. This table supports both OAuth and PrivateAppToken authentication methods.
ContactsToDealsAssociationsRetrieve the IDs of all the Deals objects associated to specific Contacts objects in HubSpot. his table supports both OAuth and PrivateAppToken authentications.
CustomObjectAssociationsRetrieve and manage associations between Custom object types in HubSpot.
CustomObjectPropertiesRetrieve the available Custom Objects Properties in HubSpot.
CustomObjectsRetrieve the available Custom Objects in HubSpot.
DealAssociationsRetrieve the IDs of all the objects associated to specific Deals objects in HubSpot. his table supports both OAuth and PrivateAppToken authentications.
DealPipelinesPipelines of deals in HubSpot.
DealPipelineStagesPipeline stages of deals in HubSpot.
DealPropertiesRetrieve the available DealProperties in HubSpot.
DealPropertiesHistoryRetrieve the available Deal properties history in HubSpot.
DealPropertyGroupsRetrieve the available Dealpropertygroups in HubSpot.
DealsRetrieve the available Deals in HubSpot. his table supports both OAuth and PrivateAppToken authentications.
EmailAssociationsRetrieve the IDs of all the objects associated to specific Emails objects in HubSpot.
EmailPropertiesRetrieve the available Quote properties in HubSpot.
EngagementsCallsRetrieve the available Calls in HubSpot.
EngagementsEmailsRetrieve the available Emails in HubSpot.
EngagementsMeetingsRetrieve the available Meetings in HubSpot.
EngagementsNotesRetrieve the available Notes in HubSpot.
EngagementsTasksRetrieve the available Tasks in HubSpot.
FeedbackSubmissionAssociationsRetrieve the IDs of all the objects associated to specific Feedbacksubmissions objects in HubSpot.
FeedbackSubmissionPropertiesRetrieve the available Quote properties in HubSpot.
FeedbackSubmissionsRetrieve the available Feedbacksubmissions in HubSpot.
FilesSearch through files in the file manager. Does not display hidden or archived files. Requires files or files.ui_hidden.read as a scope.
FoldersSearch for folders. Does not contain hidden or archived folders. Requires files or files.ui_hidden.read as a scope.
FormsRetrieve HubSpot forms used to collect lead information about your visitors and contacts.
GoalPropertiesRetrieve the available Companyproperties in HubSpot.
GoalsRetrieve the available Goals in HubSpot.
LeadAssociationsRetrieve the IDs of all the objects associated to specific Leads objects in HubSpot.
LeadPipelinesPipelines of Leads in HubSpot.
LeadPipelineStagesPipeline stages of Leads in HubSpot.
LeadPropertiesRetrieve the available LeadProperties in HubSpot.
LeadPropertiesHistoryRetrieve the available Lead properties history in HubSpot.
LeadPropertyGroupsRetrieve the available Lead property groups in HubSpot.
LeadsRetrieve the available Leads in HubSpot.
LineitemAssociationsRetrieve the IDs of all the objects associated to specific Lineitems objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
LineItemPropertiesRetrieve the available Quote properties in HubSpot.
LineitemsRetrieve the available Lineitems in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
MeetingAssociationsRetrieve the IDs of all the objects associated to specific Meetings objects in HubSpot.
MeetingPropertiesRetrieve the available Quote properties in HubSpot.
NoteAssociationsRetrieve the IDs of all the objects associated to specific Notes objects in HubSpot.
NotePropertiesRetrieve the available Quote properties in HubSpot.
OrderAssociationsRetrieve the IDs of all the objects associated to specific Orders objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
OrderPipelinesPipelines of Orders in HubSpot.
OrderPipelineStagesPipeline stages of Orders in HubSpot.
OrderPropertiesRetrieve the available Order properties in HubSpot.
OrderPropertiesHistoryRetrieve the available Order properties history in HubSpot.
OrderPropertyGroupsRetrieve the available Order property groups in HubSpot.
OrdersRetrieve the available Orders in HubSpot.
OwnersHubSpot 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.
PerformanceWorkflowsGet a breakdown of the performance of a workflow based on the specified time period.
PostalEmailPropertiesRetrieve the available PostalEmails properties in HubSpot.
PostalEmailsRetrieve the available Postalemails in HubSpot.
ProductAssociationsRetrieve the IDs of all the objects associated to specific Products objects in HubSpot.
ProductPropertiesRetrieve the available Quote properties in HubSpot.
ProductsRetrieve the available Products in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
QuoteAssociationsRetrieve the IDs of all the objects associated to specific Quotes objects in HubSpot.
QuotePropertiesRetrieve the available QuoteProperties in HubSpot.
QuotesRetrieve the available Quotes in HubSpot.
RolesRetrieves details about an account's roles.
TaskPropertiesRetrieve the available Quote properties in HubSpot.
TasksAssociationsRetrieve the IDs of all the objects associated to specific Tasks objects in HubSpot.
TeamsReturns details about an account's teams.
ThreadMessagesRetrieve the entire message history in a Thread
ThreadsRetrieve the available Threads in a Conversation in HubSpot.
TicketAssociationsRetrieve the IDs of all the objects associated to specific Tickets objects in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
TicketPipelinesDiscover pipelines that a ticket goes through in HubSpot.
TicketPipelineStagesPipeline stages of tickets in HubSpot.
TicketPropertiesRetrieve the available TicketProperties in HubSpot.
TicketPropertiesHistoryRetrieve the available ticket properties history in HubSpot.
TicketPropertyGroupsRetrieve the available Ticketpropertygroups in HubSpot.
TicketsRetrieve the available Tickets in HubSpot. This table supports both OAuth and PrivateAppToken authentications.
UserProvisioningRetrieves details about users in the account, along with their permissions.
WebAnalyticsThe Web Analytics endpoint allows developers to find and filter events associated with a CRM object of any type.
WorkflowsSelect and manage HubSpot workflows.
NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe numeric ID for the association type.
TypeStringFalseNoThe name of the association type for the specified object pair.
FromObjectType [KEY]StringFalseNoThe first object's type to retrieve association types for.
ToObjectType [KEY]StringFalseNoThe second object's type to retrieve association types for.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoCalls ID
AssociationId [KEY]LongFalseNoID of the object that this Calls object is associated with.
Type [KEY]StringFalseNoType of the associated object, which can be a contact, deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
PropertiesStringTrueNoAn aggregate of the properties defined for a given object type.
All teamsStringTrueNoThe team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business unitsStringFalseNoThe business units this record is assigned to.
All owner IDsStringTrueNoValues of all default and custom owner properties for this record.
All team IDsStringTrueNoThe team IDs of all default and custom owner properties for this record.
AtMentioned Owner IdsStringFalseNoThe owners that have been at-mentioned on the engagement
Attached file IDsStringFalseNoThe IDs of the files that are attached to the communication
Body previewStringTrueNoA truncated preview of the engagement body
HTML Body PreviewStringTrueNoThe HTML representation of the engagement body preview
Body Preview TruncatedBoolTrueNoIndicates if the engagement body was truncated for the preview
Communication bodyStringFalseNoThe body of the communication
Channel TypeStringFalseNo
Conversation associations sync timestampDatetimeTrueNoTimestamp of the most recent time that associations were synced to this communication from the corresponding conversation object
Conversation object IDDecimalTrueNoThe ID of the conversation object for the thread that this communication belongs to
Conversations channel IDsStringTrueNoThe IDs of the Conversations channels used in this communication
Conversations channel account IDsStringTrueNoThe IDs of the Conversations channel accounts used in this communication
Conversations first message timestampDatetimeTrueNoTimestamp of the first Conversations message in the communication
Conversations thread IDDecimalTrueNoThe ID of the Conversations thread that this communication belongs to
Logged FromStringFalseNoWhere the communication was logged
Activity created byDecimalTrueNoThe user who created the communication
Created by user IDDecimalTrueNoThe user who created this record. This value is set automatically by HubSpot.
Object create date/timeDatetimeTrueNoThe date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Engagement SourceStringFalseNoThe source that created this engagement
Engagement Source IDStringFalseNoThe specific ID of the process that created this engagement
GDPR deletedBoolTrueNoIndicates the body of this engagement has been cleared because of a GDPR delete request
Object last modified date/timeDatetimeTrueNoMost 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 IDsStringTrueNoThe list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Updated byDecimalTrueNoThe user who last updated the communication
Record IDDecimalTrueNoThe unique ID for this record. This value is set automatically by HubSpot.
Record creation sourceStringTrueNoRaw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1StringTrueNoFirst level of detail on how this record was created.
Record source detail 2StringTrueNoSecond level of detail on how this record was created.
Record source detail 3StringTrueNoThird level of detail on how this record was created.
Record creation source IDStringTrueNoRaw internal sourceId present in the RequestMeta when this record was created.
Record sourceStringTrueNoHow this record was created.
Record creation source user IDDecimalTrueNoRaw internal userId present in the RequestMeta when this record was created.
Read only objectBoolTrueNoDetermines whether a record can be edited by a user.
Shared teamsStringTrueNoAdditional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared usersStringTrueNoAdditional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Activity dateDatetimeFalseNo
Unique creation keyStringTrueNoUnique property used for idempotent creates
Unique IDStringFalseNoThe unique ID of the communication
Updated by user IDDecimalTrueNoThe user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this record.
Performed in an importBoolTrueNoObject is part of an import
Owner assigned dateDatetimeTrueNoThe most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
Activity assigned toStringFalseNoThe 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 TeamStringTrueNoThe team of the owner of an engagement.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
ItemURLStringTrueNoUrl that points directly to the HubSpot item.
About UsStringFalseNoShort about_company
ClosedateTimestampEarliestValueA2a17e6eDatetimeTrueNoCalculation context property providing timestamp for rollup property closedate calculated as EARLIESTVALUE via values of closedate on object type ObjectTypeId_legacyObjectType_CONTACT
Facebook FansDecimalFalseNoNumber of facebook fans
FirstContactCreatedateTimestampEarliestValue78b50eeaDatetimeTrueNoCalculation 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 DateDatetimeTrueNoThe first conversion date across all contacts associated this company or organization
FirstConversionDateTimestampEarliestValue61f58f2cDatetimeTrueNoCalculation 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 ConversionStringTrueNoThe first form submitted across all contacts associated this company or organization
FirstConversionEventNameTimestampEarliestValue68ddae0aDatetimeTrueNoCalculation 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 DateDatetimeTrueNoDate the first deal was associated with this company record.
Year FoundedStringFalseNoThe year the company was created. Powered by HubSpot Insights.
Additional DomainsStringFalseNoAdditional domains belonging to this company
Business unitsStringFalseNoThe business units this record is assigned to.
Time First SeenDatetimeTrueNoThe first activity for any contact associated with this company or organization
HsAnalyticsFirstTimestampTimestampEarliestValue11e3a63aDatetimeTrueNoCalculation 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 CampaignStringTrueNoThe campaign responsible for the first touch creation of the first contact associated with this company
HsAnalyticsFirstTouchConvertingCampaignTimestampEarliestValue4757fe10DatetimeTrueNoCalculation 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 SessionDatetimeTrueNoTime of first session across all contacts associated with this company or organization
HsAnalyticsFirstVisitTimestampTimestampEarliestValueAccc17aeDatetimeTrueNoCalculation 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 SeenDatetimeTrueNoTime last seen across all contacts associated with this company or organization
HsAnalyticsLastTimestampTimestampLatestValue4e16365aDatetimeTrueNoCalculation 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 CampaignStringTrueNoThe campaign responsible for the last touch creation of the first contact associated with this company
HsAnalyticsLastTouchConvertingCampaignTimestampLatestValue81a64e30DatetimeTrueNoCalculation 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 SessionDatetimeTrueNoTime of the last session attributed to any contacts that are associated with this company record.
HsAnalyticsLastVisitTimestampTimestampLatestValue999a0fceDatetimeTrueNoCalculation 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 SourceStringTrueNoSource of the last session attributed to any contacts that are associated with this company
Latest Source Data 1StringTrueNoAdditional source details of the last session attributed to any contacts that are associated with this company
Latest Source Data 2StringTrueNoAdditional source details of the last session attributed to any contacts that are associated with this company
Latest Source TimestampDatetimeTrueNoTimestamp of when latest source occurred
Number of PageviewsDecimalTrueNoTotal number of page views across all contacts associated with this company or organization
HsAnalyticsNumPageViewsCardinalitySumE46e85b0DecimalTrueNoCalculation 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 SessionsDecimalTrueNoTotal number of sessions across all contacts associated with this company or organization
HsAnalyticsNumVisitsCardinalitySum53d952a6DecimalTrueNoCalculation 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 TypeStringFalseNoOriginal source for the contact with the earliest activity for this company or organization
Original Source Data 1StringTrueNoAdditional information about the original source for the contact with the earliest activity for this company or organization
HsAnalyticsSourceData1TimestampEarliestValue9b2f1fa1DatetimeTrueNoCalculation 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 2StringTrueNoAdditional information about the original source for the contact with the earliest activity for this company or organization
HsAnalyticsSourceData2TimestampEarliestValue9b2f9400DatetimeTrueNoCalculation 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
HsAnalyticsSourceTimestampEarliestValue25a3a52cDatetimeTrueNoCalculation 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 keyStringTrueNoThe path in the FileManager CDN for this company's avatar override image. Automatically set by HubSpot.
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date_timeDatetimeTrueNoThe 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'DatetimeTrueNoThe date and time when the company entered the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Evangelist Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company entered the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company entered the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Marketing Qualified Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company entered the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Opportunity Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company entered the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Other Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company entered the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Sales Qualified Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company entered the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Subscriber Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company entered the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Customer Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company exited the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Evangelist Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company exited the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company exited the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Marketing Qualified Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company exited the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Opportunity Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company exited the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Other Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company exited the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Sales Qualified Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company exited the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Subscriber Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the company exited the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Ideal Customer Profile TierStringFalseNoHow 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 AccountBoolFalseNoIdentifies whether this company is being marketed and sold to as part of your account_based strategy.
Last Booked Meeting DateDatetimeTrueNoThe last date of booked meetings associated with the company
Last Logged Call DateDatetimeTrueNoThe last date of logged calls associated with the company
Last Open Task DateDatetimeTrueNoThe last due date of open tasks associated with the company
last sales activity date oldDatetimeTrueNoThe date of the last sales activity with the company in seconds.
Last Engagement DateDatetimeTrueNoThe 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 TypeStringTrueNoThe type of the last engagement a company performed. This doesn't include marketing emails or emails to multiple contacts.
Last Modified DateDatetimeTrueNoMost 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 subscriptionsDatetimeTrueNoLatest created date of all associated active Subscriptions
Merged object IDsStringTrueNoThe 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 blockersDecimalTrueNoThe number of contacts associated with this company with the role of blocker.
Number of contacts with a buying roleDecimalTrueNoThe number of contacts associated with this company with a buying role.
Number of decision makersDecimalTrueNoThe number of contacts associated with this company with the role of decision maker.
Number of open dealsDecimalTrueNoThe number of open deals associated with this company.
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Pinned Engagement IDDecimalTrueNoThe object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified.
PipelineStringFalseNoThe pipeline with which this company is currently associated
Likelihood to closeDecimalTrueNoThe 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.
HsPredictivecontactscoreV2NextMaxMaxD4e58c1eDecimalTrueNoCalculation 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 ObjectBoolTrueNoIs the object read only
Target Account2StringFalseNoThe Target Account property is a means to flag high priority companies if you are following an account based strategy
Target Account ProbabilityDecimalTrueNoThe probability a company is marked as a target account
Target Account Recommendation Snooze TimeDatetimeFalseNoThe date when the target account recommendation is snoozed.
Target Account Recommendation StateStringFalseNoThe state of the target account recommendation
Time in 'Customer Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the company in the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Evangelist Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the company in the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Lead Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the company in the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Marketing Qualified Lead Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the company in the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Opportunity Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the company in the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Other Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the company in the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Sales Qualified Lead Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the company in the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Subscriber Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the company in the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Total open deal valueDecimalTrueNoThe total value* in your company's currency* of all open deals associated with this company
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner Assigned DateDatetimeTrueNoThe timestamp when an owner was assigned to this company
Is PublicBoolFalseNoIndicates if the company is publicly traded. Powered by HubSpot Insights.
Number of Associated ContactsDecimalTrueNoThe number of contacts associated with this company
Number of Associated DealsDecimalTrueNoThe number of deals associated with this company
Number of Form SubmissionsDecimalTrueNoThe number of forms submission for all contacts associated with this company or organization
NumConversionEventsCardinalitySumD095f14bDecimalTrueNoCalculation 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 DateDatetimeTrueNoThe most recent conversion date across all contacts associated this company or organization
RecentConversionDateTimestampLatestValue72856da1DatetimeTrueNoCalculation 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 ConversionStringTrueNoThe last form submitted across all contacts associated this company or organization
RecentConversionEventNameTimestampLatestValue66c820bfDatetimeTrueNoCalculation 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 AmountDecimalTrueNoThe amount of the last deal closed
Recent Deal Close DateDatetimeTrueNoDate of the last
Time ZoneStringFalseNoTime zone where the company or organization is located. Powered by HubSpot Insights.
Total Money RaisedStringFalseNoThe total amount of money raised by the company. Powered by HubSpot Insights.
Total RevenueDecimalTrueNoThe total amount of closed won deals
Company nameStringFalseNoThe name of the company or organization. Powered by HubSpot Insights.
HubSpot Owner EmailStringFalseNoHubSpot owner email for this company or organization
Twitter HandleStringFalseNoThe main twitter account of the company or organization
HubSpot Owner NameStringFalseNoHubSpot owner name for this company or organization
Phone NumberStringFalseNoCompany primary phone number. Powered by HubSpot Insights.
Twitter BioStringFalseNoThe Twitter bio of the company or organization
Twitter FollowersDecimalFalseNoThe number of Twitter followers of the company or organization
Street AddressStringFalseNoStreet address of the company or organization_ including unit number. Powered by HubSpot Insights.
Street Address 2StringFalseNoAdditional address of the company or organization. Powered by HubSpot Insights.
Facebook Company PageStringFalseNoThe URL of the Facebook company page for the company or organization
CityStringFalseNoCity where the company is located. Powered by HubSpot Insights.
LinkedIn Company PageStringFalseNoThe URL of the LinkedIn company page for the company or organization
LinkedIn BioStringFalseNoThe LinkedIn bio for the company or organization
State_RegionStringFalseNoState or region in which the company or organization is located. Powered by HubSpot Insights.
Google Plus PageStringFalseNoThe URL of the Google Plus page for the company or organization
Date of last meeting booked in meetings toolDatetimeTrueNoLast Meeting Booked for any contact associated with this Company_Organization.
Campaign of last booking in meetings toolStringTrueNoThis 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 toolStringTrueNoThis 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 toolStringTrueNoThis 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 activityDatetimeTrueNoThe 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 DateDatetimeTrueNoThe last time a tracked sales email was replied to by this company
Company ownerStringFalseNoThe owner of the company
Last ContactedDatetimeTrueNoTimestamp of the last call* email* or meeting that was logged for a contact at this company.
Last Activity DateDatetimeTrueNoThe 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 DateDatetimeTrueNoDate of the next upcoming scheduled sales activity for this company record.
Number of times contactedDecimalTrueNoThe number of times a call_ email or meeting was logged for this company
Number of Sales ActivitiesDecimalTrueNoNumber of sales activities for this company. For example* a call* email or meeting logged.
Postal CodeStringFalseNoPostal or zip code of the company or organization. Powered by HubSpot Insights.
Country_RegionStringFalseNoCountry in which the company or organization is located. Powered by HubSpot Insights.
HubSpot TeamStringTrueNoThe team of the owner of the company.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
Website URLStringFalseNoThe main website of the company or organization. This property is used to identify unique companies. Powered by HubSpot Insights.
Company Domain NameStringFalseNoThe domain name of the company or organization
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team idsStringTrueNoThe team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom
Number of EmployeesDecimalFalseNoThe total number of employees who work for the company or organization. Powered by HubSpot Insights.
IndustryStringFalseNoThe 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 RevenueDecimalFalseNoThe actual or estimated annual revenue of the company. Powered by HubSpot Insights.
Lifecycle StageStringFalseNoThe most advanced lifecycle stage across all contacts associated with this company or organization
Lead StatusStringFalseNoThe company's sales_ prospecting or outreach status
Parent CompanyDecimalTrueNoThe parent company of this company
TypeStringFalseNoThe optional classification of this company record _ prospect_ partner_ etc.
DescriptionStringFalseNoA short statement about the company's mission and goals. Powered by HubSpot Insights.
Number of child companiesDecimalTrueNoThe number of child companies of this company
HubSpot ScoreDecimalTrueNoThe sales and marketing score for the company or organization
Create DateDatetimeTrueNoThe date the company or organization was added to the database
Close DateDatetimeFalseNoThe date the company or organization was closed as a customer
First Contact Create DateDatetimeTrueNoThe date that the first contact from this company entered the system_ which could pre_date the company's create date
Days to CloseDecimalTrueNoThe number of days between when the company record was created and when they closed as a customer.
Web TechnologiesStringFalseNoThe web technologies used by the company or organization. Powered by HubSpot Insights.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueCompanies.IdNoCompanies ID
AssociationId [KEY]LongFalseNoID of the object that this Companies object is associated with.
Type [KEY]StringFalseNoType of the associated object* which can be a contact* deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identified of the pipeline.
LabelStringFalseNoThe label name of the pipeline.
ArchivedBoolTrueNoWhether the pipeline is archived or not.
CreatedAtDatetimeTrueNoWhen the pipeline was created.
UpdatedAtDatetimeTrueNoWhen the pipeline was last updated.
DisplayOrderIntFalseNoThe order of this specific pipeline in the collection of pipelines for this table.
StagesAggregateStringFalseNoAn aggregate of the stages included in this pipeline. This information can be viewed in more detail in CompanyPipelineStages table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoUnique identifier of the stage in the pipeline.
PipelineId [KEY]StringFalseCompanyPipelines.IdNoUnique identifier of the pipeline.
LabelStringFalseNoLabel name of the pipeline stage.
PipelineLabelStringTrueCompanyPipelines.LabelNoThe label name of the pipeline.
IsClosedBoolFalseNoWhether this stage is open or closed.
ProbabilityDecimalFalseNoCurrent state of the pipeline stage.
ArchivedBoolTrueNoWhether the stage is archived or not.
CreatedAtDatetimeTrueNoTime the stage was created.
UpdatedAtDatetimeTrueNoTime the stage was last updated.
DisplayOrderIntFalseNoThe order of the stage in the collection of stages for this pipeline.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
HasUniqueValueBoolFalseNoBoolean indicating if the value of the property is unique.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PropertyNameStringTrueNoThe name of the property.
ValueStringTrueNoThe historical value of the property.
SourceTypeStringTrueNoThe method by which the property was changed.
SourceIdStringTrueNoAdditional data related to the source. May not be populated for all sources.
TimestampDatetimeTrueNoDatetime when the property was updated.
CompanyIdLongTrueNoThe company identifier.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property group.
LabelStringFalseNoThe label of the group.
DisplayOrderIntFalseNoThe numerical order of the group with respect to other groups.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueContacts.IdNoContacts ID
AssociationId [KEY]LongFalseNoID of the object that this Contacts object is associated with.
Type [KEY]StringFalseNoType of the associated object* which can be a contact* deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identified of the pipeline.
LabelStringFalseNoThe label name of the pipeline.
ArchivedBoolTrueNoWhether the pipeline is archived or not.
CreatedAtDatetimeTrueNoWhen the pipeline was created.
UpdatedAtDatetimeTrueNoWhen the pipeline was last updated.
DisplayOrderIntFalseNoThe order of this specific pipeline in the collection of pipelines for this table.
StagesAggregateStringFalseNoAn aggregate of the stages included in this pipeline. This information can be viewed in more detail in ContactPipelineStages table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoUnique identifier of the stage in the pipeline.
PipelineId [KEY]StringFalseContactPipelines.IdNoUnique identifier of the pipeline.
LabelStringFalseNoLabel name of the pipeline stage.
PipelineLabelStringTrueContactPipelines.LabelNoThe label name of the pipeline.
IsClosedBoolFalseNoWhether this stage is open or closed.
ProbabilityDecimalFalseNoCurrent state of the pipeline stage.
ArchivedBoolTrueNoWhether the stage is archived or not.
CreatedAtDatetimeTrueNoTime the stage was created.
UpdatedAtDatetimeTrueNoTime the stage was last updated.
DisplayOrderIntFalseNoThe order of the stage in the collection of stages for this pipeline.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
HasUniqueValueBoolFalseNoBoolean indicating if the value of the property is unique.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PropertyNameStringTrueNoThe name of the property.
ValueStringTrueNoThe historical value of the property.
SourceTypeStringTrueNoThe method by which the property was changed.
SourceIdStringTrueNoAdditional data related to the source. May not be populated for all sources.
TimestampDatetimeTrueNoDatetime when the property was updated.
ContactIdLongTrueNoThe contact identifier.
ContactEmailStringTrueNoThe contact's email address.
ContactPhoneNumberStringTrueNoThe contact's primary phone number.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property group.
LabelStringFalseNoThe label of the group.
DisplayOrderIntFalseNoThe numerical order of the group with respect to other groups.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
ItemURLStringTrueNoUrl that points directly to the HubSpot item.
Company sizeStringFalseNoContact's company size. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Date of birthStringFalseNoContact's date of birth. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Days To CloseDecimalTrueNoCount of days elapsed between creation and being closed as a customer. Set automatically.
DegreeStringFalseNoContact's degree. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Field of studyStringFalseNoContact's field of study. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
First Conversion DateDatetimeTrueNoDate this contact first submitted a form.
First ConversionStringTrueNoFirst form this contact submitted.
First Deal Created DateDatetimeTrueNoDate first deal was created for contact. Set automatically.
GenderStringFalseNoContact's gender. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Graduation dateStringFalseNoContact's graduation date. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Additional email addressesStringTrueNoA set of additional email addresses for a contact
Business unitsStringFalseNoThe business units this record is assigned to.
All vids for a contactStringTrueNoA set of all vids* canonical or otherwise* for a contact
First Touch Converting CampaignStringTrueNoCampaign responsible for the first touch creation of this contact.
Last Touch Converting CampaignStringTrueNoCampaign responsible for the last touch creation of this contact.
Avatar FileManager keyStringTrueNoThe path in the FileManager CDN for this contact's avatar override image. Automatically set by HubSpot.
Buying RoleStringFalseNoRole the contact plays during the sales process. Contacts can have multiple roles_ and can share roles with others.
All form submissions for a contactStringTrueNoA set of all form submissions for a contact
Merged vids with timestamps of a contactStringTrueNoMerged vids with timestamps of a contact
Calculated Mobile Number in International FormatStringTrueNoMobile number in international format
Calculated Phone Number in International FormatStringTrueNoPhone number in international format
Calculated Phone Number Area CodeStringTrueNoArea Code of the calculated phone number
Calculated Phone Number Country CodeStringTrueNoCountry code of the calculated phone number
Calculated Phone Number RegionStringTrueNoISO2 Country code for the derived phone number
Clicked on a LinkedIn AdStringFalseNoWhether contact has clicked on a LinkedIn Ad
Email ConfirmedBoolTrueNoEmail Confirmation status of user of Content Membership
Registration Follow Up Email Enqueued AtDatetimeFalseNoThe time when the first registration follow up email was enqueued
Membership NotesStringFalseNoNotes relating to the contact's content membership.
Registered AtDatetimeTrueNoDatetime at which this user was set up for Content Membership
Domain to which registration email was sentStringTrueNoDomain to which the registration invitation email for Content Membership was sent to
Time registration email was sentDatetimeTrueNoDatetime at which this user was sent a registration invitation email for Content Membership
StatusStringFalseNoStatus of the contact's content membership.
Conversations visitor emailStringTrueNoA Conversations visitor's email address
Count of unengaged contactsDecimalTrueNoif contact is assigned and unworked* set to 1. if contact is assigned and worked* set to 0.
Count of engaged contactsDecimalTrueNoif contact is assigned and worked* set to 1. if contact is assigned and unworked* set to 0.
Created By ConversationsBoolTrueNoFlag indicating this contact was created by the Conversations API
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date_timeDatetimeTrueNoThe 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'DatetimeTrueNoThe date and time when the contact entered the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Evangelist Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact entered the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact entered the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Marketing Qualified Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact entered the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Opportunity Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact entered the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Other Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact entered the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Sales Qualified Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact entered the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date entered 'Subscriber Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact entered the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Customer Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact exited the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Evangelist Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact exited the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact exited the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Marketing Qualified Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact exited the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Opportunity Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact exited the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Other Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact exited the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Sales Qualified Lead Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact exited the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Date exited 'Subscriber Lifecycle Stage Pipeline'DatetimeTrueNoThe date and time when the contact exited the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Recent Document Revisit DateDatetimeTrueNoThe last time a shared document presentation was accessed by this contact
Invalid email addressBoolTrueNoThe email address associated with this contact is invalid.
Email address quarantine reasonStringFalseNoThe reason why the email address has been quarantined.
Email DomainStringTrueNoA contact's email address domain
Email hard bounce reasonStringTrueNoThe 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 reason2StringTrueNoThe 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 QuarantinedBoolTrueNoIndicates 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 reasonStringTrueNoThe automated reason why the email address has been quarantined.
Email Address Recipient Fatigue Next Available Sending TimeDatetimeTrueNoWhen 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 EngagementDecimalTrueNoThe 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 statusStringTrueNoThe status of a contact's eligibility to receive marketing email. This is automatically set by HubSpot.
Clicked Facebook adBoolFalseNoWhether contact has clicked a Facebook ad
Facebook click idStringFalseNo
Facebook IDStringFalseNoA contact's facebook id
Last NPS survey commentStringTrueNoLast NPS survey comment that this contact gave
Last NPS survey ratingStringTrueNoLast NPS survey rating that this contact gave
Last NPS survey dateDatetimeTrueNoThe time that this contact last submitted a NPS survey response. This is automatically set by HubSpot.
Should be shown an NPS web surveyBoolFalseNoWhether or not a contact should be shown an NPS web survey. This is automatically set by HubSpot.
ID of first engagementDecimalTrueNoThe object id of the current contact owner's first engagement with the contact. Used in Sales Analytics app.
First subscription create dateDatetimeTrueNoThe create date of the first subscription by the contact.
Google ad click idStringFalseNo
googleplus IDStringFalseNoA contact's googleplus id
Contact has an active subscriptionDecimalTrueNoThe rollup property value is 1 when the contact has an active Subscription or 0 otherwise.
IP TimezoneStringTrueNoThe timezone reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
Is a contactBoolTrueNoIs a contact_ has not been deleted and is not a visitor
Contact unworkedBoolTrueNoContact has not been assigned or has not been engaged after last owner assignment_re_assignment
last sales activity date oldDatetimeTrueNoThe 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 DateDatetimeTrueNoThe 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 TypeStringTrueNoThe type of the last engagement a contact performed. This doesn't include marketing emails or emails to multiple contacts.
Object last modified date_timeDatetimeTrueNoMost 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 dateDatetimeTrueNoThe last sequence ended date.
Last sequence enrolledDecimalTrueNoThe last sequence enrolled.
Last sequence enrolled dateDatetimeTrueNoThe last sequence enrolled date.
Last sequence finished dateDatetimeTrueNoThe last sequence finished date.
Last sequence unenrolled dateDatetimeTrueNoThe last sequence unenrolled date.
Latest Source DateDateFalseNoThe time of the latest session for a contact
Latest subscription create dateDatetimeTrueNoThe create date of the latest subscription by the contact.
Lead StatusStringFalseNoThe contact's sales_ prospecting or outreach status
Legal basis for processing contact's dataStringFalseNoLegal basis for processing contact's data_ 'Not applicable' will exempt the contact from GDPR protections
Clicked LinkedIn AdStringFalseNo
Linkedin IDStringFalseNoA contact's linkedin id
Marketing contact status source nameStringTrueNoThe ID of the activity that set the contact as a marketing contact
Marketing contact status source typeStringTrueNoThe type of the activity that set the contact as a marketing contact
Marketing contact statusStringTrueNoThe marketing status of a contact
Marketing contact until next updateStringTrueNoSpecifies if this contact will be set as non_marketing on renewal
Merged object IDsStringTrueNoThe list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Pinned engagement IDDecimalTrueNo
PipelineStringFalseNoThe pipeline with which this contact is currently associated
Likelihood to closeDecimalTrueNoThe probability that a contact will become a customer within the next 90 days. This score is based on standard contact properties and behavior.
Contact priorityStringTrueNoA 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 ObjectBoolTrueNoIs the object read only
Date of first engagementDatetimeTrueNoThe date the current contact owner first engaged with the contact. Used in Sales Analytics app.
Description of first engagementStringTrueNoA description of the current contact owner's first engagement with the contact. Used in the Sales Analytics app.
Type of first engagementStringTrueNoThe object type of the current contact owner's first engagement with the contact. Used in the Sales Analytics app.
Recent Sales Email Clicked DateDatetimeTrueNoThe last time a tracked sales email was clicked by this user
Recent Sales Email Opened DateDatetimeTrueNoThe 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 codeStringTrueNoMobile number with country code
Calculated Phone Number with country codeStringTrueNoPhone number with country code
Calculated Mobile Number without country codeStringTrueNoMobile number without country code
Calculated Phone Number without country codeStringTrueNoPhone number without country code
Number of sequences actively enrolledDecimalTrueNoThe number of sequences actively enrolled.
Number of sequences enrolledDecimalTrueNoThe number of sequences enrolled.
Currently in SequenceBoolTrueNoA yes_no field that indicates whether the contact is currently in a Sequence.
testpurgeStringTrueNotesting purge
testrollbackStringTrueNotesting rollback
Time between contact creation and deal closeDecimalFalseNo
Time between contact creation and deal creationDecimalFalseNo
Time in 'Customer Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the contact in the 'Customer' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Evangelist Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the contact in the 'Evangelist' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Lead Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the contact in the 'Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Marketing Qualified Lead Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the contact in the 'Marketing Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Opportunity Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the contact in the 'Opportunity' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Other Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the contact in the 'Other' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Sales Qualified Lead Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the contact in the 'Sales Qualified Lead' stage_ 'Lifecycle Stage Pipeline' pipeline
Time in 'Subscriber Lifecycle Stage Pipeline'DecimalTrueNoThe total time in seconds spent by the contact in the 'Subscriber' stage_ 'Lifecycle Stage Pipeline' pipeline
Lead response timeDecimalTrueNoTime it took current owner to do first qualifying engagement ms. Used in Sales Analytics app.
Time to move from lead to customerDecimalFalseNoHow 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 customerDecimalFalseNoHow 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 customerDecimalFalseNoHow 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 customerDecimalFalseNoHow 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 customerDecimalFalseNoHow long it takes for a contact to move from the HubSpot subscriber stage to the HubSpot customer stage.
Time ZoneStringFalseNoThe 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 IDStringFalseNoA contact's twitter id
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
WhatsApp Phone NumberStringFalseNoThe phone number associated with the contact_s WhatsApp account.
Owner Assigned DateDatetimeTrueNoThe 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 CityStringTrueNoThe city reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP CountryStringTrueNoThe country reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
IP Country CodeStringTrueNoThe 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 _ LongitudeStringTrueNo
IP State_RegionStringTrueNoThe 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 CodeStringTrueNoThe 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 ZipcodeStringTrueNoThe zipcode reported by a contact's IP address. This is automatically set by HubSpot and can be used for segmentation and reporting.
Job functionStringFalseNoContact's job function. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Last Modified DateDatetimeTrueNoThe date any property on this contact was modified
Marital StatusStringFalseNoContact's marital status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Military statusStringFalseNoContact's military status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Number of Associated DealsDecimalTrueNoCount of deals associated with this contact. Set automatically by HubSpot.
Number of Form SubmissionsDecimalTrueNoThe number of forms this contact has submitted
Number of Unique Forms SubmittedDecimalTrueNoThe number of different forms this contact has submitted
Recent Conversion DateDatetimeTrueNoThe date this contact last submitted a form
Recent ConversionStringTrueNoThe last form this contact submitted
Recent Deal AmountDecimalTrueNoAmount of last closed won deal associated with a contact. Set automatically.
Recent Deal Close DateDatetimeTrueNoDate last deal associated with contact was closed_won. Set automatically.
Relationship StatusStringFalseNoContact's relationship status. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
SchoolStringFalseNoContact's school. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
SeniorityStringFalseNoContact's seniority. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Start dateStringFalseNoContact's start date. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
Total RevenueDecimalTrueNoSum of all closed_won deal revenue associated with the contact. Set automatically.
Work emailStringFalseNoContact's work email. Required for the Facebook Ads Integration. Automatically synced from the Lead Ads tool.
First NameStringFalseNoA contact's first name
First Page SeenStringTrueNoFirst page the contact visited on your website. Set automatically.
Marketing emails deliveredDecimalTrueNoThe number of marketing emails delivered for the current email address. This is automatically set by HubSpot.
Opted out of emailCustomer Service CommunicationStringTrueNoIndicates that the current email address has opted out of this email type.
Opted out of emailOne to OneStringTrueNoThis column is a custom field. Indicates that the current email address has opted out of this email type.
Twitter UsernameStringFalseNoThe contact's Twitter handle.
Currently in workflowStringTrueNoTrue when contact is enrolled in a workflow.
Follower CountDecimalFalseNoThe number of Twitter followers a contact has
Last Page SeenStringTrueNoLast page the contact visited on your website. Set automatically.
Marketing emails openedDecimalTrueNoThe number of marketing emails opened for the current email address. This is automatically set by HubSpot.
Last NameStringFalseNoA contact's last name
Number of PageviewsDecimalTrueNoTotal number of page views this contact has had on your website. Set automatically.
Marketing emails clickedDecimalTrueNoThe number of marketing emails which have had link clicks for the current email address. This is automatically set by HubSpot.
SalutationStringFalseNoThe title used to address a contact
Twitter Profile PhotoStringFalseNoThe contact's Twitter profile photo. This is set by HubSpot using the contact's email address.
EmailStringFalseNoA contact's email address
Number of SessionsDecimalTrueNoNumber of times a contact has come to your website. Set automatically.
Marketing emails bouncedDecimalTrueNoThe number of marketing emails that bounced for the current email address. This is automatically set by HubSpot.
PersonaStringFalseNoA contact's persona
Most Recent Social ClickDatetimeTrueNoThe date of the most recent click on a published social message. This is set automatically by HubSpot for each contact.
Number of event completionsDecimalTrueNoTotal number of events for this contact. Set automatically.
Unsubscribed from all emailBoolTrueNoIndicates that the current email address has opted out of all email.
Twitter ClicksDecimalTrueNoThe 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 NumberStringFalseNoA contact's mobile phone number
Phone NumberStringFalseNoA contact's primary phone number
Fax NumberStringFalseNoA contact's primary fax number
Time First SeenDatetimeTrueNoFirst time the contact has been seen. Set automatically.
Last marketing email nameStringTrueNoThe name of the last marketing email sent to the current email address. This is automatically set by HubSpot.
Last marketing email send dateDatetimeTrueNoThe date of the most recent delivery for any marketing email to the current email address. This is automatically set by HubSpot.
Facebook ClicksDecimalTrueNoThe number clicks on links shared on Facebook
Street AddressStringFalseNoContact's street address_ including apartment or unit number.
Date of last meeting booked in meetings toolDatetimeTrueNoThe 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 toolStringTrueNoUTM 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 toolStringTrueNoUTM 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 toolStringTrueNoUTM 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 SessionDatetimeTrueNoFirst time the contact visited your website. Set automatically.
Last marketing email open dateDatetimeTrueNoThe date of the most recent open for any marketing email to the current email address. This is automatically set by HubSpot.
Latest meeting activityDatetimeTrueNoThe date of the most recent meeting past or upcoming logged for* scheduled with* or booked by this contact.
Recent Sales Email Replied DateDatetimeTrueNoThe 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 ClicksDecimalTrueNoThe number clicks on links shared on LinkedIn
Contact ownerStringFalseNoThe owner of a contact. This can be any HubSpot user or Salesforce integration user_ and can be set manually or via Workflows.
Last ContactedDatetimeTrueNoThe 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 DateDatetimeTrueNoThe 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 DateDatetimeTrueNoThe 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 contactedDecimalTrueNoThe 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 ActivitiesDecimalTrueNoThe number of sales activities for a contact. This is set automatically by HubSpot based on user actions in the contact record.
HubSpot Owner Email legacyStringFalseNoA legacy property used to identify the email address of the owner of the contact. This property is no longer in use.
HubSpot Owner Name legacyStringFalseNoA legacy property used to identify the name of the owner of the contact. This property is no longer in use.
SurveyMonkey Event Last UpdatedDecimalTrueNoThis field is meaningless on its own_ and is solely used for triggering dynamic list updates when SurveyMonkey information is updated
Webinar Event Last UpdatedDecimalTrueNoThis field is meaningless on its own_ and is solely used for triggering dynamic list updates when webinar information is updated
CityStringFalseNoA contact's city of residence
Time Last SeenDatetimeTrueNoTimestamp for most recent webpage view on your website.
Last marketing email click dateDatetimeTrueNoThe date of the most recent link click for any marketing email to the current email address. This is automatically set by HubSpot.
Google Plus ClicksDecimalTrueNoThe number clicks on links shared on Google Plus
HubSpot TeamStringTrueNoThe team of the owner of a contact.
LinkedIn BioStringFalseNoA contact's LinkedIn bio
Twitter BioStringFalseNoThe contact's Twitter bio. This is set by HubSpot using the contact's email address.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
Time of Last SessionDatetimeTrueNoTimestamp for start of the most recent session for this contact to your website.
First marketing email send dateDatetimeTrueNoThe date of the earliest delivery for any marketing email to the current email address. This is automatically set by HubSpot.
Broadcast ClicksDecimalTrueNoThe number of clicks on published social messages. This is set automatically by HubSpot for each contact.
State_RegionStringFalseNoThe contact's state of residence. This might be set via import* form* or integration.
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom
Original SourceStringFalseNoFirst known source the contact used to find your website. Set automatically_ but may be updated manually.
First marketing email open dateDatetimeTrueNoThe date of the earliest open for any marketing email to the current email address. This is automatically set by HubSpot.
Latest SourceStringFalseNoThe source of the latest session for a contact
Postal CodeStringFalseNoThe contact's zip code. This might be set via import* form* or integration.
Country_RegionStringFalseNoThe contact's countryregion of residence. This might be set via import form_ or integration.
All accessible team idsStringTrueNoThe team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom
Original Source DrillDown 1StringTrueNoAdditional information about the source the contact used to find your website. Set automatically.
First marketing email click dateDatetimeTrueNoThe date of the earliest link click for any marketing email to the current email address. This is automatically set by HubSpot.
Latest Source DrillDown 1StringTrueNoAdditional information about the latest source for the last session the contact used to find your website. Set automatically.
LinkedIn ConnectionsDecimalFalseNoHow many LinkedIn connections they have
Original Source DrillDown 2StringTrueNoAdditional information about the source the contact used to find your website. Set automatically.
Is globally ineligibleBoolTrueNoIndicates the contact is globally ineligible for email.
Preferred languageStringFalseNoSet your contact's preferred language for communications. This property can be changed from an import* form* or integration.
Latest Source DrillDown 2StringTrueNoAdditional information about the source for the last session the contact used to find your website. Set automatically.
Klout ScoreDecimalFalseNoA contact's Klout score_ a measure of Internet influence
First Referring SiteStringTrueNoURL that referred the contact to your website. Set automatically.
First marketing email reply dateDatetimeTrueNoThe date of the earliest reply for any marketing email to the current email address. This is automatically set by HubSpot.
Job TitleStringFalseNoA contact's job title
PhotoStringFalseNoSocial Media photo
Last Referring SiteStringTrueNoLast URL that referred contact to your website. Set automatically.
Last marketing email reply dateDatetimeTrueNoThe date of the latest reply for any marketing email to the current email address. This is automatically set by HubSpot.
MessageStringFalseNoA default property to be used for any message or comments a contact may want to leave on a form.
Close DateDatetimeFalseNoDate 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 PageviewsDecimalTrueNoAverage number of pageviews per session for this contact. Set automatically.
Marketing emails repliedDecimalTrueNoThe number of marketing emails replied to by the current email address. This is automatically set by HubSpot.
Event RevenueDecimalTrueNoSet 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 DateDatetimeTrueNoThe date when a contact's lifecycle stage changed to Lead. This is automatically set by HubSpot for each contact.
Became a Marketing Qualified Lead DateDatetimeTrueNoThe date when a contact's lifecycle stage changed to MQL. This is automatically set by HubSpot for each contact.
Became an Opportunity DateDatetimeTrueNoThe date when a contact's lifecycle stage changed to Opportunity. This is automatically set by HubSpot for each contact.
Lifecycle StageStringFalseNoThe 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 DateDatetimeTrueNoThe date when a contact's lifecycle stage changed to SQL. This is automatically set by HubSpot for each contact.
Create DateDatetimeTrueNoThe date that a contact entered the system
Became an Evangelist DateDatetimeTrueNoThe date when a contact's lifecycle stage changed to Evangelist. This is automatically set by HubSpot for each contact.
Became a Customer DateDatetimeTrueNoThe date when a contact's lifecycle stage changed to Customer. This is automatically set by HubSpot for each contact.
HubSpot ScoreDecimalTrueNoThe number that shows qualification of contacts to sales readiness. It can be set in HubSpot's Lead Scoring app.
Company NameStringFalseNoName of the contact's company. This can be set independently from the name property on the contact's associated company.
Became a Subscriber DateDatetimeTrueNoThe date when a contact's lifecycle stage changed to Subscriber. This is automatically set by HubSpot for each contact.
Became an Other Lifecycle DateDatetimeTrueNoThe date when a contact's lifecycle stage changed to Other. This is automatically set by HubSpot for each contact.
Website URLStringFalseNoAssociated company website.
Number of EmployeesStringFalseNoThe number of company employees
Annual RevenueStringFalseNoAnnual company revenue
IndustryStringFalseNoThe Industry a contact is in
Primary Associated Company IDDecimalFalseNoHubSpot defined ID of a contact's primary associated company in HubSpot.
Associated Company Last UpdatedDecimalTrueNoThis field is meaningless on its own_ and is solely used for triggering dynamic list updates when a company is updated
Lead RatingStringTrueNoThe rating of this contact based on their predictive lead score
Predictive Lead ScoreDecimalTrueNoA score calculated by HubSpot that represents a contact's likelihood to become a customer

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ContactsId [KEY]LongFalseContacts.IdNoContacts ID
DealsId [KEY]LongFalseDeals.IdNoDeals ID
TypeStringFalseNoAssociation type between associated objects.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoA unique ID for this association.
ObjectFullyQualifiedName [KEY]StringFalseNoA unique ID for this schema's object type. It is defined as _meta_type*__unique ID*.
ObjectTypeIdStringTrueNoThe ID of the custom object type.
ObjectIdStringTrueNoAn assigned unique ID for the object_ including portal ID and object name.
ObjectNameStringTrueNoA unique name for the schema's object type.
ObjectLabelSingularStringTrueNoSingular label for the object. Used in CRM display.
ObjectLabelPluralStringTrueNoPlural label for the object. Used in CRM display.
NameStringFalseNoA unique name for this association.
CardinalityStringFalseNoThe cardinality type.
InverseCardinalityStringFalseNoThe inverseCardinality type.
FromObjectTypeIdStringFalseNoID of the primary object type to link from.
ToObjectTypeIdStringFalseNoID of the target object type ID to link to.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
ObjectIdStringFalseNoAn assigned unique ID for the object_ including portal ID and object name.
ObjectFullyQualifiedName [KEY]StringFalseNoA unique ID for this schema's object type. It is defined as _meta_type*__unique ID*.
ObjectNameStringFalseNoA unique name for the schema's object type.
ObjectLabelSingularStringFalseNoSingular label for the object. Used in CRM display.
ObjectLabelPluralStringFalseNoPlural label for the object. Used in CRM display.
Name [KEY]StringFalseNoThe internal property name_ which must be used when referencing the property via the API.
LabelStringFalseNoA human_readable property label that will be shown in HubSpot.
UpdatedAtDatetimeFalseNoWhen the Custom Object was last updated.
CreatedAtDatetimeFalseNoWhen the Custom Object was created.
ArchivedAtDatetimeFalseNoWhen the Custom Object was archived.
TypeStringFalseNoThe property data type.
FieldTypeStringFalseNoControls how the property appears in HubSpot.
DescriptionStringFalseNoA description of the property that will be shown as help text in HubSpot.
GroupNameStringFalseNoThe name of the property group the property belongs to.
OptionsStringFalseNoA list of valid options for the property. This field is required for enumerated properties_ but will be empty for other property types.
CreatedUserIdStringFalseNoThe internal ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.
UpdatedUserIdStringFalseNoThe 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.
ReferencedObjectTypeStringFalseNoIf this property is related to other object_s__ they'll be listed here.
DisplayOrderIntFalseNoThe 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.
CalculatedBoolFalseNoFor default properties_ true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
ExternalOptionsBoolFalseNoFor default properties_ true indicates that the options are stored externally to the property settings.
ArchivedBoolFalseNoWhether or not the property is archived.
HasUniqueValueBoolFalseNoWhether or not the property's value must be unique. Once set_ this can't be changed.
HiddenBoolFalseNoWhether or not the property is hidden.
HubspotDefinedBoolFalseNoThis will be true for default object properties built into HubSpot.
ShowCurrencySymbolBoolFalseNoWhether the property will display the currency symbol set in the account settings.
ModificationMetadataStringFalseNoThe properties' modification metadata.
FormFieldBoolFalseNoWhether or not the property can be used in a HubSpot form.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
IdStringFalseNoAn assigned unique ID for the object_ including portal ID and object name.
FullyQualifiedName [KEY]StringFalseNoA unique ID for this schema's object type. It is defined as _meta_type*__unique ID*.
NameStringFalseNoA unique name for the schema's object type.
LabelSingularStringFalseNoSingular label for the object. Used in CRM display.
LabelPluralStringFalseNoPlural label for the object. Used in CRM display.
CreatedAtDatetimeFalseNoWhen the Custom Object was created.
UpdatedAtDatetimeFalseNoWhen the Custom Object was last updated.
PropertiesAggregateStringFalseNoAn aggregate of the properties defined for a given object type. This information can be viewed in more detail in CustomObjectProperties table.
AssociationsAggregateStringFalseNoAn aggregate of the associations defined for a given object type. This information can be viewed in more detail in CustomObjectAssociations table.
RequiredPropertiesStringFalseNoThe names of properties that should be required when creating an object of this type.
SearchablePropertiesStringFalseNoNames of properties that will be indexed for this object type in by HubSpot's product search.
PrimaryDisplayPropertyStringFalseNoThe name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type.
SecondaryDisplayPropertiesStringFalseNoThe names of secondary properties for this object. These will be displayed as secondary on the HubSpot record page for this object type.
ObjectTypeIdStringFalseNoThe ID of the custom object type.
MetaTypeStringFalseNoThe custom object type description.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueDeals.IdNoDeals ID
AssociationId [KEY]LongFalseNoID of the object that this Deals object is associated with.
Type [KEY]StringFalseNoType of the associated object* which can be a contact* deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identified of the pipeline.
LabelStringFalseNoThe label name of the pipeline.
ArchivedBoolTrueNoWhether the pipeline is archived or not.
CreatedAtDatetimeTrueNoWhen the pipeline was created.
UpdatedAtDatetimeTrueNoWhen the pipeline was last updated.
DisplayOrderIntFalseNoThe order of this specific pipeline in the collection of pipelines for this table.
StagesAggregateStringFalseNoAn aggregate of the stages included in this pipeline. This information can be viewed in more detail in DealPipelineStages table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoUnique identifier of the stage in the pipeline.
PipelineId [KEY]StringFalseDealPipelines.IdNoUnique identifier of the pipeline.
LabelStringFalseNoLabel name of the pipeline stage.
PipelineLabelStringTrueDealPipelines.LabelNoThe label name of the pipeline.
IsClosedBoolFalseNoWhether this stage is open or closed.
ProbabilityDecimalFalseNoCurrent state of the pipeline stage.
ArchivedBoolTrueNoWhether the stage is archived or not.
CreatedAtDatetimeTrueNoTime the stage was created.
UpdatedAtDatetimeTrueNoTime the stage was last updated.
DisplayOrderIntFalseNoThe order of the stage in the collection of stages for this pipeline.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
HasUniqueValueBoolFalseNoBoolean indicating if the value of the property is unique.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PropertyNameStringTrueNoThe name of the property.
ValueStringTrueNoThe historical value of the property.
SourceTypeStringTrueNoThe method by which the property was changed.
SourceIdStringTrueNoAdditional data related to the source. May not be populated for all sources.
TimestampDatetimeTrueNoDatetime when the property was updated.
DealIdLongTrueNoThe deal identifier.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property group.
LabelStringFalseNoThe label of the group.
DisplayOrderIntFalseNoThe numerical order of the group with respect to other groups.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
ItemURLStringTrueNoUrl that points directly to the HubSpot item.
Amount in company currencyDecimalTrueNoThe amount of the deal* using the exchange rate* in your company's currency
Days to closeDecimalTrueNoThe number of days the deal took to close
CurrencyStringFalseNoCurrency code for the deal.
Annual contract valueDecimalTrueNoThe annual contract value ACV of this deal.
Business unitsStringFalseNoThe business units this record is assigned to.
Deal CollaboratorStringTrueNoOwner ids of the users involved in closing the deal
Deal Split UsersStringTrueNoThe owner ids of all associated Deal Splits. This property is set automatically by HubSpot.
Latest SourceStringTrueNoSource for the contact either directly or indirectly associated with the last session activity for this deal
Latest Source CompanyStringTrueNoSource for the company with an associated contact with the last session activity for this deal
Latest Source ContactStringTrueNoSource for the directly associated contact with the last session activity for this deal
Latest Source Data 1StringTrueNoAdditional source details of the last session attributed to any contacts that are directly or indirectly associated with this deal
Latest Source Data 1 CompanyStringTrueNoAdditional 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 ContactStringTrueNoAdditional source details of the last session attributed to any contacts that are directly associated with this deal
Latest Source Data 2StringTrueNoAdditional source details of the last session attributed to any contacts that are directly or indirectly associated with this deal
Latest Source Data 2 CompanyStringTrueNoAdditional source details of the last session attributed to any contacts that are indirectly associated with this deal
Latest Source Data 2 ContactStringTrueNoAdditional source details of the last session attributed to any contacts that are directly associated with this deal
Latest Source TimestampDatetimeTrueNoTimestamp of when latest source occurred for either a directly or indirectly associated contact
Latest Source Timestamp CompanyDatetimeTrueNoTimestamp of when latest source occurred for an indirectly associated contact
Latest Source Timestamp ContactDatetimeTrueNoTimestamp of when latest source occurred for a directly associated contact
Original Source TypeStringFalseNoOriginal source for the contact with the earliest activity for this deal.
Original Source Data 1StringTrueNoAdditional 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 2StringTrueNoAdditional 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 revenueDecimalTrueNoThe annual recurring revenue ARR of this deal.
HubSpot CampaignStringFalseNoThe marketing campaign the deal is associated with
Closed Deal AmountDecimalTrueNoReturns the amount if the deal is closed. Else_ returns 0.
Closed Deal Amount In Home CurrencyDecimalTrueNoReturns the amount in home currency if the deal is closed. Else_ returns 0.
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Date entered 'Appointment Scheduled Sales Pipeline'DatetimeTrueNoThe date and time when the deal entered the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline
Date entered 'Closed Lost Sales Pipeline'DatetimeTrueNoThe date and time when the deal entered the 'Closed Lost' stage_ 'Sales Pipeline' pipeline
Date entered 'Closed Won Sales Pipeline'DatetimeTrueNoThe date and time when the deal entered the 'Closed Won' stage_ 'Sales Pipeline' pipeline
Date entered 'Contract Sent Sales Pipeline'DatetimeTrueNoThe date and time when the deal entered the 'Contract Sent' stage_ 'Sales Pipeline' pipeline
Date entered 'Decision Maker BoughtIn Sales Pipeline'DatetimeTrueNoThe date and time when the deal entered the 'Decision Maker BoughtIn' stage 'Sales Pipeline' pipeline
Date entered 'Presentation Scheduled Sales Pipeline'DatetimeTrueNoThe date and time when the deal entered the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline
Date entered 'Qualified To Buy Sales Pipeline'DatetimeTrueNoThe date and time when the deal entered the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline
Date exited 'Appointment Scheduled Sales Pipeline'DatetimeTrueNoThe date and time when the deal exited the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline
Date exited 'Closed Lost Sales Pipeline'DatetimeTrueNoThe date and time when the deal exited the 'Closed Lost' stage_ 'Sales Pipeline' pipeline
Date exited 'Closed Won Sales Pipeline'DatetimeTrueNoThe date and time when the deal exited the 'Closed Won' stage_ 'Sales Pipeline' pipeline
Date exited 'Contract Sent Sales Pipeline'DatetimeTrueNoThe date and time when the deal exited the 'Contract Sent' stage_ 'Sales Pipeline' pipeline
Date exited 'Decision Maker BoughtIn Sales Pipeline'DatetimeTrueNoThe date and time when the deal exited the 'Decision Maker BoughtIn' stage 'Sales Pipeline' pipeline
Date exited 'Presentation Scheduled Sales Pipeline'DatetimeTrueNoThe date and time when the deal exited the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline
Date exited 'Qualified To Buy Sales Pipeline'DatetimeTrueNoThe date and time when the deal exited the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline
Deal amount calculation preferenceStringFalseNoSpecifies how deal amount should be calculated from line items
Deal probabilityDecimalFalseNoThe probability a deal will close. This defaults to the deal stage probability setting.
Deal stage probability shadowDecimalTrueNoFall 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 rateDecimalTrueNoThis is the exchange rate used to convert the deal amount into your company currency.
Forecast amountDecimalTrueNoThe custom forecasted deal value calculated by multiplying the forecast probability and deal amount in your company_s currency.
Forecast probabilityDecimalFalseNoThe custom percent probability a deal will close.
Is Deal Closed_BoolTrueNoTrue if the deal was won or lost.
Is Closed WonBoolTrueNoTrue if the deal is in the closed won state_ false otherwise
Deal Split AddedBoolTrueNoIndicates if the deal is split between multiple users.
Last Modified DateDatetimeTrueNoMost 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 dateDecimalTrueNoHubspot predicted likelihood between 0 and 1 of the deal to close by the close date.
Global Term Line Item Discount PercentageStringFalseNoFor internal HubSpot Application use only. Global term for the discount percentage applied.
Global Term Line Item Discount Percentage EnabledBoolFalseNoFor internal HubSpot Application use only. Indicates if the Global term for the discount percentage is enabled.
Global Term Line Item Recurring Billing PeriodStringFalseNoFor internal HubSpot Application use only. Global term for product recurring billing duration.
Global Term Line Item Recurring Billing Period EnabledBoolFalseNoFor internal HubSpot Application use only. Indicates if the Global term for product recurring billing duration is enabled.
Global Term Line Item Recurring Billing Start DateStringFalseNoFor internal HubSpot Application use only. Global term for recurring billing start date for a line item.
Global Term Line Item Recurring Billing Start Date EnabledBoolFalseNoFor 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 FrequencyStringFalseNoFor internal HubSpot Application use only. Global term for how frequently the product is billed.
Global Term Line Item Recurring Billing Frequency EnabledBoolFalseNoFor internal HubSpot Application use only. Indicates if the Global term for how frequently the product is billed is enabled
Forecast categoryStringFalseNoThe likelihood a deal will close. This property is used for manual forecasting your deals.
Merged object IDsStringTrueNoThe 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 revenueDecimalTrueNoThe monthly recurring revenue MRR of this deal.
Next stepStringFalseNoA short description of the next step for the deal
Number of Active Deal RegistrationsDecimalTrueNoThe number of active deal registrations associated with this deal. This property is set automatically by HubSpot.
Number of Deal RegistrationsDecimalTrueNoThe number of deal registrations associated with this deal. This property is set automatically by HubSpot.
Number of Deal SplitsDecimalTrueNoThe number of deal splits associated with this deal. This property is set automatically by HubSpot.
Number of target accountsDecimalTrueNoThe number of target account companies associated with this deal. This property is set automatically by HubSpot.
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Pinned Engagement IDDecimalTrueNoThe object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified.
The predicted deal amountDecimalTrueNoReturns 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 currencyDecimalTrueNoReturns the multiplication of the deal amount in your company's currency times the predicted likelihood of the deal to close by the close date.
PriorityStringFalseNo
Weighted amountDecimalTrueNoReturns the multiplication of the amount times the probability of the deal closing.
Weighted amount in company currencyDecimalTrueNoReturns the multiplication of the amount in home currency times the probability of the deal closing.
Read Only ObjectBoolTrueNoIs the object read only
Total contract valueDecimalTrueNoThe total contract value TCV of this deal.
Time in 'Appointment Scheduled Sales Pipeline'DecimalTrueNoThe total time in seconds spent by the deal in the 'Appointment Scheduled' stage_ 'Sales Pipeline' pipeline
Time in 'Closed Lost Sales Pipeline'DecimalTrueNoThe total time in seconds spent by the deal in the 'Closed Lost' stage_ 'Sales Pipeline' pipeline
Time in 'Closed Won Sales Pipeline'DecimalTrueNoThe total time in seconds spent by the deal in the 'Closed Won' stage_ 'Sales Pipeline' pipeline
Time in 'Contract Sent Sales Pipeline'DecimalTrueNoThe total time in seconds spent by the deal in the 'Contract Sent' stage_ 'Sales Pipeline' pipeline
Time in 'Decision Maker BoughtIn Sales Pipeline'DecimalTrueNoThe total time in seconds spent by the deal in the 'Decision Maker BoughtIn' stage 'Sales Pipeline' pipeline
Time in 'Presentation Scheduled Sales Pipeline'DecimalTrueNoThe total time in seconds spent by the deal in the 'Presentation Scheduled' stage_ 'Sales Pipeline' pipeline
Time in 'Qualified To Buy Sales Pipeline'DecimalTrueNoThe total time in seconds spent by the deal in the 'Qualified To Buy' stage_ 'Sales Pipeline' pipeline
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner Assigned DateDatetimeTrueNoThe date the most recent deal owner was assigned to a deal. This is updated automatically by HubSpot.
Deal NameStringFalseNoThe name given to this deal.
AmountDecimalFalseNoThe total amount of the deal
Deal StageStringFalseNoThe stage of the deal. Deal stages allow you to categorize and track the progress of the deals that you are working on.
PipelineStringFalseNoThe pipeline the deal is in. This determines which stages are options for the deal.
Close DateDatetimeFalseNoDate the deal was closed. This property is set automatically by HubSpot.
Create DateDatetimeFalseNoDate the deal was created. This property is set automatically by HubSpot.
Date of last meeting booked in meetings toolDatetimeTrueNoThe date of the most recent meeting an associated contact has booked through the meetings tool.
Campaign of last booking in meetings toolStringTrueNoThis 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 toolStringTrueNoThis 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 toolStringTrueNoThis 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 activityDatetimeTrueNoThe 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 DateDatetimeTrueNoThe last time a tracked sales email was replied to for this deal
Deal ownerStringFalseNoUser the deal is assigned to. Assign additional users to a deal record by creating a custom user property.
Last ContactedDatetimeTrueNoThe 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 DateDatetimeTrueNoThe last time a note* call* email* meeting* or task was logged for a deal. This is updated automatically by HubSpot.
Next Activity DateDatetimeTrueNoThe 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 contactedDecimalTrueNoThe total number of sales activities notes calls* emails* meetings* or tasks* logged for a deal. This is updated automatically by HubSpot.
Number of Sales ActivitiesDecimalTrueNoThe total number of times a sales email or call has been logged for a deal. This is updated automatically by HubSpot.
HubSpot Create DateDatetimeTrueNoThe date the deal was created. This property is set automatically by HubSpot.
HubSpot TeamStringTrueNoPrimary team of the deal owner. This property is set automatically by HubSpot.
Deal TypeStringFalseNoThe type of deal. By default_ categorize your deal as either a New Business or Existing Business.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
Deal DescriptionStringFalseNoDescription of the deal
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team idsStringTrueNoThe team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom
Number of Associated ContactsDecimalTrueNoThe number of contacts associated with this deal. This property is set automatically by HubSpot.
Closed Lost ReasonStringFalseNoReason why this deal was lost
Closed Won ReasonStringFalseNoReason why this deal was won

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoEmails ID
AssociationId [KEY]LongFalseNoID of the object that this Emails object is associated with.
Type [KEY]StringFalseNoType of the associated object, which can be a contact, deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
Call and meeting typeStringFalseNoThe activity type of the engagement
Business unitsStringFalseNoThe business units this record is assigned to.
AtMentioned Owner IdsStringFalseNoThe owners that have been at_mentioned on the engagement
Attached file IDsStringFalseNoThe IDs of the files that are attached to the engagement
Call notes previewStringTrueNoA truncated preview of the call notes
HTML Body PreviewStringTrueNoThe HTML representation of the engagement body preview
Body Preview TruncatedBoolTrueNoIndicates if the engagement body was truncated for the preview
Integrating App IDDecimalFalseNoThe App ID associated with the integrating app
Authenticated recording files url providerStringTrueNoURL which returns Authenticated audio_video URL of the recording
Call notesStringFalseNoThe body of the call
Callee object idDecimalFalseNoThe id of the callee
Callee object typeStringFalseNoThe type of callee
Call directionStringFalseNoThe direction of a call
Call outcomeStringFalseNoThe outcome of the call
Call durationDecimalFalseNoThe duration of the call_ in milliseconds
External Account IDStringFalseNoExternal Account ID
External IDStringFalseNoThe external ID of the call
From NumberStringFalseNoThe phone number of the person that initiated the call
From Number NameStringTrueNoThe name of the phone number that initiated the call
Transcript AvailableBoolFalseNoFlag to indicate if the call has an associated transcript
Voicemail AvailableStringTrueNoFlag to indicate if the call has an associated voicemail
Recording URLStringFalseNoThe URL of the recorded call audio
Call SourceStringFalseNoThe source of the call to differentiate VoIP vs Video Conferencing Apps
Call statusStringFalseNoThe status of the call
Call TitleStringFalseNoThe title of the call
To NumberStringFalseNoThe phone number of the person that was called
To Number NameStringTrueNoThe name of the phone number that was called
Tracked termsStringTrueNoA list of any tracked terms contained in the call transcript
Call transcription idDecimalFalseNoThe id of the transcription
Video urlStringFalseNoVideo URL of the recording
Unique Zoom Meeting IDStringFalseNoThe Zoom meeting unique identifier of the call
Calls Service Call IDDecimalTrueNoThe Calls Service specific global unique identifier for a call
Activity created byDecimalTrueNoThe user who created the engagement
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Create dateDatetimeTrueNoThe date that an engagement was created
Engagement SourceStringFalseNoThe source that created this engagement
Engagement Source IDStringFalseNoThe specific ID of the process that created this engagement
Follow up actionStringFalseNoWhat action should be performed during follow up
GDPR deletedBoolTrueNoIndicates the body of this engagement has been cleared because of a GDPR delete request
Last modified dateDatetimeTrueNoThe date any property on this engagement was modified
Merged object IDsStringTrueNoThe list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated byDecimalTrueNoThe user who last updated the engagement
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product nameStringFalseNoThe name of the product associated with this engagement
Queue MembershipsStringFalseNoThe list of queues that contain this engagement
Read Only ObjectBoolTrueNoIs the object read only
Activity dateDatetimeFalseNoThe date that an engagement occurred
Unique creation keyStringTrueNoUnique property used for idempotent creates
Unique IDStringFalseNoThe unique ID of the engagement
Unknown Visitor ConversationBoolFalseNoWhether or not this communication was made with an unknown visitor
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner Assigned DateDatetimeTrueNoThe timestamp when an owner was assigned to this engagement
Activity assigned toStringFalseNoThe 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 TeamStringTrueNoThe team of the owner of an engagement.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team idsStringTrueNoThe team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
Business unitsStringFalseNoThe business units this record is assigned to.
AtMentioned Owner IdsStringFalseNoThe owners that have been at_mentioned on the engagement
Attached file IDsStringFalseNoThe IDs of the files that are attached to the engagement
Body previewStringTrueNoA truncated preview of the engagegement body
HTML Body PreviewStringTrueNoThe HTML representation of the engagement body preview
Body Preview TruncatedBoolTrueNoIndicates if the engagement body was truncated for the preview
Activity created byStringTrueNoThe user who created the engagement
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Create dateDatetimeTrueNoThe date that an engagement was created
Email direction and unique IDStringTrueNoThe direction and unique ID of the email
Attached VideoStringFalseNoThe ID of a video optionally attached to an email
Attached Video NameStringFalseNoThe name of a video optionally attached to an email
Attached Video OpenedBoolFalseNoHas the video attachment been opened
Attached Video WatchedBoolFalseNoHas the video attachement been watched
Email BCC AddressStringTrueNoEmail addresses of the email's BCC recipients
Email BCC First NameStringTrueNoFirst names of the email's BCC recipients
Email BCC Last NameStringTrueNoLast names of the email's BCC recipients
Email BCCStringTrueNoRaw header values of the email's BCC recipients
Email Bounce Error Detail MessageStringFalseNoThe message from the bounce error.
Email Bounce Error Detail Status CodeDecimalFalseNoThe status code from the bounce error.
Email CC AddressStringTrueNoEmail addresses of the email's CC recipients
Email CC First NameStringTrueNoFirst names of the email's CC recipients
Email CC Last NameStringTrueNoLast names of the email's CC recipients
Email CCStringTrueNoRaw header values of the email's CC recipients
Email DirectionStringFalseNoThe direction the email was sent in
Encoded Email Associations RequestStringTrueNoEncoded email associations request
Error MessageStringFalseNoThe error that occurred while sending the email
Email Send IdStringTrueNoThe ID of the email send event sent through Facsimile
Email From AddressStringTrueNoEmail address of the email's sender
Email From First NameStringTrueNoFirst name of the email's sender
Email From Last NameStringTrueNoLast name of the email's sender
Email FromStringTrueNoRaw header value of the email's sender
Email HeadersStringFalseNoThe sender and receivers of the email
Email bodyStringFalseNoThis is the body of any email sent from a record. It doesn't include emails received from contacts.
Logged FromStringFalseNoWhere the email was logged
Media Processing StatusStringFalseNoProcessing status for this email's images and attachments
Email is member of forwarded subthreadBoolFalseNoWhether this email is a member of a forwarded subthread
Message IDStringFalseNoThe ID of the message
EmailMigratedViaPortalDataMigrationStringFalseNoIndicates that the email was migrated from another portal using DataMigration tool
Email pending inline image file IDsStringFalseNoFile IDs of pending inline images in the email's HTML
PostSend StatusStringFalseNoA description of what happened to the email successful send bounced* dropped* and why
RecipientDrop ReasonsStringFalseNoA list of the dropped recipients paired with the reason each was dropped
Email Send Event IdStringFalseNoThe ID of the email send event
Email Send Event Id CreatedDatetimeFalseNoThe date when the email send event ID was created
Email Sender AddressStringTrueNoEmail address of the email's sender
Email Sender First NameStringTrueNoFirst name of the email's sender
Email Sender Last NameStringTrueNoLast name of the email's sender
Email SenderStringTrueNoRaw header value of the email's sender
Sent ViaStringFalseNoHow the email was sent
Email send statusStringFalseNoThe send status of the email
Email subjectStringFalseNoThe subject of the email
TextStringFalseNoThe plaintext of the email
Thread IDStringFalseNoThe thread that the email belongs to
Email To AddressStringTrueNoEmail addresses of the email's recipients
Email To First NameStringTrueNoFirst names of the email's recipients
Email To Last NameStringTrueNoLast names of the email's recipients
Email ToStringTrueNoRaw header values of the email's recipients
Tracker KeyStringFalseNoThe tracker key of the email
Validation SkippedStringFalseNoValidation skipped that would have otherwise rejected logging
Engagement SourceStringFalseNoThe source that created this engagement
Engagement Source IDStringFalseNoThe specific ID of the process that created this engagement
Follow up actionStringFalseNoWhat action should be performed during follow up
GDPR deletedBoolTrueNoIndicates the body of this engagement has been cleared because of a GDPR delete request
Last modified dateDatetimeTrueNoThe date any property on this engagement was modified
Merged object IDsStringTrueNoThe list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated byStringTrueNoThe user who last updated the engagement
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product nameStringFalseNoThe name of the product associated with this engagement
Queue MembershipsStringFalseNoThe list of queues that contain this engagement
Read Only ObjectBoolTrueNoIs the object read only
Activity dateDatetimeFalseNoThe date that an engagement occurred
Unique creation keyStringTrueNoUnique property used for idempotent creates
Unique IDStringFalseNoThe unique ID of the engagement
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner Assigned DateDatetimeTrueNoThe timestamp when an owner was assigned to this engagement
Activity assigned toStringFalseNoThe 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 TeamStringTrueNoThe team of the owner of an engagement.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team idsStringTrueNoThe team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
Call and meeting typeStringFalseNoThe activity type of the engagement
Business unitsStringFalseNoThe business units this record is assigned to.
AtMentioned Owner IdsStringFalseNoThe owners that have been at_mentioned on the engagement
Attached file IDsStringFalseNoThe IDs of the files that are attached to the engagement
HubSpot attendee owner IDsStringFalseNoList of HubSpot owner IDs for additional attendees
Body previewStringTrueNoA truncated preview of the engagegement body
HTML Body PreviewStringTrueNoThe HTML representation of the engagement body preview
Body Preview TruncatedBoolTrueNoIndicates if the engagement body was truncated for the preview
Activity created byDecimalTrueNoThe user who created the engagement
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Create dateDatetimeTrueNoThe date that an engagement was created
Engagement SourceStringFalseNoThe source that created this engagement
Engagement Source IDStringFalseNoThe specific ID of the process that created this engagement
Follow up actionStringFalseNoWhat action should be performed during follow up
GDPR deletedBoolTrueNoIndicates the body of this engagement has been cleared because of a GDPR delete request
iCalUidStringTrueNoThe iCalUid of the synced event
Internal Meeting NotesStringFalseNo
Last modified dateDatetimeTrueNoThe date any property on this engagement was modified
Meeting descriptionStringFalseNoThe text description of the meeting
Meeting calendar event hashStringFalseNoThe unique hash for the meeting
Meeting change idStringFalseNoThe unique change id for the meeting
Created From Link IDStringFalseNoCreated From Link ID
Meeting end timeDatetimeFalseNoThe date when the meeting ends
External URLStringFalseNoThe external URL for the meeting
Meeting locationStringFalseNoWhere the meeting takes place
Location typeStringFalseNoThe type of location for the meeting event
Meeting outcomeStringFalseNoThe outcome of this meeting
Payments session idStringFalseNoThe payments session id for the meeting
PreMeeting prospect remindersStringFalseNoA list of dates when meeting reminders should be sent to prospects
Meeting sourceStringTrueNoThe source where the meeting was booked
Source IDStringFalseNoThe source ID of the meeting
Meeting start timeDatetimeFalseNoThe date when the meeting starts
Meeting nameStringFalseNoThe title of the meeting
Web conference meeting IDStringFalseNoThe meeting ID of the web conference
Merged object IDsStringTrueNoThe list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated byDecimalTrueNoThe user who last updated the engagement
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product nameStringFalseNoThe name of the product associated with this engagement
Queue MembershipsStringFalseNoThe list of queues that contain this engagement
Read Only ObjectBoolTrueNoIs the object read only
Scheduled tasksStringTrueNo
Activity dateDatetimeFalseNoThe date that an engagement occurred
Unique creation keyStringTrueNoUnique property used for idempotent creates
Unique IDStringFalseNoThe unique ID of the engagement
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner Assigned DateDatetimeTrueNoThe timestamp when an owner was assigned to this engagement
Activity assigned toStringFalseNoThe 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 TeamStringTrueNoThe team of the owner of an engagement.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team idsStringTrueNoThe team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
Business unitsStringFalseNoThe business units this record is assigned to.
AtMentioned Owner IdsStringFalseNoThe owners that have been at_mentioned on the engagement
Attached file IDsStringFalseNoThe IDs of the files that are attached to the engagement
Body previewStringTrueNoA truncated preview of the engagegement body
HTML Body PreviewStringTrueNoThe HTML representation of the engagement body preview
Body Preview TruncatedBoolTrueNoIndicates if the engagement body was truncated for the preview
Activity created byDecimalTrueNoThe user who created the engagement
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Create dateDatetimeTrueNoThe date that an engagement was created
Engagement SourceStringFalseNoThe source that created this engagement
Engagement Source IDStringFalseNoThe specific ID of the process that created this engagement
Follow up actionStringFalseNoWhat action should be performed during follow up
GDPR deletedBoolTrueNoIndicates the body of this engagement has been cleared because of a GDPR delete request
Last modified dateDatetimeTrueNoThe date any property on this engagement was modified
Merged object IDsStringTrueNoThe list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Updated byDecimalTrueNoThe user who last updated the engagement
Note bodyStringFalseNoThe body of the note
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product nameStringFalseNoThe name of the product associated with this engagement
Queue MembershipsStringFalseNoThe list of queues that contain this engagement
Read Only ObjectBoolTrueNoIs the object read only
Activity dateDatetimeFalseNoThe date that an engagement occurred
Unique creation keyStringTrueNoUnique property used for idempotent creates
Unique IDStringFalseNoThe unique ID of the engagement
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner Assigned DateDatetimeTrueNoThe timestamp when an owner was assigned to this engagement
Activity assigned toStringFalseNoThe 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 TeamStringTrueNoThe team of the owner of an engagement.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team idsStringTrueNoThe team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
Business unitsStringFalseNoThe business units this record is assigned to.
AtMentioned Owner IdsStringFalseNoThe owners that have been at_mentioned on the engagement
Attached file IDsStringFalseNoThe IDs of the files that are attached to the engagement
Notes previewStringTrueNoA plain_text preview of the notes field on a task
HTML Body PreviewStringTrueNoThe HTML representation of the engagement body preview
Body Preview TruncatedBoolTrueNoIndicates if the engagement body was truncated for the preview
Calendar Event IDStringTrueNoThe event ID for the synced task.
Created byDecimalTrueNoThe user who created the engagement
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Created atDatetimeTrueNoThe date that an engagement was created
SourceStringFalseNoThe source that created this engagement
Source IDStringFalseNoThe specific ID of the process that created this engagement
Follow up actionStringFalseNoWhat action should be performed during follow up
GDPR deletedBoolTrueNoIndicates the body of this engagement has been cleared because of a GDPR delete request
Last modified atDatetimeTrueNoThe date any property on this engagement was modified
Merged object IDsStringTrueNoThe 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 byDecimalTrueNoThe user who last updated the engagement
MS Teams message IDStringTrueNoThe message ID for the created task.
Associated CompaniesDecimalTrueNoThe number of companies associated with this task
Associated ContactsDecimalTrueNoThe number of contacts associated with this task
Associated DealsDecimalTrueNoThe number of deals associated with this task
Associated Queue ObjectsDecimalTrueNoThe number of objects associated with this task that support task queues
Associated TicketsDecimalTrueNoThe number of tickets associated with this task
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product nameStringFalseNoThe name of the product associated with this engagement
QueueStringFalseNoThe list of queues that contain this engagement
Read Only ObjectBoolTrueNoIs the object read only
Task repeat statusStringTrueNoIndicates whether the task is currently repeating
Scheduled tasksStringTrueNo
NotesStringFalseNoThe content in the notes field on a task
Completed atDatetimeTrueNoThe date that the task was completed
Contact Time ZoneStringTrueNoThe time zone of the associated contact
For Object TypeStringFalseNoThe object type for the task
Task is all dayBoolFalseNoDetermines if the task is due all day or at a specific time
Last contactedDatetimeTrueNoThe 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 engagementDatetimeTrueNoThe date of the last sales activity with the associated contact. This is set automatically by HubSpot based on user actions in the contact record
PriorityStringFalseNoThe priority of the task
Task probability to completeDecimalTrueNoThe probability the task will be completed
Relative Task RemindersStringFalseNoThe dates relative to the due date when reminders will be sent
ReminderStringFalseNoThe dates when reminders will be sent
IntervalStringTrueNoHow often the task should repeat
Send Default ReminderBoolFalseNoWhether or not a reminder should be sent when the task is due
Sequence Enrollment Is ActiveBoolTrueNoWhether the sequence enrollment this task is a part of is currently active
Sequence step enrollment IdStringTrueNoThe id of the sequence step that created the task
Sequence step numberDecimalTrueNoThe order of this task in the sequence at time of enrollment
Task StatusStringFalseNoThe status of the task
Task TitleStringFalseNoThe subject text for the task
Task template idDecimalTrueNoThe id of template the task was created from
Task TypeStringFalseNoThe type of task
Due dateDatetimeFalseNoThe date that an engagement occurred
Unique creation keyStringTrueNoUnique property used for idempotent creates
Unique IDStringFalseNoThe unique ID of the engagement
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner Assigned DateDatetimeTrueNoThe timestamp when an owner was assigned to this engagement
Assigned toStringFalseNoThe 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 TeamStringTrueNoThe team of the owner of an engagement.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom
All accessible team idsStringTrueNoThe team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueFeedbacksubmissions.IdNoFeedbacksubmissions ID
AssociationId [KEY]LongFalseNoID of the object that this Feedbacksubmissions object is associated with.
Type [KEY]StringFalseNoType of the associated object* which can be a contact* deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
Agent emailStringTrueNoConversation agent's email
Agent responsible for the conversationDecimalTrueNoAgent responsible for the conversation which led to the feedback
Agent nameStringTrueNoConversation agent's full name
All accessible team IDsStringTrueNoThe team IDs* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom
Business unitsStringFalseNoThe business units this record is assigned to.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom.
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom.
Chatflow IDDecimalTrueNoChatflow ID of the conversation associated to the submission
Chatflow nameStringTrueNoThe name of the chatflow associated to the submission
Chatflow object idDecimalTrueNoChatflow object id of the conversation associated to the submission
Contact first nameStringTrueNoFirst name of the contact associated with the submission
Contact IdDecimalTrueNoThe id of the contact most recently associated with this submission
Contact last nameStringTrueNoLast name of the contact associated with the submission
Conversation thread idDecimalTrueNoThread id of the conversation associated to the submission
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date_timeDatetimeTrueNoThe 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_timeDatetimeTrueNoMost 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 IDsStringTrueNoThe list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Read Only ObjectBoolTrueNoIs the object read only
Tag IDsStringTrueNoTag IDs assigned to this submission.
TagsStringTrueNoTags assigned to this submission.
Ticket idDecimalTrueNoID of the ticket associated with the submission
Ticket owner avatar uriStringTrueNoAvatar URI of the ticket associated to the feedback's owner
Ticket ownerDecimalTrueNoUser the ticket is assigned to which is associated to feedback submission
Ticket nameStringTrueNoShort summary of ticket associated with the submission
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner Assigned DateDatetimeTrueNoThe most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
OwnerStringFalseNoThe owner of the object.
HubSpot TeamStringTrueNoThe primary team of the owner.
Industry Standard Question TypeStringTrueNoIndustry standard question type for custom surveys
SentimentStringTrueNoThis column is a custom field. Sentiment of feedback submission based on survey type
Survey IDDecimalTrueNoThe survey id that the feedback submission is linked with
Survey TypeStringTrueNoThe type of the survey
SourceStringTrueNoThe channel of the survey when the feedback submission occurred
DateDatetimeTrueNoThe timestamp of the feedback submission
RatingDecimalTrueNoThe value of the feedback submission
Feedback sentimentStringTrueNoThe sentiment of the feedback submission
ResponseStringFalseNoThe follow_up response of the feedback submission
Ingestion idStringTrueNoThe identifier we use when we initially capture a feedback submission
Knowledge article idDecimalTrueNoThe id of the knowledge article this submission was for
Visitor idDecimalTrueNoThe id of the visitor who submitted this feedback
Engagement idDecimalTrueNoThe id of the equivalent engagement object
Submission URLStringTrueNoThe URL of the page the submission was made from
Survey NameStringTrueNoThe name of the feedback survey the submission is linked with
Form guidStringTrueNoThe form guid that the feedback submission is linked with
EmailStringTrueNoThe email of the contact associated with a feedback submission
Submission NameStringTrueNoThe email of the contact associated with a feedback submission

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongFalseNoFile ID.
NameStringFalseNoName of the file.
ExtensionStringFalseNoExtension of the file. For example png.
AccessStringFalseNoFile access.
CreatedAtDatetimeFalseNoCreation time of the file object.
UpdatedAtDatetimeFalseNoTimestamp of the latest update to the file.
ArchivedBoolFalseNoIf the file is deleted.
ArchivedAtDatetimeFalseNoDeletion time of the file object.
TypeStringFalseNoType of the file.
IsUsableInContentBoolFalseNoIndicates if the file should be used when creating new content like web pages.
EncodingStringFalseNoEncoding of the file.
SizeLongFalseNoSize in bytes of the file.
HeightIntFalseNoFor image and video files, the height of the content.
WidthIntFalseNoFor image and video files, the width of the content.
PathStringFalseNoPath of the file in the file manager.
ParentFolderIdLongFalseNoId of the folder the file is in.
UrlStringFalseNoURL of the given file. This URL can change depending on the domain settings of the account. Will use the select file hosting domain.
DefaultHostingUrlStringFalseNoDefault hosting URL of the file. This will use one of HubSpot's provided URLs to serve the file.
AllowsAnonymousAccessBoolFalseNoIf 'true' will show private files; if 'false' will show public files. The output will mirror the input value.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongFalseNoId of the folder.
NameStringFalseNoName of the folder.
PathStringFalseNoPath of the folder in the file manager.
ParentFolderIdLongFalseNoId of the parent folder.
CreatedAtDatetimeFalseNoTimestamp of folder creation.
UpdatedAtDatetimeFalseNoTimestamp of the latest update to the folder.
ArchivedBoolFalseNoMarks weather the folder is deleted or not.
ArchivedAtDatetimeFalseNoTimestamp of folder deletion.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoID of Marketing Form.
NameStringFalseNoThe title of the Form.
FormTypeStringFalseNoForm Type. Possible values: blog_comment, captured, hubspot, flow.
FieldGroupsStringFalseNoField Groups aggregate.
LanguageStringFalseNoLanguage.
CloneableBoolFalseNoCloneable.
EditableBoolFalseNoEditable.
ArchivableBoolFalseNoArchivable.
RecaptchaEnabledBoolFalseNoRecaptcha Enabled.
NotifyContactOwnerBoolFalseNoNotify Contact Owner.
NewContactNewEmailBoolFalseNoCreate new contact for new email.
PrePopulateBoolFalseNoPrepopulate known values.
AllowLinkToResetBoolFalseNoAllow link to reset known values.
RenderRawHtmlBoolFalseNoRender raw HTML.
ThemeStringFalseNoTheme.
SubmitButtonTextStringFalseNoSubmit Button Text.
CssClassStringFalseNoCSS Class.
StyleStringFalseNoForm Type.
CreatedAtDatetimeFalseNoWhen the meeting was created.
UpdatedAtDatetimeFalseNoWhen the meeting was last updated.
ArchivedBoolTrueNoDetermines whether the meeting is archived.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
MigrationSoftDeleteDeprecatedStringFalseNoDescribes if the goal target can be treated as deleted.
Ad account asset IDsStringFalseNoA list of ';'-separated universally unique IDs of ad accounts, each formatted: {AD_NETWORK}-{ACCOUNT_ID}
Ad campaign asset idsStringFalseNoA list of ';'-separated universally unique IDs of ad campaigns, each formatted: {NETWORK}-{CAMPAIGN_ID}
All teamsStringTrueNoThe team IDs, including up the team hierarchy, corresponding to all owner referencing properties for this object, both default and custom
Business unitsStringFalseNoThe business units this record is assigned to.
All owner idsStringTrueNoThe value of all owner referencing properties for this object, both default and custom.
Team idsStringFalseNoWhich team owns the goal (there should only ever be one team)
Assignee team IDDecimalFalseNoThe team ID of the assigned team of the goal (unpopulated if the goal is not team-assigned or team-by-user-assigned)
Assignee user IDDecimalFalseNoThe user ID of the assigned user of the goal (unpopulated if the goal is not user-assigned)
Campaign asset idsStringFalseNoList of marketing campaign asset ids
Contact lifecycle stageStringFalseNoThe lifecycle stage selected for the contact lifecycle goal
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date/timeDatetimeTrueNoThe date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
currencyStringFalseNoDEPRECATED - DO NOT USE! Code for the currency conversion
Currency Exchange RateDecimalFalseNoExchange 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 pipelinesStringFalseNoA serialized list of DEAL pipeline IDs used to filter the KPI value calculation.
Edit updates notification frequencyStringFalseNoThe frequency of goal edit update notifications
End dateDateFalseNoThe last day covered by the Goal Target's date range.
End datetimeDatetimeFalseNoThe last day covered by the Goal Target's date range.
Fiscal year offsetDecimalFalseNoRepresents the number of months the fiscal year is away from a standard calendar year (0 means the fiscal year starts in January).
Goal nameStringFalseNoThe name of the goal.
Goal target currency codeStringFalseNoCurrency code for the goal target
Goal Target Group IDDecimalFalseNoObject ID of the associated Goal Target Group
Goal typeStringFalseNoThe goal type
Group correlation UUIDStringFalseNoUnique ID set on all Goal Targets and Goal Target Groups created by a single request
Is forecastableStringFalseNoREAD 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!
IsLegacyStringFalseNoDescribes if the object was created during the migration process and it comes from the old app.
KPI Display UnitStringFalseNoDisplay units for goals based on duration properties
KpiFilterGroupsStringFalseNoFilter groups for KPI calculations
KPI is team rollupBoolFalseNoIndicates whether this is a rollup goal: whether the KPI allows contributions from child teams (in addition to the assigned team)
KpiMetricTypeStringFalseNoType of metric used to aggregate the property name
KpiObjectTypeStringFalseNoThe name of the CrmObject the KPI values are based on
Kpi object type idStringFalseNoThe ObjectTypeId of the object the KPI values are based on
KpiPropertyNameStringFalseNoName of the property on the object type aggregated as the KPI value.
KpiSingleObjectCustomGoalTypeNameStringFalseNoSingle object custom goal components (metric type, object type, property name)
KpiTimePeriodPropertyStringFalseNoTime period property
KpiTrackingMethodStringFalseNoTracking method for progress directionality
Kpi unit typeStringFalseNoUnit type of the kpi calculation
KPI valueDecimalFalseNoThe latest KPI value for this goal target
KPI value calculated atDecimalFalseNoThe time that latest KPI value was calculated
KPI value last calculated atDatetimeFalseNoThe time that latest KPI value was calculated
Object last modified date/timeDatetimeTrueNoMost 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.
LegacyActiveStringFalseNoMigrated value describing if the goal is active or soft deleted.
LegacyCreatedAtDecimalFalseNoMigrated value of created at.
LegacyCreatedByDecimalFalseNoMigrated value of created by.
LegacyQuarterlyTargetCompositeIdStringFalseNoConcatenated 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.
LegacySqlIdDecimalFalseNoId of the migrated goal target in the old system. This has been deprecated for legacy_unique_sql_id.
LegacyUniqueSqlIdDecimalFalseNoId of the migrated goal target in the old system. This property has a unique value to ensure no duplicate migrated goals.
LegacyUpdatedAtDecimalFalseNoMigrated value of updated at.
LegacyUpdatedByDecimalFalseNoMigrated value of updated by.
Merged record IDsStringTrueNoThe list of record IDs that have been merged into this record. This value is automatically set by HubSpot and may not be modified.
MigrationSoftDeleteStringFalseNoDescribes if the goal target can be treated as deleted.
MilestoneStringFalseNoThe period during which a Goal Target is active
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Record Creation SourceStringTrueNoSource (PropertySource) that created this object record
Record Creation Source IDStringTrueNoThe sourceId -- further detail -- of the source that created this object record
Record Creation Source User IDDecimalTrueNoUser ID of the user who initiated creation of this object record
OutcomeStringFalseNoGoal Target outcome
Owner ids of all ownersStringFalseNoThe owner IDs of all owners of this object
Participant typeStringFalseNoThe type of participant for the Goal Target
Pipeline idsStringFalseNoList of deal pipelines that the quota applies to. Used to calculate kpi values
PipelinesStringFalseNoA serialized list of pipeline IDs used to filter the KPI value calculation
Progress updates notification frequencyStringFalseNoThe frequency of goal progress update notifications
Read Only ObjectBoolTrueNoIs the object read only
Notify on goal achievedStringFalseNoOpt into notifications when goal is achieved
Notify with goal edit updatesStringFalseNoOpt into goal edit update notifications
Notify on goal exceededStringFalseNoOpt into notifications when goal is exceeded
Notify on goal kickoffStringFalseNoOpt into notifications when a goal is kicked off
Notify on goal missedStringFalseNoOpt into notifications when a goal is missed
Notify with progress updatesStringFalseNoOpt into goal progress updates notifications
ShouldRecalculateStringFalseNoProperty used to flag Goal targets that need to be recalculated
Start datetimeDatetimeFalseNoThe first day that goal target's date range covers
Static KPI Filter GroupsStringFalseNoGoal Target Filter Group(s) for all filters except time-based filters
StatusStringFalseNoThe status of the Goal Target
Status display orderDecimalTrueNoThe goal status display order.
Target amountDecimalFalseNoThe target amount for this goal target
Target amount in company currencyDecimalTrueNoThe amount of the goal target, using the exchange rate, in your company's currency
Team IDDecimalFalseNoThe team ID associated with the Goal Target
Ticket pipelinesStringFalseNoA serialized list of TICKET pipeline IDs used to filter the KPI value calculation.
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDDecimalFalseNoThe user ID associated with the Goal Target
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Performed in an importBoolTrueNoObject is part of an import
Owner Assigned DateDatetimeTrueNoThe most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
OwnerStringFalseNoThe owner of the object.
HubSpot TeamStringTrueNoThe primary team of the owner.
Start dateDateFalseNoThe first day that goal target's date range covers
Kpi progress percentDecimalTrueNoProgress percent is represented by the kpi value as a percent of the target amount

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueLeads.IdNoLeads ID
AssociationId [KEY]LongFalseNoID of the object that this Leads object is associated with.
Type [KEY]StringFalseNoType of the associated object, which can be a contact, deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identified of the pipeline.
LabelStringFalseNoThe label (name) of the pipeline.
ArchivedBoolTrueNoWhether the pipeline is archived or not.
CreatedAtDatetimeTrueNoWhen the pipeline was created.
UpdatedAtDatetimeTrueNoWhen the pipeline was last updated.
DisplayOrderIntFalseNoThe order of this specific pipeline in the collection of pipelines for this table.
StagesAggregateStringFalseNoAn aggregate of the stages included in this pipeline. This information can be viewed in more detail in LeadPipelineStages table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoUnique identifier of the stage in the pipeline.
PipelineId [KEY]StringFalseLeadPipelines.IdNoUnique identifier of the pipeline.
LabelStringFalseNoLabel (name) of the pipeline stage.
PipelineLabelStringFalseLeadPipelines.LabelNoThe label (name) of the pipeline.
IsClosedBoolFalseNoWhether this stage is open or closed.
StateStringFalseNoCurrent state of the pipeline stage.
ArchivedBoolTrueNoWhether the stage is archived or not.
CreatedAtDatetimeTrueNoTime the stage was created.
UpdatedAtDatetimeTrueNoTime the stage was last updated.
DisplayOrderIntFalseNoThe order of the stage in the collection of stages for this pipeline.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
HasUniqueValueBoolFalseNoBoolean indicating if the value of the property is unique.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PropertyNameStringTrueNoThe name of the property.
ValueStringTrueNoThe historical value of the property.
SourceTypeStringTrueNoThe method by which the property was changed.
SourceIdStringTrueNoAdditional data related to the source. May not be populated for all sources.
TimestampDatetimeTrueNoDatetime when the property was updated.
LeadIdLongTrueNoThe lead identifier.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property group.
LabelStringFalseNoThe label of the group.
DisplayOrderIntFalseNoThe numerical order of the group with respect to other groups.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
All teamsStringTrueNoThe team IDs, including up the team hierarchy, corresponding to all owner referencing properties for this object, both default and custom
Business unitsStringFalseNoThe business units this record is assigned to.
All owner idsStringTrueNoThe value of all owner referencing properties for this object, both default and custom.
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object, both default and custom.
Associated Company DomainStringTrueNoDomain of the associated company if present.
Associated Company NameStringTrueNoName of the associated company if present.
Associated Contact EmailStringTrueNoEmail of the associated contact if present.
Associated Contact First NameStringTrueNoFirst name of the associated contact if present.
Associated Contact Last NameStringTrueNoLast name of the associated contact if present.
Calls Connected CountDecimalTrueNoThe number of associated calls that are considered to be 'connected'
Primary company analytics sourceStringTrueNoThe 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 drilldownStringTrueNoThe 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 drilldownStringTrueNoThe 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 keyStringTrueNoThe path in the FileManager CDN for the lead's primary company's avatar override image.
Is Target AccountStringTrueNoAssociated company's status about being marketed or sold to.
Company Last Activity DateDatetimeTrueNoThe date of the last activity, rolled up from the primary associated company.
Company Last Engagement DateDatetimeTrueNoThe 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 TypeStringTrueNoThe type of the last engagement a company performed. This doesn't include marketing emails or emails to multiple contacts.
Company Time of Last SessionDatetimeTrueNoTime of the last session attributed to any contacts that are associated with this lead's primary company
Company Next Activity DateDatetimeTrueNoThe date of the next activity, rolled up from the primary associated company.
Company Next Activity TypeStringTrueNoThe type of the next activity, rolled up from the primary associated company.
Company Number of PageviewsDecimalTrueNoTotal number of page views across all contacts associated with this lead's primary company
Associated company timezoneStringTrueNoThe associated company's timezone, if present.
Primary contact analytics sourceStringTrueNoThe 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 drilldownStringTrueNoThe 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 drilldownStringTrueNoThe 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 keyStringTrueNoThe path in the FileManager CDN for the lead's primary contact's avatar override image.
Contact Buying RoleStringTrueNoAssociated contact's role during the sales process.
Associated contact job titleStringTrueNoJob title of the associated contact if present.
Contact Last Activity DateDatetimeTrueNoThe date of the last activity, rolled up from the primary associated contact.
Contact Last Engagement DateDatetimeTrueNoThe 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 TypeStringTrueNoThe type of the last engagement a contact performed. This doesn't include marketing emails or emails to multiple contacts.
Contact Time of Last SessionDatetimeTrueNoTimestamp for start of the most recent session for this lead's primary contact to your website.
Contact Next Activity DateDatetimeTrueNoThe date of the next activity, rolled up from the primary associated contact.
Contact Next Activity TypeStringTrueNoThe type of the next activity, rolled up from the primary associated contact.
Contact Number of PageviewsDecimalTrueNoTotal number of page views this lead's primary contact has had on your website
Associated contact timezoneStringTrueNoThe associated contact's timezone, if present.
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date/timeDatetimeTrueNoThe date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Emails Connected CountDecimalTrueNoThe number of associated emails that are considered to be 'connected'
Initial Assign Notification StateStringTrueNoDetermines the status of sending the initial lead assign notification upon object creation
Last Activity DateDatetimeTrueNoThe 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 DateDatetimeTrueNoIf 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 TypeStringTrueNoIf 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 SessionDatetimeTrueNoIf 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/timeDatetimeTrueNoMost 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 StageStringTrueNoThe pipeline stage of the primary associated deal
Associated dealsDecimalTrueNoNumber of associated deals for a given lead.
Call CountDecimalTrueNoThe number of calls made to this lead
Closed won deal amountDecimalTrueNoThe total amount of the lead's associated deals that are closed-won
Message Thread CountDecimalTrueNoThe number of message threads (SMS, LinkedIn, WhatsApp) opened with this lead
CurrencyStringTrueNoCurrency code for most recent associated deal
Lead Disqualification NoteStringFalseNoA note on why the lead was disqualified
Disqualification ReasonStringFalseNoDropdown list of reasons for disqualification
Email CountDecimalTrueNoThe number of emails sent to this lead
First Outreach DateDatetimeTrueNoThe date of the first outreach (call, email, meeting or other communication) from the sales rep to the lead.
Lead Inferred PseudostageStringTrueNoThis indicates the inferred lead pipeline pseudostage based on underlying activities taken by the user or lead.
Is DisqualifiedDecimalTrueNoIndicates 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 leadsDecimalTrueNoIndicates 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 NewDecimalTrueNoIndicates 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 leadsDecimalTrueNoWhether the lead's pipeline stage has any category other than QUALIFIED or UNQUALIFIED
Is QualifiedDecimalTrueNoIndicates 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 LabelStringFalseNoCurrent status of a given lead
Meeting CountDecimalTrueNoThe number of meetings booked with this lead
Lead NameStringFalseNoThe full name of the lead.
Lead name calculatedStringTrueNoThe calculated full name of the lead.
Outreach activity countDecimalTrueNoThe total number of outreach activities (call, email, meeting or other communication) from the sales rep to the lead.
Open deal amountDecimalTrueNoThe total value of any open deals associated with this lead
Primary Company OwnerStringTrueNoThe owner ID of the associated primary company
Primary Contact OwnerStringTrueNoThe owner ID of the associated primary contact
Lead SourceStringTrueNoThe analytics source of the lead, inherited from primary associated contact or company at the time of lead creation
Initial company lifecycle stageStringTrueNoThe 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 stageStringTrueNoThe 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 1StringTrueNoSecond tier of specificity on the lead source
Lead Source DrillDown 2StringTrueNoThird tier of specificity on the lead source
Initial source lifecycle stageStringTrueNoThe lifecycle stage of the primary associated contact or company at the time of lead creation
Time to First TouchDecimalTrueNoTime between lead creation and first outreach activity
Lead Title (DEPRECATEDUse hsLeadName)StringTrueNoThe title of the lead
Lead TypeStringFalseNoThe type of lead. By default, categorize your lead as either a New Business, Existing Business, or Re-attempting
Meetings Connected CountDecimalTrueNoThe number of associated meetings that are considered to be 'connected'
Merged record IDsStringTrueNoThe 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 DateDatetimeTrueNoThe 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 TypeStringTrueNoThe 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 PageviewsDecimalTrueNoNumber of pageviews for the associated contact if it exists. Otherwise the number of pageviews for the associated company.
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Record Creation SourceStringTrueNoRaw internal propertySource present in the RequestMeta when this record was created
Record Source Detail 1StringTrueNoFirst level of detail on how this record was created
Record Source Detail 2StringTrueNoSecond level of detail on how this record was created
Record Source Detail 3StringTrueNoThird level of detail on how this record was created
Record Creation Source IDStringTrueNoRaw internal sourceId present in the RequestMeta when this record was created
Record SourceStringTrueNoHow this record was created
Record Creation Source User IDDecimalTrueNoRaw internal userId present in the RequestMeta when this record was created
Lead owner calculatedStringTrueNoThe calculated owner of the lead. Owner of the primary contact if it exists, owner of primary company otherwise.
Lead PipelineStringFalseNoThe pipeline that the lead is in
Lead Pipeline StageStringFalseNo
Pipeline Stage CategoryStringTrueNoThe category assigned to the lead's current pipeline stage
Pipeline Stage Category Last Updated AtDatetimeTrueNoTimestamp of the most recent update to the lead's pipeline stage category
Primary Associated Object NameStringTrueNoThe primary associated contact or company name
Primary Associated Company Object IDDecimalFalseNoThe object ID of the primary associated company
Primary contact enrolled in sequenceBoolTrueNoIndicates whether the lead's primary contact is currently enrolled in a sequence
Primary Associated Contact Object IDDecimalFalseNoThe object ID of the primary associated contact
Read Only ObjectBoolTrueNoIs the object read only
Shared Team IDsStringTrueNoThe team IDs of all teams that have shared access to this object
Shared User IDsStringTrueNoThe user IDs of all users that have shared access to this object
Lead tagsStringTrueNoList of tag ids applicable to a lead. This property is set automatically by HubSpot.
Time in 'Attempting (Lead pipeline)'DecimalTrueNoThe total time in seconds spent by the lead in the 'Attempting' stage, 'Lead pipeline' pipeline
Time in 'Connected (Lead pipeline)'DecimalTrueNoThe total time in seconds spent by the lead in the 'Connected' stage, 'Lead pipeline' pipeline
Time in 'New (Lead pipeline)'DecimalTrueNoThe total time in seconds spent by the lead in the 'New' stage, 'Lead pipeline' pipeline
Time in 'Qualified (Lead pipeline)'DecimalTrueNoThe total time in seconds spent by the lead in the 'Qualified' stage, 'Lead pipeline' pipeline
Time in 'Disqualified (Lead pipeline)'DecimalTrueNoThe total time in seconds spent by the lead in the 'Disqualified' stage, 'Lead pipeline' pipeline
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Cumulative time in Attempting (Lead pipeline)DecimalTrueNoThe cumulative time in seconds spent by the lead in the 'Attempting' stage, 'Lead pipeline' pipeline
Cumulative time in Connected (Lead pipeline)DecimalTrueNoThe cumulative time in seconds spent by the lead in the 'Connected' stage, 'Lead pipeline' pipeline
Cumulative time in New (Lead pipeline)DecimalTrueNoThe cumulative time in seconds spent by the lead in the 'New' stage, 'Lead pipeline' pipeline
Cumulative time in Qualified (Lead pipeline)DecimalTrueNoThe cumulative time in seconds spent by the lead in the 'Qualified' stage, 'Lead pipeline' pipeline
Cumulative time in Disqualified (Lead pipeline)DecimalTrueNoThe cumulative time in seconds spent by the lead in the 'Disqualified' stage, 'Lead pipeline' pipeline
Date entered Attempting (Lead pipeline)DatetimeTrueNoThe date and time when the lead entered the 'Attempting' stage, 'Lead pipeline' pipeline
Date entered Connected (Lead pipeline)DatetimeTrueNoThe date and time when the lead entered the 'Connected' stage, 'Lead pipeline' pipeline
Date entered New (Lead pipeline)DatetimeTrueNoThe date and time when the lead entered the 'New' stage, 'Lead pipeline' pipeline
Date entered Qualified (Lead pipeline)DatetimeTrueNoThe date and time when the lead entered the 'Qualified' stage, 'Lead pipeline' pipeline
Date entered Disqualified (Lead pipeline)DatetimeTrueNoThe date and time when the lead entered the 'Disqualified' stage, 'Lead pipeline' pipeline
Date exited Attempting (Lead pipeline)DatetimeTrueNoThe date and time when the lead exited the 'Attempting' stage, 'Lead pipeline' pipeline
Date exited Connected (Lead pipeline)DatetimeTrueNoThe date and time when the lead exited the 'Connected' stage, 'Lead pipeline' pipeline
Date exited New (Lead pipeline)DatetimeTrueNoThe date and time when the lead exited the 'New' stage, 'Lead pipeline' pipeline
Date exited Qualified (Lead pipeline)DatetimeTrueNoThe date and time when the lead exited the 'Qualified' stage, 'Lead pipeline' pipeline
Date exited Disqualified (Lead pipeline)DatetimeTrueNoThe date and time when the lead exited the 'Disqualified' stage, 'Lead pipeline' pipeline
Latest time in Attempting (Lead pipeline)DecimalTrueNoThe 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)DecimalTrueNoThe 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)DecimalTrueNoThe 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)DecimalTrueNoThe 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)DecimalTrueNoThe total time in seconds spent by the lead in the 'Disqualified' stage, 'Lead pipeline' pipeline since it last entered this stage
Performed in an importBoolTrueNoObject is part of an import
Workflow updated lifecycle stage of companyBoolFalseNoIndicates whether a workflow updated the lifecycle stage of the lead's associated company.
Workflow updated lifecycle stage of contactBoolFalseNoIndicates whether a workflow updated the lifecycle stage of the lead's associated contact.
Owner Assigned DateDatetimeTrueNoThe 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 OwnerStringFalseNoOwner 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 TeamStringTrueNoThe primary team of the owner.
lead custom fieldStringFalseNoThis column is a custom field. desc

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueLineitems.IdNoLineitems ID
AssociationId [KEY]LongFalseNoID of the object that this Lineitems object is associated with.
Type [KEY]StringFalseNoType of the associated object* which can be a contact* deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
Net priceDecimalTrueNoThe amount of a line item
Create DateDatetimeFalseNoThe date the line item was created
DescriptionStringFalseNoFull description of product
Unit discountDecimalFalseNoThe discount amount applied
Annual contract valueDecimalTrueNoThe annual contract value ACV of this product
All accessible team IDsStringTrueNoThe team IDs* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom
Business unitsStringFalseNoThe business units this record is assigned to.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom.
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom.
Allow buyer selected quantityStringTrueNoWhether buyer selected quantity is to be enabled or not for a LineItem
Annual recurring revenueDecimalTrueNoThe annual recurring revenue ARR of this product
Delayed billing start by daysDecimalFalseNoNumber of days billing should be delayed by. It allows the customers to start billing sometime in the future
Delayed billing start by monthsDecimalFalseNoNumber of months billing should be delayed by. It allows the customers to start billing sometime in the future.
Start billing termsStringTrueNoThe type of billing start delay. It can be a fixed date in the future_ relative delay in number of days or months
Unit costDecimalFalseNoThe amount that sold goods cost the HubSpot customer
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date_timeDatetimeTrueNoThe date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Discount PercentageDecimalFalseNoThe discount percentage applied
External LineItem idDecimalTrueNoThe ID of a line item
Image URLStringFalseNoProduct images.
Last Modified DateDatetimeTrueNoThe date any property on this product was modified
CurrencyStringFalseNoCurrency code for the line item.
MarginDecimalTrueNoThe margin value of this product
Annual contract value marginDecimalTrueNoThe margin annual contract value of this product
Annual recurring revenue marginDecimalTrueNoThe margin annual recurring revenue of this product
Monthly recurring revenue marginDecimalTrueNoThe margin monthly recurring revenue of this product
Total contract value marginDecimalTrueNoThe margin total contract value of this product
Merged object IDsStringTrueNoThe 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 revenueDecimalTrueNoThe monthly recurring revenue MRR of this product
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Position on quoteDecimalFalseNoThe order which the line item appears on the quotes
Pre Discount AmountDecimalTrueNoThe pre_discount amount of a line item
Product IDDecimalFalseNoID of the product this was copied from
Read Only ObjectBoolTrueNoIs the object read only
End DateDateTrueNoRecurring billing end date for a line item
Number of paymentsDecimalTrueNoNumber of payments for the given period on a Line Item
TermStringFalseNoProduct recurring billing duration
Billing start dateDateFalseNoRecurring billing start date for a line item
Billing termsStringTrueNoIf there are fixed number payments or it goes on until cancelled
SKUStringFalseNoUnique product identifier
Sync amountDecimalTrueNoThe amount set by Ecommerce sync
Total contract valueDecimalTrueNoThe total contract value TCV of this product
Term in monthsDecimalTrueNoThe number of months in the term of this product
Calculated Total DiscountDecimalTrueNoCalculated total Discount for the line item taking in consideration the flat amount and discount percentage.
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
URLStringFalseNoProduct url.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Variant id of the productDecimalTrueNoVarient id of the shopify product
Owner Assigned DateDatetimeTrueNoThe most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
OwnerStringFalseNoThe owner of the object.
HubSpot TeamStringTrueNoThe primary team of the owner.
NameStringFalseNoProduct name
Unit priceDecimalFalseNoCost of product
QuantityDecimalFalseNoHow many units of a product are in this line item
Billing frequencyStringFalseNoHow 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.
TaxDecimalFalseNoThe tax amount applied

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoMeetings ID
AssociationId [KEY]LongFalseNoID of the object that this Meetings object is associated with.
Type [KEY]StringFalseNoType of the associated object, which can be a contact, deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongFalseNoNotes ID
AssociationId [KEY]LongFalseNoID of the object that this Notes object is associated with.
Type [KEY]StringFalseNoType of the associated object, which can be a contact, deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueOrders.IdNoOrders ID
AssociationId [KEY]LongFalseNoID of the object that this Orders object is associated with.
Type [KEY]StringFalseNoType of the associated object* which can be a contact* Order etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identified of the pipeline.
LabelStringFalseNoThe label (name) of the pipeline.
ArchivedBoolTrueNoWhether the pipeline is archived or not.
CreatedAtDatetimeTrueNoWhen the pipeline was created.
UpdatedAtDatetimeTrueNoWhen the pipeline was last updated.
DisplayOrderIntFalseNoThe order of this specific pipeline in the collection of pipelines for this table.
StagesAggregateStringFalseNoAn aggregate of the stages included in this pipeline. This information can be viewed in more detail in OrderPipelineStages table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoUnique identifier of the stage in the pipeline.
PipelineId [KEY]StringFalseOrderPipelines.IdNoUnique identifier of the pipeline.
LabelStringFalseNoLabel (name) of the pipeline stage.
PipelineLabelStringTrueOrderPipelines.LabelNoThe label (name) of the pipeline.
IsClosedBoolFalseNoWhether this stage is open or closed.
StateStringFalseNoCurrent state of the pipeline stage.
ArchivedBoolTrueNoWhether the stage is archived or not.
CreatedAtDatetimeTrueNoTime the stage was created.
UpdatedAtDatetimeTrueNoTime the stage was last updated.
DisplayOrderIntFalseNoThe order of the stage in the collection of stages for this pipeline.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
HasUniqueValueBoolFalseNoBoolean indicating if the value of the property is unique.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PropertyNameStringTrueNoThe name of the property.
ValueStringTrueNoThe historical value of the property.
SourceTypeStringTrueNoThe method by which the property was changed.
SourceIdStringTrueNoAdditional data related to the source. May not be populated for all sources.
TimestampDatetimeTrueNoDatetime when the property was updated.
OrderIdLongTrueNoThe order identifier.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property group.
LabelStringFalseNoThe label of the group.
DisplayOrderIntFalseNoThe numerical order of the group with respect to other groups.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
All teamsStringTrueNoThe team IDs, including up the team hierarchy, corresponding to all owner referencing properties for this object, both default and custom
Business unitsStringFalseNoThe business units this record is assigned to.
All owner idsStringTrueNoThe value of all owner referencing properties for this object, both default and custom.
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object, both default and custom.
Billing CityStringFalseNoThe city for the billing address.
Billing CountryStringFalseNoThe country for the billing address.
Billing EmailStringFalseNoCustomer's email from billing information
Billing First NameStringFalseNoCustomer's first name from billing information
Billing Last NameStringFalseNoCustomer's last name from billing information
Billing Phone NumberStringFalseNoThe phone number for the billing address.
Billing ZIP/Postal CodeStringFalseNoThe ZIP/postal code for the billing address.
Billing StateStringFalseNoThe state for the billing address.
Billing StreetStringFalseNoThe street for the billing address.
Buyer Accepts MarketingBoolFalseNoIndicates if the customer has opted in/out of receiving marketing emails.
Cancellation ReasonStringFalseNoThe reason given for cancelling the order.
Closed DateDatetimeTrueNoDate when the order was closed, null otherwise, set automatically
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date/timeDatetimeTrueNoThe date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Currency CodeStringFalseNoThe currency code used in the order.
Customer PhoneStringFalseNoPhone number of Customer placing the Order
Date entered 'Stage 1 (Pipeline 1)'DatetimeTrueNoThe date and time when the order entered the 'Stage 1' stage, 'Pipeline 1' pipeline
Date exited 'Stage 1 (Pipeline 1)'DatetimeTrueNoThe date and time when the order exited the 'Stage 1' stage, 'Pipeline 1' pipeline
Discount CodesStringFalseNoDiscount Codes on an order.
Exchange rateDecimalFalseNoThis is the exchange rate used to convert the cart amount into your company currency.
Canceled DateDatetimeFalseNoDate the order is canceled.
Cart IDStringFalseNoUnique identifier in an external system for the cart associated with the order.
Checkout IDStringFalseNoUnique identifier in an external system for the checkout associated with the order.
Created DateDatetimeFalseNoDate the order is created.
Modified DateDatetimeFalseNoMost recent order modified date.
Order IDStringFalseNoUnique identifier in an external system for the order.
StatusStringFalseNoCurrent status of the order as recorded on the source system.
Order URLStringFalseNoAn URL that links to an external site where the orders details can be viewed.
Fulfillment StatusStringFalseNoCurrent fulfillment/shipping status of the order.
Amount in company currencyDecimalFalseNoThe amount of the order, using the exchange rate, in your company's currency
Landing SiteStringFalseNoThe URL of the first page on the sellers site that the customer landed on prior to them placing the order.
Object last modified date/timeDatetimeTrueNoMost 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 IDsStringTrueNoThe list of record IDs that have been merged into this record. This value is automatically set by HubSpot and may not be modified.
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Record Creation SourceStringTrueNoRaw internal propertySource present in the RequestMeta when this record was created
Record Source Detail 1StringTrueNoFirst level of detail on how this record was created
Record Source Detail 2StringTrueNoSecond level of detail on how this record was created
Record Source Detail 3StringTrueNoThird level of detail on how this record was created
Record Creation Source IDStringTrueNoRaw internal sourceId present in the RequestMeta when this record was created
Record SourceStringTrueNoHow this record was created
Record Creation Source User IDDecimalTrueNoRaw internal userId present in the RequestMeta when this record was created
DiscountDecimalFalseNoTotal Discount on an order as an amount.
NameStringFalseNoUnique ID as represented by a number.
NotesStringFalseNoA block of text associated with the order.
Payment Processing MethodStringFalseNoType of payment processing method.
Payment StatusStringFalseNoCurrent Payment status of the order.
Pinned engagement IDDecimalFalseNoThe object ID of the current pinned engagement. This will only be shown if there is already an association to the engagement.
PipelineStringFalseNoThe pipeline that contains this order
StageStringFalseNoThe order pipeline stage.
Processed DateDatetimeFalseNoThe date/time the order was imported into HubSpot.
Read Only ObjectBoolTrueNoIs the object read only
Referring SiteStringFalseNoThe URL of the site that the customer came from to arrive at the sellers site prior to placing their order.
Refund AmountDecimalFalseNoRefunded amount, if any, associated with an order.
Shared Team IDsStringTrueNoThe team IDs of all teams that have shared access to this object
Shared User IDsStringTrueNoThe user IDs of all users that have shared access to this object
Shipping CityStringFalseNoThe city for the shipping address.
Shipping CountryStringFalseNoThe country for the shipping address.
Shipping Phone NumberStringFalseNoThe phone number for the shipping address.
Shipping ZIP/Postal CodeStringFalseNoThe ZIP/postal code for the shipping address.
Shipping StateStringFalseNoThe state for the shipping address.
Shipping StreetStringFalseNoThe street for the shipping address.
Shipping CostDecimalFalseNoThe base cost (i.e. undiscounted), in the orders associated currency, associated with shipping the order.
Shipping Status URLStringFalseNoURL to Shipping status for the order.
Shipping Tracking NumberStringFalseNoList of Shipment tracking IDs associated with the order.
Source IDDecimalTrueNoHubSpot developer App ID from where this order data is first synced.
Source StoreStringFalseNoData used to identify which store the order came from.
Subtotal PriceDecimalFalseNoTotal order amount before discounts, tax, duties etc.
TagsStringFalseNoA collection of tag strings associated with the order.
Tax PriceDecimalFalseNoTax amount associated with the order, including duties.
Time in 'Stage 1 (Pipeline 1)'DecimalTrueNoThe total time in seconds spent by the order in the 'Stage 1' stage, 'Pipeline 1' pipeline
Total PriceDecimalFalseNoSum Total amount associated with this order.
Total WeightStringFalseNoThe total weight of the order for shipping purposes.
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Performed in an importBoolTrueNoObject is part of an import
Owner Assigned DateDatetimeTrueNoThe most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
OwnerStringFalseNoThe owner of the object.
HubSpot TeamStringTrueNoThe primary team of the owner.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongFalseNoOwner ID
FirstNameStringFalseNoFirst name of the owner.
LastNameStringFalseNoLast name of the owner.
UserIdStringFalseNoUser id of the owner.
EmailStringFalseNoEmail of the owner.
TeamsStringFalseNoTeams of the owner.
CreatedAtDatetimeFalseNoCreated date time.
UpdatedAtDatetimeFalseNoUpdated date time.
ArchivedBoolFalseNoWeather or not is archived.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
WorkflowIdLongTrueWorkflows.IdNoThe id of the Workflow.
SeriesStringTrueNoType of series for Workflow
BucketDateTrueNoBucket of the Workflow
TimePeriodStringTrueNoThe time period used to group the data. Must be one of DAY, WEEK, or MONTH
FrequencyIntegerTrueNoFrequency of the Workflow
StartDateDatetimeTrueNoThe start date for the data you want.
EndDateDatetimeTrueNoThe end date for the data you want.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
PropertiesStringTrueNoAn aggregate of the properties defined for a given object type.
All teamsStringTrueNoThe team IDs, including the team hierarchy, of all default and custom owner properties for this record.
Business unitsStringFalseNoThe business units this record is assigned to.
All owner IDsStringTrueNoValues of all default and custom owner properties for this record.
All team IDsStringTrueNoThe team IDs of all default and custom owner properties for this record.
AtMentioned Owner IdsStringFalseNoThe owners that have been at-mentioned on the engagement
Attached file IDsStringFalseNoThe IDs of the files that are attached to the postal mail
Body previewStringTrueNoA truncated preview of the engagement body
HTML Body PreviewStringTrueNoThe HTML representation of the engagement body preview
Body Preview TruncatedBoolTrueNoIndicates if the engagement body was truncated for the preview
Activity created byDecimalTrueNoThe user who created the postal mail
Created by user IDDecimalTrueNoThe user who created this record. This value is set automatically by HubSpot.
Object create date/timeDatetimeTrueNoThe date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Engagement SourceStringFalseNoThe source that created this engagement
Engagement Source IDStringFalseNoThe specific ID of the process that created this engagement
GDPR deletedBoolTrueNoIndicates the body of this engagement has been cleared because of a GDPR delete request
Object last modified date/timeDatetimeTrueNoMost 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 IDsStringTrueNoThe list of record IDs that have been merged into this record. This value is set automatically by HubSpot.
Updated byDecimalTrueNoThe user who last updated the postal mail
Record IDDecimalTrueNoThe unique ID for this record. This value is set automatically by HubSpot.
Record creation sourceStringTrueNoRaw internal PropertySource present in the RequestMeta when this record was created.
Record source detail 1StringTrueNoFirst level of detail on how this record was created.
Record source detail 2StringTrueNoSecond level of detail on how this record was created.
Record source detail 3StringTrueNoThird level of detail on how this record was created.
Record creation source IDStringTrueNoRaw internal sourceId present in the RequestMeta when this record was created.
Record sourceStringTrueNoHow this record was created.
Record creation source user IDDecimalTrueNoRaw internal userId present in the RequestMeta when this record was created.
Postal Mail BodyStringFalseNoBody text of the postal mail
Postal Mail TypeStringFalseNoCategory of postal mail, as defined by the user
Queue MembershipsStringFalseNoThe list of queues that contain this engagement
Read only objectBoolTrueNoDetermines whether a record can be edited by a user.
Shared teamsStringTrueNoAdditional teams whose users can access the record based on their permissions. This can be set manually or through Workflows or APIs.
Shared usersStringTrueNoAdditional users that can access the record based on their permissions. This can be set manually or through Workflows and APIs.
Activity dateDatetimeFalseNoThe date that an engagement occurred
Unique creation keyStringTrueNoUnique property used for idempotent creates
Unique IDStringFalseNoThe unique ID of the engagement
Updated by user IDDecimalTrueNoThe user who last updated this record. This value is set automatically by HubSpot.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt-in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt-out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this record.
Performed in an importBoolTrueNoObject is part of an import
Owner assigned dateDatetimeTrueNoThe most recent timestamp of when an owner was assigned to this record. This value is set automatically by HubSpot.
OwnerStringFalseNoThe owner of the object.
Owner's main teamStringTrueNoThe main team of the record owner. This value is set automatically by HubSpot.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueProducts.IdNoProducts ID
AssociationId [KEY]LongFalseNoID of the object that this Products object is associated with.
Type [KEY]StringFalseNoType of the associated object, which can be a contact, deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
Net priceDecimalTrueNoInternal placeholder to prevent conflicts with line item property of same name
Create DateDatetimeFalseNoThe date the product was created
Product descriptionStringFalseNoFull description of product
Unit discountDecimalFalseNoThe discount amount applied
All accessible team IDsStringTrueNoThe team IDs* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom
Business unitsStringFalseNoThe business units this record is assigned to.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom.
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom.
Avatar FileManager keyStringTrueNoThe path in the FileManager CDN for this product's image. Automatically set by HubSpot.
Unit costDecimalFalseNoThe amount that sold goods cost the HubSpot customer
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Object create date_timeDatetimeTrueNoThe date and time at which this object was created. This value is automatically set by HubSpot and may not be modified.
Discount PercentageDecimalFalseNoThe discount percentage applied
Folder IdDecimalFalseNoThe ID of the folder that has this product
Image UrlStringFalseNoProduct images.
Last Modified DateDatetimeTrueNoThe date any property on this product was modified
Merged object IDsStringTrueNoThe list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Product TypeStringFalseNoThe type of product. By default* categorize your product as either Inventory* Non_Inventory or Service.
Read Only ObjectBoolTrueNoIs the object read only
TermStringFalseNoProduct recurring billing duration
Start DateDateFalseNoRecurring billing start date for a line item
SKUStringFalseNoUnique product identifier
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
URLStringFalseNoProduct url.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner Assigned DateDatetimeTrueNoThe most recent date an owner was assigned to this object. This is set automatically by HubSpot and can be used for segmentation and reporting.
OwnerStringFalseNoThe owner of the object.
HubSpot TeamStringTrueNoThe primary team of the owner.
NameStringFalseNoProduct name
Unit priceDecimalFalseNoCost of product
QuantityDecimalTrueNoInternal placeholder to prevent conflicts with line item property of same name
Recurring billing frequencyStringFalseNoHow 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.
TaxDecimalFalseNoThe tax amount applied

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueQuotes.IdNoQuotes ID
AssociationId [KEY]LongFalseNoID of the object that this Quotes object is associated with.
Type [KEY]StringFalseNoType of the associated object* which can be a contact* deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
HasUniqueValueBoolFalseNoBoolean indicating if the value of the property is unique.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
Business unitsStringFalseNoThe business units this record is assigned to.
Allowed Payment MethodsStringFalseNoAccepted forms of payment if quote is using HubSpot Payment
Quote ApproverStringFalseNo
Collect Billing AddressBoolFalseNoIndicates if billing address should be collected with this quote
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
Create dateDatetimeTrueNoThe date the quote was created
Quote DomainStringFalseNoDomain this quote should be served from
ESign DateDatetimeTrueNoThe date and time the document was signed by all signers
Expiration Template PathStringFalseNoPath of the expiration template for the quote
Quote approval feedbackStringFalseNoFeedback about this quote during the approval process
LanguageStringFalseNoThe language for displaying this quote publicly
Last modified dateDatetimeTrueNoThe last time any property on the quote was modified
Global Term Line Item Discount PercentageStringFalseNoFor internal HubSpot Application use only. Global term for the discount percentage applied.
Global Term Line Item Discount Percentage EnabledBoolFalseNoFor internal HubSpot Application use only. Indicates if the Global term for the discount percentage is enabled.
Global Term Line Item Recurring Billing PeriodStringFalseNoFor internal HubSpot Application use only. Global term for product recurring billing duration.
Global Term Line Item Recurring Billing Period EnabledBoolFalseNoFor internal HubSpot Application use only. Indicates if the Global term for product recurring billing duration is enabled.
Global Term Line Item Recurring Billing Start DateStringFalseNoFor internal HubSpot Application use only. Global term for recurring billing start date for a line item.
Global Term Line Item Recurring Billing Start Date EnabledBoolFalseNoFor 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 FrequencyStringFalseNoFor internal HubSpot Application use only. Global term for how frequently the product is billed.
Global Term Line Item Recurring Billing Frequency EnabledBoolFalseNoFor internal HubSpot Application use only. Indicates if the Global term for how frequently the product is billed is enabled
LocaleStringFalseNoThe locale for displaying this quote publicly
LockedBoolTrueNoIndicates if this quote is locked and can never be updated
Merged object IDsStringTrueNoThe list of object IDs that have been merged into this object. This value is automatically set by HubSpot and may not be modified.
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Payment dateDatetimeTrueNoThe date the quote was paid by the customer
Payment StatusStringTrueNoPayment status for the quote
Payment TypeStringFalseNoPayment type for the quote if payment is enabled
Quote PDF download linkStringTrueNoThe link to download a pdf of a quote
Proposal DomainStringTrueNoDomain this proposal should be served from
Proposal SlugStringTrueNoPath to serve this proposal from
Proposal TemplateStringFalseNoTemplate Path this proposal is rendered with
Public URL keyStringTrueNoKey for accessing quote document URL
Quote Total PreferenceStringFalseNoWhat LineItem property will be used to calculate the Quote Amount
Read Only ObjectBoolTrueNoIs the object read only
Sender image URLStringFalseNoURL to image of the sender avatar image to be set on the quote
Quote SlugStringFalseNoPath to serve this quote from
Template TypeStringFalseNoWhether this Quote is rendered with the default templates
Test modeBoolFalseNoIndicates if the quote is in test mode
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner assigned dateDatetimeTrueNoThe date an owner was assigned to the quote
Sender company nameStringFalseNoThe name of the company sending this quote
Sender first nameStringFalseNoFirst name of the sender of this quote
Quote titleStringFalseNoThe title of this quote
Expiration dateDatetimeFalseNoThe date that this quote expires
Sender company domainStringFalseNoThe domain of the company sending this quote
Sender last nameStringFalseNoLast name of the sender of this quote
Comments to buyerStringFalseNoComments to the buyer
Sender company street addressStringFalseNoThe street address of the company sending this quote
Sender emailStringFalseNoEmail address of the sender of this quote
Sender company street address 2StringFalseNoThe second line of the street address of the company sending this quote
Sender phone numberStringFalseNoPhone number of the sender of this quote
TermsStringFalseNoAny relevant information about pricing* purchasing terms* and_or master agreements
Logo URLStringFalseNoURL to image of the logo displayed on the quote
Sender company cityStringFalseNoThe city in which the company sending this quote is located
Sender job titleStringFalseNoJob title of the sender of this quote
Sender company state_regionStringFalseNoThe state_region in which the company sending this quote is located
Space for written signatureBoolFalseNoIndicates if the quote document should have a place for a written signature
Branding colorStringFalseNoColor value used on the quote document
Recent Sales Email Replied DateDatetimeTrueNoThe last time a tracked sales email was replied to for this quote
Sender company postal codeStringFalseNoThe zip code in which the company sending this quote is located
Space for written countersignatureBoolFalseNoIndicates if the quote document should have a place for a written countersignature
Quote ownerStringFalseNoThe owner of the quote
Last ContactedDatetimeTrueNoThe last timestamp when a call_ email or meeting was logged for this quote
Last Activity DateDatetimeTrueNoThe 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 DateDatetimeTrueNoThe date of the next upcoming activity for this quote
Number of times contactedDecimalTrueNoThe number of times a call_ email or meeting was logged for this quote
Number of Sales ActivitiesDecimalTrueNoNumber of sales activities for this quote
CurrencyStringFalseNoCurrency code for the quote
Sender company countryStringFalseNoThe country in which the company sending this quote is located
HubSpot teamStringTrueNoThe name of the team associated with the owner of the quote
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
Sender company image URLStringFalseNoURL to image of the sender company image to be set on the quote
Time zoneStringFalseNoTimezone for displaying dates on the quote
All team idsStringTrueNoThe team ids corresponding to all owner referencing properties for this object_ both default and custom
Payment enabledBoolFalseNoIndicates if payment can be collected via the quote link
All accessible team idsStringTrueNoThe team ids* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom
ESign enabledBoolFalseNoIndicates if esign is enabled for quote
Associated DealsDecimalTrueNoThe number of deals associated with this quote. This is set automatically by HubSpot.
ESign number of signers requiredDecimalTrueNoTotal number of signers required for this quote to be fully signed
Legacy Quote TemplateStringFalseNoThe legacy quote template used to generate a quote. These templates will be sunset on Dec. 12th 2022.
ESign completed signaturesDecimalTrueNoNumber of completed signatures collected so far
Quote amountDecimalTrueNoThe total due for the quote
Quote approval statusStringFalseNoApproval status of the quote
Quote numberStringFalseNoReference number shown on quote document
Collect shipping addressBoolFalseNoIndicates if shipping address should be collected with this quote

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongFalseNoThe role's unique ID
NameStringFalseNoThe role's name
RequiresBillingWriteBooleanFalseNoWhether this role has a paid seat and requires the billing-write scope to assign/unassign to users

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoTasks ID
AssociationId [KEY]LongFalseNoID of the object that this Tasks object is associated with.
Type [KEY]StringFalseNoType of the associated object, which can be a contact, deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongFalseNoThe team's unique ID.
NameStringFalseNoThe team's name.
UserIdsStringFalseNoComma-separated list of user IDs representing team members.
SecondaryUserIdsStringFalseNoComma-separated list of user IDs representing secondary team members.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoThe unique Id of the message.
TypeStringFalseNoThe type of the message.
CreatedAtDatetimeFalseNoTime the message was created.
UpdatedAtDatetimeFalseNoTime the message was updated.
CreatedByStringFalseNoThe Id of an actor/participant which created the message.
ClientTypeStringFalseNoThe type of the client.
IntegrationAppIdIntegerFalseNoThe Id of the client if the client is an integration.
SendersIdStringFalseNoThe Id of an actor/participant which sent the message.
SendersNameStringFalseNoThe Name of an actor/participant which sent the message.
SendersFieldStringFalseNoThe sender's field.
SendersDeliveryIdentifierTypeStringFalseNoThe delivery identifier type for sender.
SendersDeliveryIdentifierValueStringFalseNoThe delivery identifier value for sender.
RecipientsIdStringFalseNoThe Id of an actor/participant which received the message.
RecipientsNameStringFalseNoThe Name of an actor/participant which received the message.
RecipientsFieldStringFalseNoThe recipient's field.
RecipientsDeliveryIdentifierTypeStringFalseNoThe delivery identifier type for recipient.
RecipientsDeliveryIdentifierValueStringFalseNoThe delivery identifier value for recipient.
ChannelIdStringFalseNoThe Id of the channel.
ChannelAccountIdStringFalseNoThe Account Id of the channel.
ArchivedBoolFalseNoThe status of archived.
AssignedToStringFalseNoTo which it is assigned.
AssignedFromStringFalseNoFrom whom it is assigned.
TextStringFalseNoThe content of the message.
RichTextStringFalseNoThe content of the message in HTML format.
AttachmentsFileIdStringFalseNoThe Id of the attachment to the comment.
AttachmentsUrlStringFalseNoThe URL of the attachment to the comment.
SubjectStringFalseNoThe subject of the message.
TruncationStatusStringFalseNoThe truncation status of the message.
InReplyToIdStringFalseNoThe Id value being replied to.
StatusTypeStringFalseNoThe status type.
DirectionStringFalseNoThe direction of the message.
NewStatusStringFalseNoThe value of the new status.
ThreadIdStringFalseYesId of the thread that contains the messages.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique Id of the thread.
CreatedAtDatetimeTrueNoTime the thread was created.
ClosedAtDatetimeTrueNoTime the thread was closed.
StatusStringFalseNoThe thread's status: open or closed.
LatestMessageTimestampDatetimeTrueNoThe time that the latest message was sent or received on the thread.
LatestMessageSentTimestampDatetimeTrueNoThe time that the latest message was sent on the thread.
LatestMessageReceivedTimestampDatetimeTrueNoThe time that the latest message was received on the thread.
AssignedToStringTrueNoThe Id of an actor/participant in a conversation.
SpamBoolTrueNoWhether the thread is marked as spam.
InboxIdStringTrueNoThe Id of the conversations' inbox containing the thread.
AssociatedContactIdStringTrueNoThe Id of teh assoicated Contact in the CRM.
ArchivedBoolFalseNoWhether the thread is archived.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueTickets.IdNoTickets ID
AssociationId [KEY]LongFalseNoID of the object that this Tickets object is associated with.
Type [KEY]StringFalseNoType of the associated object* which can be a contact* deal etc.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoThe unique identified of the pipeline.
LabelStringFalseNoThe label name of the pipeline.
ArchivedBoolTrueNoWhether the pipeline is archived or not.
CreatedAtDatetimeTrueNoWhen the pipeline was created.
UpdatedAtDatetimeTrueNoWhen the pipeline was last updated.
DisplayOrderIntFalseNoThe order of this specific pipeline in the collection of pipelines for this table.
StagesAggregateStringFalseNoAn aggregate of the stages included in this pipeline. This information can be viewed in more detail in TicketPipelineStages table.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringTrueNoUnique identifier of the stage in this pipeline.
PipelineId [KEY]StringFalseTicketPipelines.IdNoUnique identifier of the pipeline.
LabelStringFalseNoLabel name of the pipeline stage.
PipelineLabelStringTrueTicketPipelines.LabelNoThe label name of the pipeline.
IsClosedBoolFalseNoWhether this stage is open or closed.
StateStringFalseNoCurrent state of the pipeline stage.
ArchivedBoolTrueNoWhether the stage is archived or not.
CreatedAtDatetimeTrueNoTime the stage was created.
UpdatedAtDatetimeTrueNoTime the stage was last updated.
DisplayOrderIntFalseNoThe order of the stage in the collection of stages for this pipeline.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property. The name must contain only lowercase alphabetical characters and numbers and must start with a lowercase alphabetical character.
LabelStringFalseNoThe human readable label for the property that will display in the HubSpot UI.
FieldTypeStringFalseNoThe type of field that will display on the screen for the property.
TypeStringFalseNoThe stored machine type for the property.
GroupNameStringFalseNoThe group that the property is a part of.
DescriptionStringFalseNoA description of what the property is for.
DisplayOrderIntFalseNoThe order in which the property should be displayed in relation to other properties in the same group.
ExternalOptionsBoolFalseNoBoolean indicating if there are external options associate with the company property.
IsFormFieldBoolFalseNoBoolean indicating if the property is a field that is part of a form.
IsCalculatedBoolFalseNoBoolean indicating if the property is calculated.
IsHiddenBoolFalseNoBoolean indicating if the property is hidden.
IsHubspotDefinedBoolFalseNoBoolean indicating if the definition is defined from HubSpot.
ArchivableBoolFalseNoBoolean indicating if the definition is archivable.
ReadOnlyDefinitionBoolFalseNoBoolean indicating if the definition for the property is read only.
ReadOnlyValueBoolFalseNoBoolean indicating if the value of the property is read only.
OptionsAggregateStringFalseNoAn aggregate of additional options for the property. Will have a value if the FieldType is radio, checkbox, or booleancheckbox.
HasUniqueValueBoolFalseNoBoolean indicating if the value of the property is unique.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
PropertyNameStringTrueNoThe name of the property.
ValueStringTrueNoThe historical value of the property.
SourceTypeStringTrueNoThe method by which the property was changed.
SourceIdStringTrueNoAdditional data related to the source. May not be populated for all sources.
TimestampDatetimeTrueNoDatetime when the property was updated.
TicketIdLongTrueNoThe ticket identifier.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Name [KEY]StringFalseNoThe name of the property group.
LabelStringFalseNoThe label of the group.
DisplayOrderIntFalseNoThe numerical order of the group with respect to other groups.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier of the object.
ArchivedBoolTrueNoWhether the object is archived or not.
CreatedAtDatetimeTrueNoWhen the object was created.
UpdatedAtDatetimeTrueNoWhen the object was last updated.
ItemURLStringTrueNoUrl that points directly to the HubSpot item.
Close dateDatetimeFalseNoThe date the ticket was closed
Created byDecimalFalseNoVID of contact that created the ticket
Create dateDatetimeFalseNoThe date the ticket was created
First agent email response dateDatetimeTrueNoThe date of the first email response from an agent after a ticket was created
Business unitsStringFalseNoThe business units this record is assigned to.
Assignment MethodStringFalseNodefines how the Object Assignment is done
AutoGenerated from thread idDecimalTrueNoThread that this ticket was automatically created for using ticket rules
Originating Conversations Message IdStringFalseNoConversations Message Id of the message that originated this ticket
Conversations originating thread idDecimalFalseNoThread that this ticket was originally created for
Created by user IDDecimalTrueNoThe user that created this object. This value is automatically set by HubSpot and may not be modified.
HubSpot create dateDatetimeTrueNoInternal read_only property representing the date the ticket was created in HubSpot
Custom inbox IDDecimalFalseNoID of the custom inbox the ticket is associated with
Date entered 'New Support Pipeline'DatetimeTrueNoThe date and time when the ticket entered the 'New' stage_ 'Support Pipeline' pipeline
Date entered 'Waiting on contact Support Pipeline'DatetimeTrueNoThe date and time when the ticket entered the 'Waiting on contact' stage_ 'Support Pipeline' pipeline
Date entered 'Waiting on us Support Pipeline'DatetimeTrueNoThe date and time when the ticket entered the 'Waiting on us' stage_ 'Support Pipeline' pipeline
Date entered 'Closed Support Pipeline'DatetimeTrueNoThe date and time when the ticket entered the 'Closed' stage_ 'Support Pipeline' pipeline
Date exited 'New Support Pipeline'DatetimeTrueNoThe date and time when the ticket exited the 'New' stage_ 'Support Pipeline' pipeline
Date exited 'Waiting on contact Support Pipeline'DatetimeTrueNoThe date and time when the ticket exited the 'Waiting on contact' stage_ 'Support Pipeline' pipeline
Date exited 'Waiting on us Support Pipeline'DatetimeTrueNoThe date and time when the ticket exited the 'Waiting on us' stage_ 'Support Pipeline' pipeline
Date exited 'Closed Support Pipeline'DatetimeTrueNoThe date and time when the ticket exited the 'Closed' stage_ 'Support Pipeline' pipeline
External object idsStringFalseNoUnique ids corresponding to tickets in a system outside of HubSpot
Last CES survey commentStringTrueNoLast CES survey comment that this contact gave for this ticket
Last CES survey ratingStringTrueNoLast CES survey rating that this contact gave for this ticket
Last CES survey dateDatetimeTrueNoThe time that this contact last submitted a CES survey response. This is automatically set by HubSpot.
File uploadStringFalseNoFiles attached to a support form by a contact.
First agent response dateDatetimeTrueNoThe date of the first response from an agent out of all associated conversations
In Help DeskBoolFalseNoIs this Ticket rendered in the Help Desk
Inbox IDDecimalTrueNoInbox the ticket is in
Last email activityStringTrueNoThe type of the last email activity with the contact associated with the ticket.
Last email dateDatetimeTrueNoThe date of the last email activity with the contact associated with the ticket.
Last message received dateDatetimeTrueNoThe date of the last response from the visitor
Last response dateDatetimeTrueNoThe date of the last response from an agent or bot
Last activity dateDatetimeTrueNoThe last time a note* call* email* meeting* or task was logged for a ticket. This is updated automatically by HubSpot.
Last contacted dateDatetimeTrueNoThe 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 dateDatetimeTrueNoMost 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 idsStringTrueNoAgents who have seen the newest message across all conversations associated to the ticket
Merged ticket idsStringTrueNoAll ticket ids for this ticket
Microsoft Teams message ID for this ticket.StringTrueNoMicrosoft Teams message ID for this ticket.
Next activity dateDatetimeTrueNoThe 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 CompaniesDecimalTrueNoNumber of companies associated with this ticket
Number of times contactedDecimalTrueNoThe number of times a call* email* or meeting was logged on the ticket
Record IDDecimalTrueNoThe unique ID for this record. This value is automatically set by HubSpot and may not be modified.
Originating channel accountStringTrueNoFirst channel account used when conversation was started
Originating email engagement idDecimalTrueNoEngagement id of the email originating this ticket
Originating channel typeStringTrueNoThe channel the conversation is in
Pinned Engagement IDDecimalTrueNoThe object ID of the current pinned engagement. This value is automatically set by HubSpot and may not be modified.
PipelineStringFalseNoThe pipeline that contains this ticket
Ticket statusStringFalseNoThe pipeline stage that contains this ticket
Read Only ObjectBoolTrueNoIs the object read only
ResolutionStringFalseNoThe action taken to resolve the ticket
Thread IDs To RestoreStringFalseNoThread IDs from cv_threads used to implement custom cascading delete_restore
CategoryStringFalseNoMain reason customer reached out for help
Ticket IDDecimalTrueNoThe unique id for this ticket. This unique id is automatically populated by HubSpot.
PriorityStringFalseNoThe level of attention needed on the ticket
Time in 'New Support Pipeline'DecimalTrueNoThe total time in seconds spent by the ticket in the 'New' stage_ 'Support Pipeline' pipeline
Time in 'Waiting on contact Support Pipeline'DecimalTrueNoThe total time in seconds spent by the ticket in the 'Waiting on contact' stage_ 'Support Pipeline' pipeline
Time in 'Waiting on us Support Pipeline'DecimalTrueNoThe total time in seconds spent by the ticket in the 'Waiting on us' stage_ 'Support Pipeline' pipeline
Time in 'Closed Support Pipeline'DecimalTrueNoThe total time in seconds spent by the ticket in the 'Closed' stage_ 'Support Pipeline' pipeline
Time to Close SLA Due DateDatetimeTrueNoWhen the ticket falls out of Time to Close SLA.
Time to Close SLA Ticket StatusStringTrueNoCurrent Time to Close SLA status of ticket
Time to First Response SLA Due DateDatetimeTrueNoWhen the ticket falls out of the Time to First Response SLA
Time to First Response SLA StatusStringTrueNoCurrent Time to First Response SLA status.
Unique creation keyStringTrueNoUnique property used for idempotent creates
Updated by user IDDecimalTrueNoThe user that last updated this object. This value is automatically set by HubSpot and may not be modified.
User IDs of all notification followersStringTrueNoThe user IDs of all users that have clicked follow within the object to opt_in to getting follow notifications
User IDs of all notification unfollowersStringTrueNoThe user IDs of all object owners that have clicked unfollow within the object to opt_out of getting follow notifications
User IDs of all ownersStringTrueNoThe user IDs of all owners of this object
Owner assigned dateDatetimeTrueNoThe date an owner was assigned to the ticket
Date of last engagementDatetimeTrueNoThe date of the last reply or note
Last customer reply dateDatetimeTrueNoThe date of the last customer response
NPS follow upStringFalseNoAnswer to NPS follow up question
NPS follow up questionDecimalFalseNoSpecific version of NPS follow up question that was asked
Conversation NPS scoreStringFalseNoNPS score received after ticket resolution
Reference to email threadStringFalseNoThe id of an email thread with ticket conversation
Time to closeDecimalTrueNoThe time between when the ticket was created and closed
Time to first agent email replyDecimalTrueNoThe time from the ticket create date to the first agent email reply
Ticket nameStringFalseNoShort summary of ticket
Ticket descriptionStringFalseNoDescription of the ticket
SourceStringFalseNoChannel where ticket was originally submitted
Reference to sourceSpecific objectStringFalseNoThe id of a connected source object
TagsStringFalseNoTags associated with your tickets
Recent Sales Email Replied DateDatetimeTrueNoThe last time a tracked sales email was replied to for this ticket
Ticket ownerStringFalseNoUser the ticket is assigned to. Assign additional users to a ticket record by creating a custom user property.
Last Contacted Ticket NoteDatetimeTrueNoThe last timestamp when a call_ email or meeting was logged for this ticket
Last Activity Date Ticket NoteDatetimeTrueNoThe 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 NoteDatetimeTrueNoThe date of the next upcoming activity for this ticket
Number of times contacted Ticket NoteDecimalTrueNoThe number of times a call_ email or meeting was logged for this ticket
Number of Sales ActivitiesDecimalTrueNoNumber of sales activities for this ticket
HubSpot teamStringTrueNoPrimary team of the ticket owner. This property is set automatically by HubSpot.
All owner idsStringTrueNoThe value of all owner referencing properties for this object_ both default and custom
All team idsStringTrueNoThe team IDs* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom
All accessible team idsStringTrueNoThe team IDs* including up the team hierarchy* corresponding to all owner referencing properties for this object_ both default and custom

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongFalseNoThe user's unique ID.
FirstNameStringFalseNoThe user's firstname.
LastNameStringFalseNoThe user's lastname.
EmailStringFalseNoThe user's email.
RoleIdLongFalseRoles.IdNoThe user's role.
PrimaryTeamIdLongFalseTeams.IdNoThe user's primary team.
SecondaryTeamIdsStringFalseNoComma-separated list of user IDs representing secondary team members.
IsSuperAdminBooleanFalseNoBoolean indicating if the user is a super admin.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]StringFalseNoId of the event.
ObjectIdStringFalseNoId of the object.
ObjectTypeStringFalseNoType of the selected object.
EventTypeStringFalseNoType of the event.
OccurredAtDatetimeFalseNoTime when the event occurred.
PropertiesStringFalseNoAdditional properties.
ObjectPropertyStringFalseYesIf 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'
OccurredAfterDatetimeFalseYesThe starting time as an ISO 8601 timestamp.
OccurredBeforeDatetimeFalseYesThe ending time as an ISO 8601 timestamp.
SortStringFalseYesSelects the sort field and order. Defaults to ascending* prefix with * for descending order. 'occurredAt' is the only field supported for sorting.

Return to Top

NameTypeReadOnlyReferencesFilterOnlyDescription
Id [KEY]LongTrueNoUnique identifier for the workflow.
NameStringFalseNoName assigned to the workflow.
DescriptionStringFalseNoBrief explanation of the workflow's purpose or function.
EnabledBooleanFalseNoIndicates whether the workflow is currently active.
CreatedAtLongTrueNoTimestamp showing when the workflow was initially created.
UpdatedAtLongTrueNoTimestamp indicating the most recent time the workflow was updated.
PortalIdIntegerTrueNoIdentifier for the portal where the workflow was created.
TypeStringFalseNoSpecifies the category or type of the workflow.
ActiveContactsIntegerTrueNoNumber of active contacts in the workflow.
EnrolledContactsIntegerTrueNoNumber of contacts enrolled in the workflow.
ContactListIdsActiveIntegerTrueNoID of the active contact list associated with the workflow.
ContactListIdsCompletedIntegerTrueNoID of the completed contact list associated with the workflow.
ContactListIdsEnrolledIntegerTrueNoID of the enrolled contact list associated with the workflow.
ContactListIdsSucceededIntegerTrueNoID of the contact list that successfully completed the workflow.
CreationSourceStringTrueNoSource or method used to create the workflow.
MigrationStatusStringTrueNoStatus of any migration process related to the workflow.
UpdateSourceStringTrueNoSource or method used for the most recent update to the workflow.
ActionsStringFalseNoAn array of actions associated with the workflow.

Return to Top