Hubspot API Reference
The public API procedures may call the internal procedures which should not be used directly as they can be changed without any explicit notification in the newer versions of the connector. Internal procedures can be recognized by the prefix internal_
in their names. Public API procedures do not have such prefix in their names.
Associations
Associations
Parameter
<object_id> (optional): The ID of the object that you want to get the associations for
<definition_id> (required): The ID of the type of associations you want
<object_table> (optional): Table name with object data
<field_name> (optional): Field name with object id
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
objectId | string | Object Id |
associatedObjectId | string | Associated object Id |
BroadcastMessages
Broadcast Messages
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
broadcastGuid | string | Broadcast Guid |
portalId | string | Portal Id |
groupGuid | string | Group Guid |
campaignGuid | string | Campaign Guid |
channelKey | string | Channel Key |
channelGuid | string | Channel Guid |
clientTag | string | Client Tag |
createdAt | timestamp | Created At |
userUpdatedAt | timestamp | User Updated At |
triggerAt | timestamp | Trigger At |
finishedAt | timestamp | Finished At |
status | string | Status |
message | string | Message |
originalLink | string | Original Link |
charCount | integer | Char Count |
originalBody | string | Original Body |
uncompressedLinks | string | Uncompressed Links |
hashtagCount | integer | Hashtag Count |
contentBody | string | Content Body |
title | string | Title |
thumbUrl | string | Thumb Url |
fileId | string | File Id |
foreignId | string | Foreign Id |
remoteContentId | string | Remote Content Id |
remoteContentType | string | Remote Content Type |
clicks | integer | Clicks |
createdBy | integer | Created By |
updatedBy | integer | Updated By |
campaignName | string | Campaign Name |
broadcastMediaType | string | Broadcast Media Type |
wasDraft | boolean | Was Draft |
channel | string | Channel |
serviceId | string | Service Id |
extraDataBody | string | Extra Data Body |
updatedClientTag | string | Uupdated Client Tag |
isPending | boolean | Is Pending |
isPublished | boolean | Is Published |
isFailed | boolean | Is Failed |
isRetry | boolean | Is Retry |
messageText | string | Message Text |
Create View hubspot_v2_examples.example_BroadcastMessages
As
Select * From hubspot_v2.BroadcastMessages (
preview => true
);;
Calls
List of calls
Parameter
<archived> (optional): Whether to return only results that have been archived
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Call ID |
hs_activity_type | string | Call and meeting type |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Call notes preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | boolean | Body Preview Truncated |
hs_call_app_id | string | Integrating App ID |
hs_call_authed_url_provider | string | Authenticated recording files url provider |
hs_call_body | string | Call notes |
hs_call_callee_object_id | string | Callee object id |
hs_call_callee_object_type | string | Callee object type |
hs_call_direction | string | Call direction |
hs_call_disposition | string | Call outcome |
hs_call_duration | string | Call duration |
hs_call_external_account_id | string | External Account ID |
hs_call_external_id | string | External ID |
hs_call_from_number | string | From Number |
hs_call_has_transcript | boolean | Transcript Available |
hs_call_recording_url | string | Recording URL |
hs_call_source | string | Call Source |
hs_call_status | string | Call status |
hs_call_title | string | Call Title |
hs_call_to_number | string | To Number |
hs_call_transcript_tracked_terms | string | Transcript Tracked Terms |
hs_call_transcription_id | string | Call transcription id |
hs_call_video_recording_url | string | Video url |
hs_call_zoom_meeting_uuid | string | Unique Zoom Meeting ID |
hs_calls_service_call_id | string | Calls Service Call ID |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | boolean | GDPR deleted |
hs_lastmodifieddate | string | Last modified date |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_unknown_visitor_conversation | boolean | Unknown Visitor Conversation |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Example
CREATE VIEW hubspot_v2_examples.example_Calls
AS
SELECT * FROM hubspot_v2.Calls (
preview => TRUE
)
Calls_Associations
List associations of a call by type
Parameter
<callId> (optional): The ID of the call
<call_table> (optional): Table name with call data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
callId | string | The ID of the call |
objectId | string | The ID of the object |
type | string | Association type |
Example
CREATE VIEW hubspot_v2_examples.example_Calls_Associations
AS
SELECT * FROM hubspot_v2.Calls_Associations (
preview => TRUE
)
Calls_CreateAssociation
Associate a call with company, deal or contact
Parameter
<callId> (required): The ID of the call
<objectId> (required): The ID of the company, deal or contact
<objectType> (required): Specify whether you would like to associate the call with a contact, deal or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Call ID |
hs_activity_type | string | Call and meeting type |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Call notes preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_call_app_id | string | Integrating App ID |
hs_call_authed_url_provider | string | Authenticated recording files url provider |
hs_call_body | string | Call notes |
hs_call_callee_object_id | string | Callee object id |
hs_call_callee_object_type | string | Callee object type |
hs_call_direction | string | Call direction |
hs_call_disposition | string | Call outcome |
hs_call_duration | string | Call duration |
hs_call_external_account_id | string | External Account ID |
hs_call_external_id | string | External ID |
hs_call_from_number | string | From Number |
hs_call_has_transcript | string | Transcript Available |
hs_call_recording_url | string | Recording URL |
hs_call_source | string | Call Source |
hs_call_status | string | Call status |
hs_call_title | string | Call Title |
hs_call_to_number | string | To Number |
hs_call_transcript_tracked_terms | string | Transcript Tracked Terms |
hs_call_transcription_id | string | Call transcription id |
hs_call_video_recording_url | string | Video url |
hs_call_zoom_meeting_uuid | string | Unique Zoom Meeting ID |
hs_calls_service_call_id | string | Calls Service Call ID |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_lastmodifieddate | string | Last modified date |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_unknown_visitor_conversation | string | Unknown Visitor Conversation |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Calls_CreateOrUpdate
Create or update call
Parameter
<callId> (optional): The ID of the campaign. If this value is null, then the call is created. If this value is specified, then the campaign with this ID will be updated
<properties> (required): The line of call properties. Should be supplied in json. "{"hs_timestamp" : "Required property, format - , format - yyyy-MM-ddTHH:mm:ss.SSSZ","hs_call_from_number" : "The number"
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Call ID |
hs_activity_type | string | Call and meeting type |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Call notes preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_call_app_id | string | Integrating App ID |
hs_call_authed_url_provider | string | Authenticated recording files url provider |
hs_call_body | string | Call notes |
hs_call_callee_object_id | string | Callee object id |
hs_call_callee_object_type | string | Callee object type |
hs_call_direction | string | Call direction |
hs_call_disposition | string | Call outcome |
hs_call_duration | string | Call duration |
hs_call_external_account_id | string | External Account ID |
hs_call_external_id | string | External ID |
hs_call_from_number | string | From Number |
hs_call_has_transcript | string | Transcript Available |
hs_call_recording_url | string | Recording URL |
hs_call_source | string | Call Source |
hs_call_status | string | Call status |
hs_call_title | string | Call Title |
hs_call_to_number | string | To Number |
hs_call_transcript_tracked_terms | string | Transcript Tracked Terms |
hs_call_transcription_id | string | Call transcription id |
hs_call_video_recording_url | string | Video url |
hs_call_zoom_meeting_uuid | string | Unique Zoom Meeting ID |
hs_calls_service_call_id | string | Calls Service Call ID |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_lastmodifieddate | string | Last modified date |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_unknown_visitor_conversation | string | Unknown Visitor Conversation |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Calls_Delete
Move a call to the recycling bin
Parameter
<callId> (required): Unique identifier for a call to delete
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Calls_DeleteAssociation
Removes a call's association with a contact, deal or company
Parameter
<callId> (required): The ID of the call
<objectId> (required): The ID of the company, deal or contact
<objectType> (required): Specify whether you would like to associate the call with a contact or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Companies
List of companies
Parameter
<archived> (optional): Whether to return only results that have been archived
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Company ID |
about_us | string | About Us |
closedate_timestamp_earliest_value_a2a17e6e | string | closedate_timestamp_earliest_value_a2a17e6e |
facebookfans | string | Facebook Fans |
first_contact_createdate_timestamp_earliest_value_78b50eea | string | first_contact_createdate_timestamp_earliest_value_78b50eea |
first_conversion_date | string | First Conversion Date |
first_conversion_date_timestamp_earliest_value_61f58f2c | string | first_conversion_date_timestamp_earliest_value_61f58f2c |
first_conversion_event_name | string | First Conversion |
first_conversion_event_name_timestamp_earliest_value_68ddae0a | string | first_conversion_event_name_timestamp_earliest_value_68ddae0a |
first_deal_created_date | string | First Deal Created Date |
founded_year | string | Year Founded |
hs_additional_domains | string | Additional Domains |
hs_all_assigned_business_unit_ids | string | Business units |
hs_analytics_first_timestamp | string | Time First Seen |
hs_analytics_first_timestamp_timestamp_earliest_value_11e3a63a | string | hs_analytics_first_timestamp_timestamp_earliest_value_11e3a63a |
hs_analytics_first_touch_converting_campaign | string | First Touch Converting Campaign |
hs_analytics_first_touch_converting_campaign_timestamp_earliest_value_4757fe10 | string | hs_analytics_first_touch_converting_campaign_timestamp_earliest_value_4757fe10 |
hs_analytics_first_visit_timestamp | string | Time of First Session |
hs_analytics_first_visit_timestamp_timestamp_earliest_value_accc17ae | string | hs_analytics_first_visit_timestamp_timestamp_earliest_value_accc17ae |
hs_analytics_last_timestamp | string | Time Last Seen |
hs_analytics_last_timestamp_timestamp_latest_value_4e16365a | string | hs_analytics_last_timestamp_timestamp_latest_value_4e16365a |
hs_analytics_last_touch_converting_campaign | string | Last Touch Converting Campaign |
hs_analytics_last_touch_converting_campaign_timestamp_latest_value_81a64e30 | string | hs_analytics_last_touch_converting_campaign_timestamp_latest_value_81a64e30 |
hs_analytics_last_visit_timestamp | string | Time of Last Session |
hs_analytics_last_visit_timestamp_timestamp_latest_value_999a0fce | string | hs_analytics_last_visit_timestamp_timestamp_latest_value_999a0fce |
hs_analytics_num_page_views | string | Number of Pageviews |
hs_analytics_num_page_views_cardinality_sum_e46e85b0 | string | hs_analytics_num_page_views_cardinality_sum_e46e85b0 |
hs_analytics_num_visits | string | Number of Sessions |
hs_analytics_num_visits_cardinality_sum_53d952a6 | string | hs_analytics_num_visits_cardinality_sum_53d952a6 |
hs_analytics_source | string | Original Source Type |
hs_analytics_source_data_1 | string | Original Source Data 1 |
hs_analytics_source_data_1_timestamp_earliest_value_9b2f1fa1 | string | hs_analytics_source_data_1_timestamp_earliest_value_9b2f1fa1 |
hs_analytics_source_data_2 | string | Original Source Data 2 |
hs_analytics_source_data_2_timestamp_earliest_value_9b2f9400 | string | hs_analytics_source_data_2_timestamp_earliest_value_9b2f9400 |
hs_analytics_source_timestamp_earliest_value_25a3a52c | string | hs_analytics_source_timestamp_earliest_value_25a3a52c |
hs_avatar_filemanager_key | string | Avatar FileManager key |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Object create date/time |
hs_date_entered_customer | string | Date entered 'Customer (Lifecycle Stage Pipeline)' |
hs_date_entered_evangelist | string | Date entered 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_entered_lead | string | Date entered 'Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_marketingqualifiedlead | string | Date entered 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_opportunity | string | Date entered 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_entered_other | string | Date entered 'Other (Lifecycle Stage Pipeline)' |
hs_date_entered_salesqualifiedlead | string | Date entered 'Demo (Lifecycle Stage Pipeline)' |
hs_date_entered_subscriber | string | Date entered 'Subscriber (Lifecycle Stage Pipeline)' |
hs_date_exited_customer | string | Date exited 'Customer (Lifecycle Stage Pipeline)' |
hs_date_exited_evangelist | string | Date exited 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_exited_lead | string | Date exited 'Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_marketingqualifiedlead | string | Date exited 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_opportunity | string | Date exited 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_exited_other | string | Date exited 'Other (Lifecycle Stage Pipeline)' |
hs_date_exited_salesqualifiedlead | string | Date exited 'Demo (Lifecycle Stage Pipeline)' |
hs_date_exited_subscriber | string | Date exited 'Subscriber (Lifecycle Stage Pipeline)' |
hs_ideal_customer_profile | string | Ideal Customer Profile Tier |
hs_is_target_account | boolean | Target Account |
hs_last_booked_meeting_date | string | Last Booked Meeting Date |
hs_last_logged_call_date | string | Last Logged Call Date |
hs_last_open_task_date | string | Last Open Task Date |
hs_last_sales_activity_date | string | last sales activity date old |
hs_last_sales_activity_timestamp | string | Last Engagement Date |
hs_lastmodifieddate | string | Last Modified Date |
hs_latest_createdate_of_active_subscriptions | string | Latest create date of active subscriptions |
hs_merged_object_ids | string | Merged object IDs |
hs_num_blockers | string | Number of blockers |
hs_num_contacts_with_buying_roles | string | Number of contacts with a buying role |
hs_num_decision_makers | string | Number of decision makers |
hs_num_open_deals | string | Number of open deals |
hs_object_id | string | Company ID |
hs_pipeline | string | Pipeline |
hs_predictivecontactscore_v2 | string | Likelihood to close |
hs_predictivecontactscore_v2_next_max_max_d4e58c1e | string | hs_predictivecontactscore_v2_next_max_max_d4e58c1e |
hs_target_account | string | Target Account |
hs_target_account_probability | string | Target Account Probability |
hs_target_account_recommendation_snooze_time | string | Target Account Recommendation Snooze Time |
hs_target_account_recommendation_state | string | Target Account Recommendation State |
hs_time_in_customer | string | Time in 'Customer (Lifecycle Stage Pipeline)' |
hs_time_in_evangelist | string | Time in 'Discovery (Lifecycle Stage Pipeline)' |
hs_time_in_lead | string | Time in 'Lead (Lifecycle Stage Pipeline)' |
hs_time_in_marketingqualifiedlead | string | Time in 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_time_in_opportunity | string | Time in 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_time_in_other | string | Time in 'Other (Lifecycle Stage Pipeline)' |
hs_time_in_salesqualifiedlead | string | Time in 'Demo (Lifecycle Stage Pipeline)' |
hs_time_in_subscriber | string | Time in 'Subscriber (Lifecycle Stage Pipeline)' |
hs_total_deal_value | string | Total open deal value |
hs_unique_creation_key | string | Unique creation key |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
is_public | boolean | Is Public |
num_associated_contacts | string | Number of Associated Contacts |
num_associated_deals | string | Number of Associated Deals |
num_conversion_events | string | Number of Form Submissions |
num_conversion_events_cardinality_sum_d095f14b | string | num_conversion_events_cardinality_sum_d095f14b |
recent_conversion_date | string | Recent Conversion Date |
recent_conversion_date_timestamp_latest_value_72856da1 | string | recent_conversion_date_timestamp_latest_value_72856da1 |
recent_conversion_event_name | string | Recent Conversion |
recent_conversion_event_name_timestamp_latest_value_66c820bf | string | recent_conversion_event_name_timestamp_latest_value_66c820bf |
recent_deal_amount | string | Recent Deal Amount |
recent_deal_close_date | string | Recent Deal Close Date |
timezone | string | Time Zone |
total_money_raised | string | Total Money Raised |
total_revenue | string | Total Revenue |
name | string | Company name |
owneremail | string | HubSpot Owner Email |
twitterhandle | string | Twitter Handle |
ownername | string | HubSpot Owner Name |
phone | string | Phone Number |
twitterbio | string | Twitter Bio |
twitterfollowers | string | Twitter Followers |
address | string | Street Address |
address2 | string | Street Address 2 |
facebook_company_page | string | Facebook Company Page |
city | string | City |
linkedin_company_page | string | LinkedIn Company Page |
linkedinbio | string | LinkedIn Bio |
state | string | State/Region |
googleplus_page | string | Google Plus Page |
engagements_last_meeting_booked | string | Date of last meeting booked in meetings tool |
engagements_last_meeting_booked_campaign | string | Campaign of last booking in meetings tool |
engagements_last_meeting_booked_medium | string | Medium of last booking in meetings tool |
engagements_last_meeting_booked_source | string | Source of last booking in meetings tool |
hs_latest_meeting_activity | string | Latest meeting activity |
hs_sales_email_last_replied | string | Recent Sales Email Replied Date |
hubspot_owner_id | string | Company owner |
notes_last_contacted | string | Last Contacted |
notes_last_updated | string | Last Activity Date |
notes_next_activity_date | string | Next Activity Date |
num_contacted_notes | string | Number of times contacted |
num_notes | string | Number of Sales Activities |
zip | string | Postal Code |
country | string | Country/Region |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
website | string | Website URL |
domain | string | Company Domain Name |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
numberofemployees | string | Number of Employees |
industry | string | Industry |
annualrevenue | string | Annual Revenue |
lifecyclestage | string | Lifecycle Stage |
hs_lead_status | string | Lead Status |
hs_parent_company_id | string | Parent Company |
type | string | Type |
description | string | Description |
hs_num_child_companies | string | Number of child companies |
hubspotscore | string | HubSpot Score |
createdate | string | Create Date |
closedate | string | Close Date |
first_contact_createdate | string | First Contact Create Date |
days_to_close | string | Days to Close |
web_technologies | string | Web Technologies |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Example
CREATE VIEW hubspot_v2_examples.example_Companies
AS
SELECT * FROM hubspot_v2.Companies (
preview => TRUE
)
Companies_CreateOrUpdate
Create or update company
Parameter
<companyId> (optional): The ID of the company. If this value is null, then the company is created. If this value is specified, then the campaign with this ID will be updated
<properties> (required): The line of company properties. Should be supplied in json. "{"name" : "The Company Name","description" : "The Company Description"
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Company ID |
about_us | string | About Us |
closedate_timestamp_earliest_value_a2a17e6e | string | closedate_timestamp_earliest_value_a2a17e6e |
facebookfans | string | Facebook Fans |
first_contact_createdate_timestamp_earliest_value_78b50eea | string | first_contact_createdate_timestamp_earliest_value_78b50eea |
first_conversion_date | string | First Conversion Date |
first_conversion_date_timestamp_earliest_value_61f58f2c | string | first_conversion_date_timestamp_earliest_value_61f58f2c |
first_conversion_event_name | string | First Conversion |
first_conversion_event_name_timestamp_earliest_value_68ddae0a | string | first_conversion_event_name_timestamp_earliest_value_68ddae0a |
first_deal_created_date | string | First Deal Created Date |
founded_year | string | Year Founded |
hs_additional_domains | string | Additional Domains |
hs_all_assigned_business_unit_ids | string | Business units |
hs_analytics_first_timestamp | string | Time First Seen |
hs_analytics_first_timestamp_timestamp_earliest_value_11e3a63a | string | hs_analytics_first_timestamp_timestamp_earliest_value_11e3a63a |
hs_analytics_first_touch_converting_campaign | string | First Touch Converting Campaign |
hs_analytics_first_touch_converting_campaign_timestamp_earliest_value_4757fe10 | string | hs_analytics_first_touch_converting_campaign_timestamp_earliest_value_4757fe10 |
hs_analytics_first_visit_timestamp | string | Time of First Session |
hs_analytics_first_visit_timestamp_timestamp_earliest_value_accc17ae | string | hs_analytics_first_visit_timestamp_timestamp_earliest_value_accc17ae |
hs_analytics_last_timestamp | string | Time Last Seen |
hs_analytics_last_timestamp_timestamp_latest_value_4e16365a | string | hs_analytics_last_timestamp_timestamp_latest_value_4e16365a |
hs_analytics_last_touch_converting_campaign | string | Last Touch Converting Campaign |
hs_analytics_last_touch_converting_campaign_timestamp_latest_value_81a64e30 | string | hs_analytics_last_touch_converting_campaign_timestamp_latest_value_81a64e30 |
hs_analytics_last_visit_timestamp | string | Time of Last Session |
hs_analytics_last_visit_timestamp_timestamp_latest_value_999a0fce | string | hs_analytics_last_visit_timestamp_timestamp_latest_value_999a0fce |
hs_analytics_num_page_views | string | Number of Pageviews |
hs_analytics_num_page_views_cardinality_sum_e46e85b0 | string | hs_analytics_num_page_views_cardinality_sum_e46e85b0 |
hs_analytics_num_visits | string | Number of Sessions |
hs_analytics_num_visits_cardinality_sum_53d952a6 | string | hs_analytics_num_visits_cardinality_sum_53d952a6 |
hs_analytics_source | string | Original Source Type |
hs_analytics_source_data_1 | string | Original Source Data 1 |
hs_analytics_source_data_1_timestamp_earliest_value_9b2f1fa1 | string | hs_analytics_source_data_1_timestamp_earliest_value_9b2f1fa1 |
hs_analytics_source_data_2 | string | Original Source Data 2 |
hs_analytics_source_data_2_timestamp_earliest_value_9b2f9400 | string | hs_analytics_source_data_2_timestamp_earliest_value_9b2f9400 |
hs_analytics_source_timestamp_earliest_value_25a3a52c | string | hs_analytics_source_timestamp_earliest_value_25a3a52c |
hs_avatar_filemanager_key | string | Avatar FileManager key |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Object create date/time |
hs_date_entered_customer | string | Date entered 'Customer (Lifecycle Stage Pipeline)' |
hs_date_entered_evangelist | string | Date entered 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_entered_lead | string | Date entered 'Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_marketingqualifiedlead | string | Date entered 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_opportunity | string | Date entered 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_entered_other | string | Date entered 'Other (Lifecycle Stage Pipeline)' |
hs_date_entered_salesqualifiedlead | string | Date entered 'Demo (Lifecycle Stage Pipeline)' |
hs_date_entered_subscriber | string | Date entered 'Subscriber (Lifecycle Stage Pipeline)' |
hs_date_exited_customer | string | Date exited 'Customer (Lifecycle Stage Pipeline)' |
hs_date_exited_evangelist | string | Date exited 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_exited_lead | string | Date exited 'Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_marketingqualifiedlead | string | Date exited 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_opportunity | string | Date exited 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_exited_other | string | Date exited 'Other (Lifecycle Stage Pipeline)' |
hs_date_exited_salesqualifiedlead | string | Date exited 'Demo (Lifecycle Stage Pipeline)' |
hs_date_exited_subscriber | string | Date exited 'Subscriber (Lifecycle Stage Pipeline)' |
hs_ideal_customer_profile | string | Ideal Customer Profile Tier |
hs_is_target_account | boolean | Target Account |
hs_last_booked_meeting_date | string | Last Booked Meeting Date |
hs_last_logged_call_date | string | Last Logged Call Date |
hs_last_open_task_date | string | Last Open Task Date |
hs_last_sales_activity_date | string | last sales activity date old |
hs_last_sales_activity_timestamp | string | Last Engagement Date |
hs_lastmodifieddate | string | Last Modified Date |
hs_latest_createdate_of_active_subscriptions | string | Latest create date of active subscriptions |
hs_merged_object_ids | string | Merged object IDs |
hs_num_blockers | string | Number of blockers |
hs_num_contacts_with_buying_roles | string | Number of contacts with a buying role |
hs_num_decision_makers | string | Number of decision makers |
hs_num_open_deals | string | Number of open deals |
hs_object_id | string | Company ID |
hs_pipeline | string | Pipeline |
hs_predictivecontactscore_v2 | string | Likelihood to close |
hs_predictivecontactscore_v2_next_max_max_d4e58c1e | string | hs_predictivecontactscore_v2_next_max_max_d4e58c1e |
hs_target_account | string | Target Account |
hs_target_account_probability | string | Target Account Probability |
hs_target_account_recommendation_snooze_time | string | Target Account Recommendation Snooze Time |
hs_target_account_recommendation_state | string | Target Account Recommendation State |
hs_time_in_customer | string | Time in 'Customer (Lifecycle Stage Pipeline)' |
hs_time_in_evangelist | string | Time in 'Discovery (Lifecycle Stage Pipeline)' |
hs_time_in_lead | string | Time in 'Lead (Lifecycle Stage Pipeline)' |
hs_time_in_marketingqualifiedlead | string | Time in 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_time_in_opportunity | string | Time in 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_time_in_other | string | Time in 'Other (Lifecycle Stage Pipeline)' |
hs_time_in_salesqualifiedlead | string | Time in 'Demo (Lifecycle Stage Pipeline)' |
hs_time_in_subscriber | string | Time in 'Subscriber (Lifecycle Stage Pipeline)' |
hs_total_deal_value | string | Total open deal value |
hs_unique_creation_key | string | Unique creation key |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
is_public | boolean | Is Public |
num_associated_contacts | string | Number of Associated Contacts |
num_associated_deals | string | Number of Associated Deals |
num_conversion_events | string | Number of Form Submissions |
num_conversion_events_cardinality_sum_d095f14b | string | num_conversion_events_cardinality_sum_d095f14b |
recent_conversion_date | string | Recent Conversion Date |
recent_conversion_date_timestamp_latest_value_72856da1 | string | recent_conversion_date_timestamp_latest_value_72856da1 |
recent_conversion_event_name | string | Recent Conversion |
recent_conversion_event_name_timestamp_latest_value_66c820bf | string | recent_conversion_event_name_timestamp_latest_value_66c820bf |
recent_deal_amount | string | Recent Deal Amount |
recent_deal_close_date | string | Recent Deal Close Date |
timezone | string | Time Zone |
total_money_raised | string | Total Money Raised |
total_revenue | string | Total Revenue |
name | string | Company name |
owneremail | string | HubSpot Owner Email |
twitterhandle | string | Twitter Handle |
ownername | string | HubSpot Owner Name |
phone | string | Phone Number |
twitterbio | string | Twitter Bio |
twitterfollowers | string | Twitter Followers |
address | string | Street Address |
address2 | string | Street Address 2 |
facebook_company_page | string | Facebook Company Page |
city | string | City |
linkedin_company_page | string | LinkedIn Company Page |
linkedinbio | string | LinkedIn Bio |
state | string | State/Region |
googleplus_page | string | Google Plus Page |
engagements_last_meeting_booked | string | Date of last meeting booked in meetings tool |
engagements_last_meeting_booked_campaign | string | Campaign of last booking in meetings tool |
engagements_last_meeting_booked_medium | string | Medium of last booking in meetings tool |
engagements_last_meeting_booked_source | string | Source of last booking in meetings tool |
hs_latest_meeting_activity | string | Latest meeting activity |
hs_sales_email_last_replied | string | Recent Sales Email Replied Date |
hubspot_owner_id | string | Company owner |
notes_last_contacted | string | Last Contacted |
notes_last_updated | string | Last Activity Date |
notes_next_activity_date | string | Next Activity Date |
num_contacted_notes | string | Number of times contacted |
num_notes | string | Number of Sales Activities |
zip | string | Postal Code |
country | string | Country/Region |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
website | string | Website URL |
domain | string | Company Domain Name |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
numberofemployees | string | Number of Employees |
industry | string | Industry |
annualrevenue | string | Annual Revenue |
lifecyclestage | string | Lifecycle Stage |
hs_lead_status | string | Lead Status |
hs_parent_company_id | string | Parent Company |
type | string | Type |
description | string | Description |
hs_num_child_companies | string | Number of child companies |
hubspotscore | string | HubSpot Score |
createdate | string | Create Date |
closedate | string | Close Date |
first_contact_createdate | string | First Contact Create Date |
days_to_close | string | Days to Close |
web_technologies | string | Web Technologies |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
ContactLists
Contact Lists
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
dynamic | boolean | Is dynamic |
processing | string | Processing |
size | integer | Size |
error | string | Error |
lastProcessingStateChangeAt | timestamp | Last Processing State Change At |
lastSizeChangeAt | timestamp | Last Size Change At |
name | string | Name |
portalId | integer | Portal Id |
createdAt | timestamp | Created At |
updatedAt | timestamp | Updated At |
listId | integer | List Id |
listType | string | List Type |
internalListId | integer | Internal List Id |
deleteable | boolean | Deleteable |
Create View hubspot_v2_examples.example_ContactLists
As
Select * From hubspot_v2.ContactLists (
preview => true
);;
Contacts
List of Contacts
Parameter
<archived> (optional): Whether to return only results that have been archived
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Contact ID |
company_size | string | Company size |
date_of_birth | string | Date of birth |
days_to_close | string | Days To Close |
degree | string | Degree |
field_of_study | string | Field of study |
first_conversion_date | string | First Conversion Date |
first_conversion_event_name | string | First Conversion |
first_deal_created_date | string | First Deal Created Date |
gender | string | Gender |
graduation_date | string | Graduation date |
hs_additional_emails | string | Additional email addresses |
hs_all_assigned_business_unit_ids | string | Business units |
hs_all_contact_vids | string | All vids for a contact |
hs_analytics_first_touch_converting_campaign | string | First Touch Converting Campaign |
hs_analytics_last_touch_converting_campaign | string | Last Touch Converting Campaign |
hs_avatar_filemanager_key | string | Avatar FileManager key |
hs_buying_role | string | Buying Role |
hs_calculated_form_submissions | string | All form submissions for a contact |
hs_calculated_merged_vids | string | Merged vids with timestamps of a contact |
hs_calculated_mobile_number | string | Calculated Mobile Number in International Format |
hs_calculated_phone_number | string | Calculated Phone Number in International Format |
hs_calculated_phone_number_area_code | string | Calculated Phone Number Area Code |
hs_calculated_phone_number_country_code | string | Calculated Phone Number Country Code |
hs_calculated_phone_number_region_code | string | Calculated Phone Number Region |
hs_content_membership_email_confirmed | boolean | Email Confirmed |
hs_content_membership_notes | string | Membership Notes |
hs_content_membership_registered_at | string | Registered At |
hs_content_membership_registration_domain_sent_to | string | Domain to which registration email was sent |
hs_content_membership_registration_email_sent_at | string | Time registration email was sent |
hs_content_membership_status | string | Status |
hs_conversations_visitor_email | string | Conversations visitor email |
hs_count_is_unworked | string | Count of unengaged contacts |
hs_count_is_worked | string | Count of engaged contacts |
hs_created_by_conversations | boolean | Created By Conversations |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Object create date/time |
hs_date_entered_customer | string | Date entered 'Customer (Lifecycle Stage Pipeline)' |
hs_date_entered_evangelist | string | Date entered 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_entered_lead | string | Date entered 'Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_marketingqualifiedlead | string | Date entered 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_opportunity | string | Date entered 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_entered_other | string | Date entered 'Other (Lifecycle Stage Pipeline)' |
hs_date_entered_salesqualifiedlead | string | Date entered 'Demo (Lifecycle Stage Pipeline)' |
hs_date_entered_subscriber | string | Date entered 'Subscriber (Lifecycle Stage Pipeline)' |
hs_date_exited_customer | string | Date exited 'Customer (Lifecycle Stage Pipeline)' |
hs_date_exited_evangelist | string | Date exited 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_exited_lead | string | Date exited 'Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_marketingqualifiedlead | string | Date exited 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_opportunity | string | Date exited 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_exited_other | string | Date exited 'Other (Lifecycle Stage Pipeline)' |
hs_date_exited_salesqualifiedlead | string | Date exited 'Demo (Lifecycle Stage Pipeline)' |
hs_date_exited_subscriber | string | Date exited 'Subscriber (Lifecycle Stage Pipeline)' |
hs_document_last_revisited | string | Recent Document Revisit Date |
hs_email_bad_address | boolean | Invalid email address |
hs_email_customer_quarantined_reason | string | Email address quarantine reason |
hs_email_domain | string | Email Domain |
hs_email_hard_bounce_reason | string | Email hard bounce reason |
hs_email_hard_bounce_reason_enum | string | Email hard bounce reason |
hs_email_quarantined | boolean | Email Address Quarantined |
hs_email_quarantined_reason | string | Email address automated quarantine reason |
hs_email_recipient_fatigue_recovery_time | string | Email Address Recipient Fatigue Next Available Sending Time |
hs_email_sends_since_last_engagement | string | Sends Since Last Engagement |
hs_emailconfirmationstatus | string | Marketing email confirmation status |
hs_facebook_ad_clicked | boolean | Clicked Facebook ad |
hs_facebook_click_id | string | Facebook click id |
hs_facebookid | string | Facebook ID |
hs_feedback_last_nps_follow_up | string | Last NPS survey comment |
hs_feedback_last_nps_rating | string | Last NPS survey rating |
hs_feedback_last_survey_date | string | Last NPS survey date |
hs_feedback_show_nps_web_survey | boolean | Should be shown an NPS web survey |
hs_first_engagement_object_id | string | ID of first engagement |
hs_first_subscription_create_date | string | First subscription create date |
hs_google_click_id | string | Google ad click id |
hs_googleplusid | string | googleplus ID |
hs_has_active_subscription | string | Contact has an active subscription |
hs_ip_timezone | string | IP Timezone |
hs_is_contact | boolean | Is a contact |
hs_is_unworked | boolean | Contact unworked |
hs_last_sales_activity_date | string | last sales activity date old |
hs_last_sales_activity_timestamp | string | Last Engagement Date |
hs_lastmodifieddate | string | Object last modified date/time |
hs_latest_sequence_ended_date | string | Last sequence ended date |
hs_latest_sequence_enrolled | string | Last sequence enrolled |
hs_latest_sequence_enrolled_date | string | Last sequence enrolled date |
hs_latest_sequence_finished_date | string | Last sequence finished date |
hs_latest_sequence_unenrolled_date | string | Last sequence unenrolled date |
hs_latest_source_timestamp | date | Latest Source Date |
hs_latest_subscription_create_date | string | Latest subscription create date |
hs_lead_status | string | Lead Status |
hs_legal_basis | string | Legal basis for processing contact's data |
hs_linkedinid | string | Linkedin ID |
hs_marketable_reason_id | string | Marketing contact status source name |
hs_marketable_reason_type | string | Marketing contact status source type |
hs_marketable_status | string | Marketing contact status |
hs_marketable_until_renewal | string | Marketing contact until next update |
hs_merged_object_ids | string | Merged object IDs |
hs_object_id | string | Contact ID |
hs_pipeline | string | Pipeline |
hs_predictivecontactscore_v2 | string | Likelihood to close |
hs_predictivescoringtier | string | Contact priority |
hs_sa_first_engagement_date | string | Date of first engagement |
hs_sa_first_engagement_descr | string | Description of first engagement |
hs_sa_first_engagement_object_type | string | Type of first engagement |
hs_sales_email_last_clicked | string | Recent Sales Email Clicked Date |
hs_sales_email_last_opened | string | Recent Sales Email Opened Date |
hs_searchable_calculated_international_mobile_number | string | Calculated Mobile Number with country code |
hs_searchable_calculated_international_phone_number | string | Calculated Phone Number with country code |
hs_searchable_calculated_mobile_number | string | Calculated Mobile Number without country code |
hs_searchable_calculated_phone_number | string | Calculated Phone Number without country code |
hs_sequences_actively_enrolled_count | string | Number of sequences actively enrolled |
hs_sequences_enrolled_count | string | Number of sequences enrolled |
hs_sequences_is_enrolled | boolean | Currently in Sequence |
hs_testpurge | string | testpurge |
hs_testrollback | string | testrollback |
hs_time_between_contact_creation_and_deal_close | string | Time between contact creation and deal close |
hs_time_between_contact_creation_and_deal_creation | string | Time between contact creation and deal creation |
hs_time_in_customer | string | Time in 'Customer (Lifecycle Stage Pipeline)' |
hs_time_in_evangelist | string | Time in 'Discovery (Lifecycle Stage Pipeline)' |
hs_time_in_lead | string | Time in 'Lead (Lifecycle Stage Pipeline)' |
hs_time_in_marketingqualifiedlead | string | Time in 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_time_in_opportunity | string | Time in 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_time_in_other | string | Time in 'Other (Lifecycle Stage Pipeline)' |
hs_time_in_salesqualifiedlead | string | Time in 'Demo (Lifecycle Stage Pipeline)' |
hs_time_in_subscriber | string | Time in 'Subscriber (Lifecycle Stage Pipeline)' |
hs_time_to_first_engagement | string | Lead response time |
hs_time_to_move_from_lead_to_customer | string | Time to move from lead to customer |
hs_time_to_move_from_marketingqualifiedlead_to_customer | string | Time to move from marketing qualified lead to customer |
hs_time_to_move_from_opportunity_to_customer | string | Time to move from opportunity to customer |
hs_time_to_move_from_salesqualifiedlead_to_customer | string | Time to move from sales qualified lead to customer |
hs_time_to_move_from_subscriber_to_customer | string | Time to move from subscriber to customer |
hs_timezone | string | Time Zone |
hs_twitterid | string | Twitter ID |
hs_unique_creation_key | string | Unique creation key |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
ip_city | string | IP City |
ip_country | string | IP Country |
ip_country_code | string | IP Country Code |
ip_latlon | string | IP Latitude & Longitude |
ip_state | string | IP State/Region |
ip_state_code | string | IP State Code/Region Code |
ip_zipcode | string | IP Zipcode |
job_function | string | Job function |
lastmodifieddate | string | Last Modified Date |
marital_status | string | Marital Status |
military_status | string | Military status |
num_associated_deals | string | Number of Associated Deals |
num_conversion_events | string | Number of Form Submissions |
num_unique_conversion_events | string | Number of Unique Forms Submitted |
recent_conversion_date | string | Recent Conversion Date |
recent_conversion_event_name | string | Recent Conversion |
recent_deal_amount | string | Recent Deal Amount |
recent_deal_close_date | string | Recent Deal Close Date |
relationship_status | string | Relationship Status |
school | string | School |
seniority | string | Seniority |
start_date | string | Start date |
total_revenue | string | Total Revenue |
work_email | string | Work email |
firstname | string | First Name |
hs_analytics_first_url | string | First Page Seen |
hs_email_delivered | string | Marketing emails delivered |
hs_email_optout_120944140 | string | Opted out of email: Marketing Information |
hs_email_optout_121085103 | string | Opted out of email: One to One |
hs_email_optout_127550586 | string | Opted out of email: Customer Service Communication |
twitterhandle | string | Twitter Username |
currentlyinworkflow | string | Currently in workflow |
followercount | string | Follower Count |
hs_analytics_last_url | string | Last Page Seen |
hs_email_open | string | Marketing emails opened |
lastname | string | Last Name |
hs_analytics_num_page_views | string | Number of Pageviews |
hs_email_click | string | Marketing emails clicked |
salutation | string | Salutation |
twitterprofilephoto | string | Twitter Profile Photo |
string | ||
hs_analytics_num_visits | string | Number of Sessions |
hs_email_bounce | string | Marketing emails bounced |
hs_persona | string | Persona |
hs_social_last_engagement | string | Most Recent Social Click |
hs_analytics_num_event_completions | string | Number of event completions |
hs_email_optout | boolean | Unsubscribed from all email |
hs_social_twitter_clicks | string | Twitter Clicks |
mobilephone | string | Mobile Phone Number |
phone | string | Phone Number |
fax | string | Fax Number |
hs_analytics_first_timestamp | string | Time First Seen |
hs_email_last_email_name | string | Last marketing email name |
hs_email_last_send_date | string | Last marketing email send date |
hs_social_facebook_clicks | string | Facebook Clicks |
address | string | Street Address |
engagements_last_meeting_booked | string | Date of last meeting booked in meetings tool |
engagements_last_meeting_booked_campaign | string | Campaign of last booking in meetings tool |
engagements_last_meeting_booked_medium | string | Medium of last booking in meetings tool |
engagements_last_meeting_booked_source | string | Source of last booking in meetings tool |
hs_analytics_first_visit_timestamp | string | Time of First Session |
hs_email_last_open_date | string | Last marketing email open date |
hs_latest_meeting_activity | string | Latest meeting activity |
hs_sales_email_last_replied | string | Recent Sales Email Replied Date |
hs_social_linkedin_clicks | string | LinkedIn Clicks |
hubspot_owner_id | string | Contact owner |
notes_last_contacted | string | Last Contacted |
notes_last_updated | string | Last Activity Date |
notes_next_activity_date | string | Next Activity Date |
num_contacted_notes | string | Number of times contacted |
num_notes | string | Number of Sales Activities |
owneremail | string | HubSpot Owner Email (legacy) |
ownername | string | HubSpot Owner Name (legacy) |
surveymonkeyeventlastupdated | string | SurveyMonkey Event Last Updated |
webinareventlastupdated | string | Webinar Event Last Updated |
city | string | City |
hs_analytics_last_timestamp | string | Time Last Seen |
hs_email_last_click_date | string | Last marketing email click date |
hs_social_google_plus_clicks | string | Google Plus Clicks |
hubspot_team_id | string | HubSpot Team |
linkedinbio | string | LinkedIn Bio |
twitterbio | string | Twitter Bio |
hs_all_owner_ids | string | All owner ids |
hs_analytics_last_visit_timestamp | string | Time of Last Session |
hs_email_first_send_date | string | First marketing email send date |
hs_social_num_broadcast_clicks | string | Broadcast Clicks |
state | string | State/Region |
hs_all_team_ids | string | All team ids |
hs_analytics_source | string | Original Source |
hs_email_first_open_date | string | First marketing email open date |
hs_latest_source | string | Latest Source |
zip | string | Postal Code |
country | string | Country |
hs_all_accessible_team_ids | string | All accessible team ids |
hs_analytics_source_data_1 | string | Original Source Drill-Down 1 |
hs_email_first_click_date | string | First marketing email click date |
hs_latest_source_data_1 | string | Latest Source Drill-Down 1 |
linkedinconnections | string | LinkedIn Connections |
hs_analytics_source_data_2 | string | Original Source Drill-Down 2 |
hs_email_is_ineligible | boolean | Is globally ineligible |
hs_language | string | Preferred language |
hs_latest_source_data_2 | string | Latest Source Drill-Down 2 |
kloutscoregeneral | string | Klout Score |
hs_analytics_first_referrer | string | First Referring Site |
hs_email_first_reply_date | string | First marketing email reply date |
jobtitle | string | Job Title |
photo | string | Photo |
hs_analytics_last_referrer | string | Last Referring Site |
hs_email_last_reply_date | string | Last marketing email reply date |
message | string | Message |
closedate | string | Close Date |
hs_analytics_average_page_views | string | Average Pageviews |
hs_email_replied | string | Marketing emails replied |
hs_analytics_revenue | string | Event Revenue |
hs_lifecyclestage_lead_date | string | Became a Lead Date |
hs_lifecyclestage_marketingqualifiedlead_date | string | Became a Marketing Qualified Lead Date |
hs_lifecyclestage_opportunity_date | string | Became an Opportunity Date |
lifecyclestage | string | Lifecycle Stage |
hs_lifecyclestage_salesqualifiedlead_date | string | Became a Sales Qualified Lead Date |
createdate | string | Create Date |
hs_lifecyclestage_evangelist_date | string | Became an Evangelist Date |
hs_lifecyclestage_customer_date | string | Became a Customer Date |
hubspotscore | string | HubSpot Score |
company | string | Company Name |
hs_lifecyclestage_subscriber_date | string | Became a Subscriber Date |
hs_lifecyclestage_other_date | string | Became an Other Lifecycle Date |
website | string | Website URL |
numemployees | string | Number of Employees |
annualrevenue | string | Annual Revenue |
industry | string | Industry |
associatedcompanyid | string | Associated Company ID |
associatedcompanylastupdated | string | Associated Company Last Updated |
hs_predictivecontactscorebucket | string | Lead Rating |
hs_predictivecontactscore | string | Predictive Lead Score |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Example
CREATE VIEW hubspot_v2_examples.example_Contacts
AS
SELECT * FROM hubspot_v2.Contacts (
preview => TRUE
)
Contacts_Associations
List associations of a contact by type
Parameter
<contactId> (optional): The ID of the contact
<contact_table> (optional): Table name with contact data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
contactId | string | The ID of the contact |
companyId | string | The ID of the company |
type | string | Association type |
Example
CREATE VIEW hubspot_v2_examples.example_Contacts_Associations
AS
SELECT * FROM hubspot_v2.Contacts_Associations (
preview => TRUE
)
Contacts_CreateAssociation
Associate a contact with company
Parameter
<contactId> (required): The ID of the contact
<companyId> (required): The ID of the company
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Contact ID |
company_size | string | Company size |
date_of_birth | string | Date of birth |
days_to_close | string | Days To Close |
degree | string | Degree |
field_of_study | string | Field of study |
first_conversion_date | string | First Conversion Date |
first_conversion_event_name | string | First Conversion |
first_deal_created_date | string | First Deal Created Date |
gender | string | Gender |
graduation_date | string | Graduation date |
hs_additional_emails | string | Additional email addresses |
hs_all_assigned_business_unit_ids | string | Business units |
hs_all_contact_vids | string | All vids for a contact |
hs_analytics_first_touch_converting_campaign | string | First Touch Converting Campaign |
hs_analytics_last_touch_converting_campaign | string | Last Touch Converting Campaign |
hs_avatar_filemanager_key | string | Avatar FileManager key |
hs_buying_role | string | Buying Role |
hs_calculated_form_submissions | string | All form submissions for a contact |
hs_calculated_merged_vids | string | Merged vids with timestamps of a contact |
hs_calculated_mobile_number | string | Calculated Mobile Number in International Format |
hs_calculated_phone_number | string | Calculated Phone Number in International Format |
hs_calculated_phone_number_area_code | string | Calculated Phone Number Area Code |
hs_calculated_phone_number_country_code | string | Calculated Phone Number Country Code |
hs_calculated_phone_number_region_code | string | Calculated Phone Number Region |
hs_content_membership_email_confirmed | string | Email Confirmed |
hs_content_membership_notes | string | Membership Notes |
hs_content_membership_registered_at | string | Registered At |
hs_content_membership_registration_domain_sent_to | string | Domain to which registration email was sent |
hs_content_membership_registration_email_sent_at | string | Time registration email was sent |
hs_content_membership_status | string | Status |
hs_conversations_visitor_email | string | Conversations visitor email |
hs_count_is_unworked | string | Count of unengaged contacts |
hs_count_is_worked | string | Count of engaged contacts |
hs_created_by_conversations | string | Created By Conversations |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Object create date/time |
hs_date_entered_customer | string | Date entered 'Customer (Lifecycle Stage Pipeline)' |
hs_date_entered_evangelist | string | Date entered 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_entered_lead | string | Date entered 'Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_marketingqualifiedlead | string | Date entered 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_opportunity | string | Date entered 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_entered_other | string | Date entered 'Other (Lifecycle Stage Pipeline)' |
hs_date_entered_salesqualifiedlead | string | Date entered 'Demo (Lifecycle Stage Pipeline)' |
hs_date_entered_subscriber | string | Date entered 'Subscriber (Lifecycle Stage Pipeline)' |
hs_date_exited_customer | string | Date exited 'Customer (Lifecycle Stage Pipeline)' |
hs_date_exited_evangelist | string | Date exited 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_exited_lead | string | Date exited 'Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_marketingqualifiedlead | string | Date exited 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_opportunity | string | Date exited 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_exited_other | string | Date exited 'Other (Lifecycle Stage Pipeline)' |
hs_date_exited_salesqualifiedlead | string | Date exited 'Demo (Lifecycle Stage Pipeline)' |
hs_date_exited_subscriber | string | Date exited 'Subscriber (Lifecycle Stage Pipeline)' |
hs_document_last_revisited | string | Recent Document Revisit Date |
hs_email_bad_address | string | Invalid email address |
hs_email_customer_quarantined_reason | string | Email address quarantine reason |
hs_email_domain | string | Email Domain |
hs_email_hard_bounce_reason | string | Email hard bounce reason |
hs_email_hard_bounce_reason_enum | string | Email hard bounce reason |
hs_email_quarantined | string | Email Address Quarantined |
hs_email_quarantined_reason | string | Email address automated quarantine reason |
hs_email_recipient_fatigue_recovery_time | string | Email Address Recipient Fatigue Next Available Sending Time |
hs_email_sends_since_last_engagement | string | Sends Since Last Engagement |
hs_emailconfirmationstatus | string | Marketing email confirmation status |
hs_facebook_ad_clicked | string | Clicked Facebook ad |
hs_facebook_click_id | string | Facebook click id |
hs_facebookid | string | Facebook ID |
hs_feedback_last_nps_follow_up | string | Last NPS survey comment |
hs_feedback_last_nps_rating | string | Last NPS survey rating |
hs_feedback_last_survey_date | string | Last NPS survey date |
hs_feedback_show_nps_web_survey | string | Should be shown an NPS web survey |
hs_first_engagement_object_id | string | ID of first engagement |
hs_first_subscription_create_date | string | First subscription create date |
hs_google_click_id | string | Google ad click id |
hs_googleplusid | string | googleplus ID |
hs_has_active_subscription | string | Contact has an active subscription |
hs_ip_timezone | string | IP Timezone |
hs_is_contact | string | Is a contact |
hs_is_unworked | string | Contact unworked |
hs_last_sales_activity_date | string | last sales activity date old |
hs_last_sales_activity_timestamp | string | Last Engagement Date |
hs_lastmodifieddate | string | Object last modified date/time |
hs_latest_sequence_ended_date | string | Last sequence ended date |
hs_latest_sequence_enrolled | string | Last sequence enrolled |
hs_latest_sequence_enrolled_date | string | Last sequence enrolled date |
hs_latest_sequence_finished_date | string | Last sequence finished date |
hs_latest_sequence_unenrolled_date | string | Last sequence unenrolled date |
hs_latest_source_timestamp | string | Latest Source Date |
hs_latest_subscription_create_date | string | Latest subscription create date |
hs_lead_status | string | Lead Status |
hs_legal_basis | string | Legal basis for processing contact's data |
hs_linkedinid | string | Linkedin ID |
hs_marketable_reason_id | string | Marketing contact status source name |
hs_marketable_reason_type | string | Marketing contact status source type |
hs_marketable_status | string | Marketing contact status |
hs_marketable_until_renewal | string | Marketing contact until next update |
hs_merged_object_ids | string | Merged object IDs |
hs_object_id | string | Contact ID |
hs_pipeline | string | Pipeline |
hs_predictivecontactscore_v2 | string | Likelihood to close |
hs_predictivescoringtier | string | Contact priority |
hs_sa_first_engagement_date | string | Date of first engagement |
hs_sa_first_engagement_descr | string | Description of first engagement |
hs_sa_first_engagement_object_type | string | Type of first engagement |
hs_sales_email_last_clicked | string | Recent Sales Email Clicked Date |
hs_sales_email_last_opened | string | Recent Sales Email Opened Date |
hs_searchable_calculated_international_mobile_number | string | Calculated Mobile Number with country code |
hs_searchable_calculated_international_phone_number | string | Calculated Phone Number with country code |
hs_searchable_calculated_mobile_number | string | Calculated Mobile Number without country code |
hs_searchable_calculated_phone_number | string | Calculated Phone Number without country code |
hs_sequences_actively_enrolled_count | string | Number of sequences actively enrolled |
hs_sequences_enrolled_count | string | Number of sequences enrolled |
hs_sequences_is_enrolled | string | Currently in Sequence |
hs_testpurge | string | testpurge |
hs_testrollback | string | testrollback |
hs_time_between_contact_creation_and_deal_close | string | Time between contact creation and deal close |
hs_time_between_contact_creation_and_deal_creation | string | Time between contact creation and deal creation |
hs_time_in_customer | string | Time in 'Customer (Lifecycle Stage Pipeline)' |
hs_time_in_evangelist | string | Time in 'Discovery (Lifecycle Stage Pipeline)' |
hs_time_in_lead | string | Time in 'Lead (Lifecycle Stage Pipeline)' |
hs_time_in_marketingqualifiedlead | string | Time in 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_time_in_opportunity | string | Time in 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_time_in_other | string | Time in 'Other (Lifecycle Stage Pipeline)' |
hs_time_in_salesqualifiedlead | string | Time in 'Demo (Lifecycle Stage Pipeline)' |
hs_time_in_subscriber | string | Time in 'Subscriber (Lifecycle Stage Pipeline)' |
hs_time_to_first_engagement | string | Lead response time |
hs_time_to_move_from_lead_to_customer | string | Time to move from lead to customer |
hs_time_to_move_from_marketingqualifiedlead_to_customer | string | Time to move from marketing qualified lead to customer |
hs_time_to_move_from_opportunity_to_customer | string | Time to move from opportunity to customer |
hs_time_to_move_from_salesqualifiedlead_to_customer | string | Time to move from sales qualified lead to customer |
hs_time_to_move_from_subscriber_to_customer | string | Time to move from subscriber to customer |
hs_timezone | string | Time Zone |
hs_twitterid | string | Twitter ID |
hs_unique_creation_key | string | Unique creation key |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
ip_city | string | IP City |
ip_country | string | IP Country |
ip_country_code | string | IP Country Code |
ip_latlon | string | IP Latitude & Longitude |
ip_state | string | IP State/Region |
ip_state_code | string | IP State Code/Region Code |
ip_zipcode | string | IP Zipcode |
job_function | string | Job function |
lastmodifieddate | string | Last Modified Date |
marital_status | string | Marital Status |
military_status | string | Military status |
num_associated_deals | string | Number of Associated Deals |
num_conversion_events | string | Number of Form Submissions |
num_unique_conversion_events | string | Number of Unique Forms Submitted |
recent_conversion_date | string | Recent Conversion Date |
recent_conversion_event_name | string | Recent Conversion |
recent_deal_amount | string | Recent Deal Amount |
recent_deal_close_date | string | Recent Deal Close Date |
relationship_status | string | Relationship Status |
school | string | School |
seniority | string | Seniority |
start_date | string | Start date |
total_revenue | string | Total Revenue |
work_email | string | Work email |
firstname | string | First Name |
hs_analytics_first_url | string | First Page Seen |
hs_email_delivered | string | Marketing emails delivered |
hs_email_optout_120944140 | string | Opted out of email: Marketing Information |
hs_email_optout_121085103 | string | Opted out of email: One to One |
hs_email_optout_127550586 | string | Opted out of email: Customer Service Communication |
twitterhandle | string | Twitter Username |
currentlyinworkflow | string | Currently in workflow |
followercount | string | Follower Count |
hs_analytics_last_url | string | Last Page Seen |
hs_email_open | string | Marketing emails opened |
lastname | string | Last Name |
hs_analytics_num_page_views | string | Number of Pageviews |
hs_email_click | string | Marketing emails clicked |
salutation | string | Salutation |
twitterprofilephoto | string | Twitter Profile Photo |
string | ||
hs_analytics_num_visits | string | Number of Sessions |
hs_email_bounce | string | Marketing emails bounced |
hs_persona | string | Persona |
hs_social_last_engagement | string | Most Recent Social Click |
hs_analytics_num_event_completions | string | Number of event completions |
hs_email_optout | string | Unsubscribed from all email |
hs_social_twitter_clicks | string | Twitter Clicks |
mobilephone | string | Mobile Phone Number |
phone | string | Phone Number |
fax | string | Fax Number |
hs_analytics_first_timestamp | string | Time First Seen |
hs_email_last_email_name | string | Last marketing email name |
hs_email_last_send_date | string | Last marketing email send date |
hs_social_facebook_clicks | string | Facebook Clicks |
address | string | Street Address |
engagements_last_meeting_booked | string | Date of last meeting booked in meetings tool |
engagements_last_meeting_booked_campaign | string | Campaign of last booking in meetings tool |
engagements_last_meeting_booked_medium | string | Medium of last booking in meetings tool |
engagements_last_meeting_booked_source | string | Source of last booking in meetings tool |
hs_analytics_first_visit_timestamp | string | Time of First Session |
hs_email_last_open_date | string | Last marketing email open date |
hs_latest_meeting_activity | string | Latest meeting activity |
hs_sales_email_last_replied | string | Recent Sales Email Replied Date |
hs_social_linkedin_clicks | string | LinkedIn Clicks |
hubspot_owner_id | string | Contact owner |
notes_last_contacted | string | Last Contacted |
notes_last_updated | string | Last Activity Date |
notes_next_activity_date | string | Next Activity Date |
num_contacted_notes | string | Number of times contacted |
num_notes | string | Number of Sales Activities |
owneremail | string | HubSpot Owner Email (legacy) |
ownername | string | HubSpot Owner Name (legacy) |
surveymonkeyeventlastupdated | string | SurveyMonkey Event Last Updated |
webinareventlastupdated | string | Webinar Event Last Updated |
city | string | City |
hs_analytics_last_timestamp | string | Time Last Seen |
hs_email_last_click_date | string | Last marketing email click date |
hs_social_google_plus_clicks | string | Google Plus Clicks |
hubspot_team_id | string | HubSpot Team |
linkedinbio | string | LinkedIn Bio |
twitterbio | string | Twitter Bio |
hs_all_owner_ids | string | All owner ids |
hs_analytics_last_visit_timestamp | string | Time of Last Session |
hs_email_first_send_date | string | First marketing email send date |
hs_social_num_broadcast_clicks | string | Broadcast Clicks |
state | string | State/Region |
hs_all_team_ids | string | All team ids |
hs_analytics_source | string | Original Source |
hs_email_first_open_date | string | First marketing email open date |
hs_latest_source | string | Latest Source |
zip | string | Postal Code |
country | string | Country |
hs_all_accessible_team_ids | string | All accessible team ids |
hs_analytics_source_data_1 | string | Original Source Drill-Down 1 |
hs_email_first_click_date | string | First marketing email click date |
hs_latest_source_data_1 | string | Latest Source Drill-Down 1 |
linkedinconnections | string | LinkedIn Connections |
hs_analytics_source_data_2 | string | Original Source Drill-Down 2 |
hs_email_is_ineligible | string | Is globally ineligible |
hs_language | string | Preferred language |
hs_latest_source_data_2 | string | Latest Source Drill-Down 2 |
kloutscoregeneral | string | Klout Score |
hs_analytics_first_referrer | string | First Referring Site |
hs_email_first_reply_date | string | First marketing email reply date |
jobtitle | string | Job Title |
photo | string | Photo |
hs_analytics_last_referrer | string | Last Referring Site |
hs_email_last_reply_date | string | Last marketing email reply date |
message | string | Message |
closedate | string | Close Date |
hs_analytics_average_page_views | string | Average Pageviews |
hs_email_replied | string | Marketing emails replied |
hs_analytics_revenue | string | Event Revenue |
hs_lifecyclestage_lead_date | string | Became a Lead Date |
hs_lifecyclestage_marketingqualifiedlead_date | string | Became a Marketing Qualified Lead Date |
hs_lifecyclestage_opportunity_date | string | Became an Opportunity Date |
lifecyclestage | string | Lifecycle Stage |
hs_lifecyclestage_salesqualifiedlead_date | string | Became a Sales Qualified Lead Date |
createdate | string | Create Date |
hs_lifecyclestage_evangelist_date | string | Became an Evangelist Date |
hs_lifecyclestage_customer_date | string | Became a Customer Date |
hubspotscore | string | HubSpot Score |
company | string | Company Name |
hs_lifecyclestage_subscriber_date | string | Became a Subscriber Date |
hs_lifecyclestage_other_date | string | Became an Other Lifecycle Date |
website | string | Website URL |
numemployees | string | Number of Employees |
annualrevenue | string | Annual Revenue |
industry | string | Industry |
associatedcompanyid | string | Associated Company ID |
associatedcompanylastupdated | string | Associated Company Last Updated |
hs_predictivecontactscorebucket | string | Lead Rating |
hs_predictivecontactscore | string | Predictive Lead Score |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Contacts_CreateOrUpdate
Create or Update contact
Parameter
<contactId> (optional): The ID of the contact. If this value is null, then the contact is created. If this value is specified, then the contact with this ID will be updated
<properties> (required): The line of contact properties. Should be supplied in json. "{"firstname" : "The First Name","email" : "Email"
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Contact ID |
company_size | string | Company size |
date_of_birth | string | Date of birth |
days_to_close | string | Days To Close |
degree | string | Degree |
field_of_study | string | Field of study |
first_conversion_date | string | First Conversion Date |
first_conversion_event_name | string | First Conversion |
first_deal_created_date | string | First Deal Created Date |
gender | string | Gender |
graduation_date | string | Graduation date |
hs_additional_emails | string | Additional email addresses |
hs_all_assigned_business_unit_ids | string | Business units |
hs_all_contact_vids | string | All vids for a contact |
hs_analytics_first_touch_converting_campaign | string | First Touch Converting Campaign |
hs_analytics_last_touch_converting_campaign | string | Last Touch Converting Campaign |
hs_avatar_filemanager_key | string | Avatar FileManager key |
hs_buying_role | string | Buying Role |
hs_calculated_form_submissions | string | All form submissions for a contact |
hs_calculated_merged_vids | string | Merged vids with timestamps of a contact |
hs_calculated_mobile_number | string | Calculated Mobile Number in International Format |
hs_calculated_phone_number | string | Calculated Phone Number in International Format |
hs_calculated_phone_number_area_code | string | Calculated Phone Number Area Code |
hs_calculated_phone_number_country_code | string | Calculated Phone Number Country Code |
hs_calculated_phone_number_region_code | string | Calculated Phone Number Region |
hs_content_membership_email_confirmed | string | Email Confirmed |
hs_content_membership_notes | string | Membership Notes |
hs_content_membership_registered_at | string | Registered At |
hs_content_membership_registration_domain_sent_to | string | Domain to which registration email was sent |
hs_content_membership_registration_email_sent_at | string | Time registration email was sent |
hs_content_membership_status | string | Status |
hs_conversations_visitor_email | string | Conversations visitor email |
hs_count_is_unworked | string | Count of unengaged contacts |
hs_count_is_worked | string | Count of engaged contacts |
hs_created_by_conversations | string | Created By Conversations |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Object create date/time |
hs_date_entered_customer | string | Date entered 'Customer (Lifecycle Stage Pipeline)' |
hs_date_entered_evangelist | string | Date entered 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_entered_lead | string | Date entered 'Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_marketingqualifiedlead | string | Date entered 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_entered_opportunity | string | Date entered 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_entered_other | string | Date entered 'Other (Lifecycle Stage Pipeline)' |
hs_date_entered_salesqualifiedlead | string | Date entered 'Demo (Lifecycle Stage Pipeline)' |
hs_date_entered_subscriber | string | Date entered 'Subscriber (Lifecycle Stage Pipeline)' |
hs_date_exited_customer | string | Date exited 'Customer (Lifecycle Stage Pipeline)' |
hs_date_exited_evangelist | string | Date exited 'Discovery (Lifecycle Stage Pipeline)' |
hs_date_exited_lead | string | Date exited 'Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_marketingqualifiedlead | string | Date exited 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_date_exited_opportunity | string | Date exited 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_date_exited_other | string | Date exited 'Other (Lifecycle Stage Pipeline)' |
hs_date_exited_salesqualifiedlead | string | Date exited 'Demo (Lifecycle Stage Pipeline)' |
hs_date_exited_subscriber | string | Date exited 'Subscriber (Lifecycle Stage Pipeline)' |
hs_document_last_revisited | string | Recent Document Revisit Date |
hs_email_bad_address | string | Invalid email address |
hs_email_customer_quarantined_reason | string | Email address quarantine reason |
hs_email_domain | string | Email Domain |
hs_email_hard_bounce_reason | string | Email hard bounce reason |
hs_email_hard_bounce_reason_enum | string | Email hard bounce reason |
hs_email_quarantined | string | Email Address Quarantined |
hs_email_quarantined_reason | string | Email address automated quarantine reason |
hs_email_recipient_fatigue_recovery_time | string | Email Address Recipient Fatigue Next Available Sending Time |
hs_email_sends_since_last_engagement | string | Sends Since Last Engagement |
hs_emailconfirmationstatus | string | Marketing email confirmation status |
hs_facebook_ad_clicked | string | Clicked Facebook ad |
hs_facebook_click_id | string | Facebook click id |
hs_facebookid | string | Facebook ID |
hs_feedback_last_nps_follow_up | string | Last NPS survey comment |
hs_feedback_last_nps_rating | string | Last NPS survey rating |
hs_feedback_last_survey_date | string | Last NPS survey date |
hs_feedback_show_nps_web_survey | string | Should be shown an NPS web survey |
hs_first_engagement_object_id | string | ID of first engagement |
hs_first_subscription_create_date | string | First subscription create date |
hs_google_click_id | string | Google ad click id |
hs_googleplusid | string | googleplus ID |
hs_has_active_subscription | string | Contact has an active subscription |
hs_ip_timezone | string | IP Timezone |
hs_is_contact | string | Is a contact |
hs_is_unworked | string | Contact unworked |
hs_last_sales_activity_date | string | last sales activity date old |
hs_last_sales_activity_timestamp | string | Last Engagement Date |
hs_lastmodifieddate | string | Object last modified date/time |
hs_latest_sequence_ended_date | string | Last sequence ended date |
hs_latest_sequence_enrolled | string | Last sequence enrolled |
hs_latest_sequence_enrolled_date | string | Last sequence enrolled date |
hs_latest_sequence_finished_date | string | Last sequence finished date |
hs_latest_sequence_unenrolled_date | string | Last sequence unenrolled date |
hs_latest_source_timestamp | string | Latest Source Date |
hs_latest_subscription_create_date | string | Latest subscription create date |
hs_lead_status | string | Lead Status |
hs_legal_basis | string | Legal basis for processing contact's data |
hs_linkedinid | string | Linkedin ID |
hs_marketable_reason_id | string | Marketing contact status source name |
hs_marketable_reason_type | string | Marketing contact status source type |
hs_marketable_status | string | Marketing contact status |
hs_marketable_until_renewal | string | Marketing contact until next update |
hs_merged_object_ids | string | Merged object IDs |
hs_object_id | string | Contact ID |
hs_pipeline | string | Pipeline |
hs_predictivecontactscore_v2 | string | Likelihood to close |
hs_predictivescoringtier | string | Contact priority |
hs_sa_first_engagement_date | string | Date of first engagement |
hs_sa_first_engagement_descr | string | Description of first engagement |
hs_sa_first_engagement_object_type | string | Type of first engagement |
hs_sales_email_last_clicked | string | Recent Sales Email Clicked Date |
hs_sales_email_last_opened | string | Recent Sales Email Opened Date |
hs_searchable_calculated_international_mobile_number | string | Calculated Mobile Number with country code |
hs_searchable_calculated_international_phone_number | string | Calculated Phone Number with country code |
hs_searchable_calculated_mobile_number | string | Calculated Mobile Number without country code |
hs_searchable_calculated_phone_number | string | Calculated Phone Number without country code |
hs_sequences_actively_enrolled_count | string | Number of sequences actively enrolled |
hs_sequences_enrolled_count | string | Number of sequences enrolled |
hs_sequences_is_enrolled | string | Currently in Sequence |
hs_testpurge | string | testpurge |
hs_testrollback | string | testrollback |
hs_time_between_contact_creation_and_deal_close | string | Time between contact creation and deal close |
hs_time_between_contact_creation_and_deal_creation | string | Time between contact creation and deal creation |
hs_time_in_customer | string | Time in 'Customer (Lifecycle Stage Pipeline)' |
hs_time_in_evangelist | string | Time in 'Discovery (Lifecycle Stage Pipeline)' |
hs_time_in_lead | string | Time in 'Lead (Lifecycle Stage Pipeline)' |
hs_time_in_marketingqualifiedlead | string | Time in 'Marketing Qualified Lead (Lifecycle Stage Pipeline)' |
hs_time_in_opportunity | string | Time in 'PoC Ready / SQL (Lifecycle Stage Pipeline)' |
hs_time_in_other | string | Time in 'Other (Lifecycle Stage Pipeline)' |
hs_time_in_salesqualifiedlead | string | Time in 'Demo (Lifecycle Stage Pipeline)' |
hs_time_in_subscriber | string | Time in 'Subscriber (Lifecycle Stage Pipeline)' |
hs_time_to_first_engagement | string | Lead response time |
hs_time_to_move_from_lead_to_customer | string | Time to move from lead to customer |
hs_time_to_move_from_marketingqualifiedlead_to_customer | string | Time to move from marketing qualified lead to customer |
hs_time_to_move_from_opportunity_to_customer | string | Time to move from opportunity to customer |
hs_time_to_move_from_salesqualifiedlead_to_customer | string | Time to move from sales qualified lead to customer |
hs_time_to_move_from_subscriber_to_customer | string | Time to move from subscriber to customer |
hs_timezone | string | Time Zone |
hs_twitterid | string | Twitter ID |
hs_unique_creation_key | string | Unique creation key |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
ip_city | string | IP City |
ip_country | string | IP Country |
ip_country_code | string | IP Country Code |
ip_latlon | string | IP Latitude & Longitude |
ip_state | string | IP State/Region |
ip_state_code | string | IP State Code/Region Code |
ip_zipcode | string | IP Zipcode |
job_function | string | Job function |
lastmodifieddate | string | Last Modified Date |
marital_status | string | Marital Status |
military_status | string | Military status |
num_associated_deals | string | Number of Associated Deals |
num_conversion_events | string | Number of Form Submissions |
num_unique_conversion_events | string | Number of Unique Forms Submitted |
recent_conversion_date | string | Recent Conversion Date |
recent_conversion_event_name | string | Recent Conversion |
recent_deal_amount | string | Recent Deal Amount |
recent_deal_close_date | string | Recent Deal Close Date |
relationship_status | string | Relationship Status |
school | string | School |
seniority | string | Seniority |
start_date | string | Start date |
total_revenue | string | Total Revenue |
work_email | string | Work email |
firstname | string | First Name |
hs_analytics_first_url | string | First Page Seen |
hs_email_delivered | string | Marketing emails delivered |
hs_email_optout_120944140 | string | Opted out of email: Marketing Information |
hs_email_optout_121085103 | string | Opted out of email: One to One |
hs_email_optout_127550586 | string | Opted out of email: Customer Service Communication |
twitterhandle | string | Twitter Username |
currentlyinworkflow | string | Currently in workflow |
followercount | string | Follower Count |
hs_analytics_last_url | string | Last Page Seen |
hs_email_open | string | Marketing emails opened |
lastname | string | Last Name |
hs_analytics_num_page_views | string | Number of Pageviews |
hs_email_click | string | Marketing emails clicked |
salutation | string | Salutation |
twitterprofilephoto | string | Twitter Profile Photo |
string | ||
hs_analytics_num_visits | string | Number of Sessions |
hs_email_bounce | string | Marketing emails bounced |
hs_persona | string | Persona |
hs_social_last_engagement | string | Most Recent Social Click |
hs_analytics_num_event_completions | string | Number of event completions |
hs_email_optout | string | Unsubscribed from all email |
hs_social_twitter_clicks | string | Twitter Clicks |
mobilephone | string | Mobile Phone Number |
phone | string | Phone Number |
fax | string | Fax Number |
hs_analytics_first_timestamp | string | Time First Seen |
hs_email_last_email_name | string | Last marketing email name |
hs_email_last_send_date | string | Last marketing email send date |
hs_social_facebook_clicks | string | Facebook Clicks |
address | string | Street Address |
engagements_last_meeting_booked | string | Date of last meeting booked in meetings tool |
engagements_last_meeting_booked_campaign | string | Campaign of last booking in meetings tool |
engagements_last_meeting_booked_medium | string | Medium of last booking in meetings tool |
engagements_last_meeting_booked_source | string | Source of last booking in meetings tool |
hs_analytics_first_visit_timestamp | string | Time of First Session |
hs_email_last_open_date | string | Last marketing email open date |
hs_latest_meeting_activity | string | Latest meeting activity |
hs_sales_email_last_replied | string | Recent Sales Email Replied Date |
hs_social_linkedin_clicks | string | LinkedIn Clicks |
hubspot_owner_id | string | Contact owner |
notes_last_contacted | string | Last Contacted |
notes_last_updated | string | Last Activity Date |
notes_next_activity_date | string | Next Activity Date |
num_contacted_notes | string | Number of times contacted |
num_notes | string | Number of Sales Activities |
owneremail | string | HubSpot Owner Email (legacy) |
ownername | string | HubSpot Owner Name (legacy) |
surveymonkeyeventlastupdated | string | SurveyMonkey Event Last Updated |
webinareventlastupdated | string | Webinar Event Last Updated |
city | string | City |
hs_analytics_last_timestamp | string | Time Last Seen |
hs_email_last_click_date | string | Last marketing email click date |
hs_social_google_plus_clicks | string | Google Plus Clicks |
hubspot_team_id | string | HubSpot Team |
linkedinbio | string | LinkedIn Bio |
twitterbio | string | Twitter Bio |
hs_all_owner_ids | string | All owner ids |
hs_analytics_last_visit_timestamp | string | Time of Last Session |
hs_email_first_send_date | string | First marketing email send date |
hs_social_num_broadcast_clicks | string | Broadcast Clicks |
state | string | State/Region |
hs_all_team_ids | string | All team ids |
hs_analytics_source | string | Original Source |
hs_email_first_open_date | string | First marketing email open date |
hs_latest_source | string | Latest Source |
zip | string | Postal Code |
country | string | Country |
hs_all_accessible_team_ids | string | All accessible team ids |
hs_analytics_source_data_1 | string | Original Source Drill-Down 1 |
hs_email_first_click_date | string | First marketing email click date |
hs_latest_source_data_1 | string | Latest Source Drill-Down 1 |
linkedinconnections | string | LinkedIn Connections |
hs_analytics_source_data_2 | string | Original Source Drill-Down 2 |
hs_email_is_ineligible | string | Is globally ineligible |
hs_language | string | Preferred language |
hs_latest_source_data_2 | string | Latest Source Drill-Down 2 |
kloutscoregeneral | string | Klout Score |
hs_analytics_first_referrer | string | First Referring Site |
hs_email_first_reply_date | string | First marketing email reply date |
jobtitle | string | Job Title |
photo | string | Photo |
hs_analytics_last_referrer | string | Last Referring Site |
hs_email_last_reply_date | string | Last marketing email reply date |
message | string | Message |
closedate | string | Close Date |
hs_analytics_average_page_views | string | Average Pageviews |
hs_email_replied | string | Marketing emails replied |
hs_analytics_revenue | string | Event Revenue |
hs_lifecyclestage_lead_date | string | Became a Lead Date |
hs_lifecyclestage_marketingqualifiedlead_date | string | Became a Marketing Qualified Lead Date |
hs_lifecyclestage_opportunity_date | string | Became an Opportunity Date |
lifecyclestage | string | Lifecycle Stage |
hs_lifecyclestage_salesqualifiedlead_date | string | Became a Sales Qualified Lead Date |
createdate | string | Create Date |
hs_lifecyclestage_evangelist_date | string | Became an Evangelist Date |
hs_lifecyclestage_customer_date | string | Became a Customer Date |
hubspotscore | string | HubSpot Score |
company | string | Company Name |
hs_lifecyclestage_subscriber_date | string | Became a Subscriber Date |
hs_lifecyclestage_other_date | string | Became an Other Lifecycle Date |
website | string | Website URL |
numemployees | string | Number of Employees |
annualrevenue | string | Annual Revenue |
industry | string | Industry |
associatedcompanyid | string | Associated Company ID |
associatedcompanylastupdated | string | Associated Company Last Updated |
hs_predictivecontactscorebucket | string | Lead Rating |
hs_predictivecontactscore | string | Predictive Lead Score |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Contacts_DeleteAssociation
Removes a contact's association with a company
Parameter
<contactId> (required): The ID of the contact
<companyId> (required): The ID of the company
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
CreateProcedure_Calls
Creates procedure Calls by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Calls_CreateAssociation
Creates procedure Calls_CreateAssociation by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Calls_CreateOrUpdate
Creates procedure Calls_CreateOrUpdate by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Companies
Creates procedure Companies by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Companies_CreateOrUpdate
Creates procedure Companies_CreateOrUpdate by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Contacts
Creates procedure Contacts by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Contacts_CreateAssociation
Creates procedure Contacts_CreateAssociation by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Contacts_CreateOrUpdate
Creates procedure Contacts_CreateOrUpdate by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Deals
Creates procedure Deals by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Deals_CreateAssociation
Creates procedure Deals_CreateAssociation by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Deals_CreateOrUpdate
Creates procedure Deals_CreateOrUpdate by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Deals_GetAssociatedDeals
Creates procedure Deals by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Emails
Creates procedure Emails by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Emails_CreateAssociation
Creates procedure Emails_CreateAssociation by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Emails_CreateOrUpdate
Creates procedure Emails_CreateOrUpdate by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Meetings
Creates procedure Meetings by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Meetings_CreateAssociation
Creates procedure Meetings_CreateAssociation by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Meetings_CreateOrUpdate
Creates procedure Meetings_CreateOrUpdate by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Notes
Creates procedure Notes by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Notes_CreateAssociation
Creates procedure Notes_CreateAssociation by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Notes_CreateOrUpdate
Creates procedure Notes_CreateOrUpdate by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Tasks
Creates procedure Tasks by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Tasks_CreateAssociation
Creates procedure Tasks_CreateAssociation by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
CreateProcedure_Tasks_CreateOrUpdate
Creates procedure Tasks_CreateOrUpdate by adjusting it's output to all available fields
Parameter
<label> (optional):
Attribute | Type | Description |
---|
Deals
List of deals
Parameter
<archived> (optional): Whether to return only results that have been archived
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Deal ID |
amount_in_home_currency | string | Amount in company currency |
days_to_close | string | Days to close |
deal_currency_code | string | Currency |
hs_acv | string | Annual contract value |
hs_all_assigned_business_unit_ids | string | Business units |
hs_all_deal_split_owner_ids | string | Deal Split Users |
hs_analytics_source | string | Original Source Type |
hs_analytics_source_data_1 | string | Original Source Data 1 |
hs_analytics_source_data_2 | string | Original Source Data 2 |
hs_arr | string | Annual recurring revenue |
hs_campaign | string | HubSpot Campaign |
hs_closed_amount | string | Closed Deal Amount |
hs_closed_amount_in_home_currency | string | Closed Deal Amount In Home Currency |
hs_created_by_user_id | string | Created by user ID |
hs_date_entered_13094129 | string | Date entered 'New (Renewal Pipeline)' |
hs_date_entered_13094130 | string | Date entered 'Past Termination (Renewal Pipeline)' |
hs_date_entered_13094131 | string | Date entered 'Negotiation (Renewal Pipeline)' |
hs_date_entered_13094134 | string | Date entered 'Closed won (Renewal Pipeline)' |
hs_date_entered_13094135 | string | Date entered 'Closed lost (Renewal Pipeline)' |
hs_date_entered_13103592 | string | Date entered 'Trial Signup (Data Virtuality Pipes)' |
hs_date_entered_13103593 | string | Date entered 'Activation (Data Virtuality Pipes)' |
hs_date_entered_13103594 | string | Date entered 'DWH Connected (Data Virtuality Pipes)' |
hs_date_entered_13103595 | string | Date entered 'Pipes Running (Data Virtuality Pipes)' |
hs_date_entered_13103596 | string | Date entered 'Negotiation (Data Virtuality Pipes)' |
hs_date_entered_13103597 | string | Date entered 'Closed won (Data Virtuality Pipes)' |
hs_date_entered_13103598 | string | Date entered 'Closed lost (Data Virtuality Pipes)' |
hs_date_entered_13275376 | string | Date entered 'New (Partner Acquisition)' |
hs_date_entered_13275377 | string | Date entered 'Qualification (Partner Acquisition)' |
hs_date_entered_13275378 | string | Date entered 'Negotiation (Partner Acquisition)' |
hs_date_entered_13275381 | string | Date entered 'Closed won (Partner Acquisition)' |
hs_date_entered_13275382 | string | Date entered 'Closed lost (Partner Acquisition)' |
hs_date_entered_appointmentscheduled | string | Date entered 'New (Data Virtuality Platform)' |
hs_date_entered_closedlost | string | Date entered 'Closed Lost (Data Virtuality Platform)' |
hs_date_entered_closedwon | string | Date entered 'Closed Won (Data Virtuality Platform)' |
hs_date_entered_contractsent | string | Date entered 'Contract Sent (Data Virtuality Platform)' |
hs_date_entered_decisionmakerboughtin | string | Date entered 'Decision (Data Virtuality Platform)' |
hs_date_entered_presentationscheduled | string | Date entered 'Negotiation (Data Virtuality Platform)' |
hs_date_entered_qualifiedtobuy | string | Date entered 'PoC (Data Virtuality Platform)' |
hs_date_exited_13094129 | string | Date exited 'New (Renewal Pipeline)' |
hs_date_exited_13094130 | string | Date exited 'Past Termination (Renewal Pipeline)' |
hs_date_exited_13094131 | string | Date exited 'Negotiation (Renewal Pipeline)' |
hs_date_exited_13094134 | string | Date exited 'Closed won (Renewal Pipeline)' |
hs_date_exited_13094135 | string | Date exited 'Closed lost (Renewal Pipeline)' |
hs_date_exited_13103592 | string | Date exited 'Trial Signup (Data Virtuality Pipes)' |
hs_date_exited_13103593 | string | Date exited 'Activation (Data Virtuality Pipes)' |
hs_date_exited_13103594 | string | Date exited 'DWH Connected (Data Virtuality Pipes)' |
hs_date_exited_13103595 | string | Date exited 'Pipes Running (Data Virtuality Pipes)' |
hs_date_exited_13103596 | string | Date exited 'Negotiation (Data Virtuality Pipes)' |
hs_date_exited_13103597 | string | Date exited 'Closed won (Data Virtuality Pipes)' |
hs_date_exited_13103598 | string | Date exited 'Closed lost (Data Virtuality Pipes)' |
hs_date_exited_13275376 | string | Date exited 'New (Partner Acquisition)' |
hs_date_exited_13275377 | string | Date exited 'Qualification (Partner Acquisition)' |
hs_date_exited_13275378 | string | Date exited 'Negotiation (Partner Acquisition)' |
hs_date_exited_13275381 | string | Date exited 'Closed won (Partner Acquisition)' |
hs_date_exited_13275382 | string | Date exited 'Closed lost (Partner Acquisition)' |
hs_date_exited_appointmentscheduled | string | Date exited 'New (Data Virtuality Platform)' |
hs_date_exited_closedlost | string | Date exited 'Closed Lost (Data Virtuality Platform)' |
hs_date_exited_closedwon | string | Date exited 'Closed Won (Data Virtuality Platform)' |
hs_date_exited_contractsent | string | Date exited 'Contract Sent (Data Virtuality Platform)' |
hs_date_exited_decisionmakerboughtin | string | Date exited 'Decision (Data Virtuality Platform)' |
hs_date_exited_presentationscheduled | string | Date exited 'Negotiation (Data Virtuality Platform)' |
hs_date_exited_qualifiedtobuy | string | Date exited 'PoC (Data Virtuality Platform)' |
hs_deal_amount_calculation_preference | string | Deal amount calculation preference |
hs_deal_stage_probability | string | Deal probability |
hs_deal_stage_probability_shadow | string | Deal stage probability shadow |
hs_forecast_amount | string | Forecast amount |
hs_forecast_probability | string | Forecast probability |
hs_is_closed | boolean | Is Deal Closed? |
hs_is_closed_won | boolean | Is Closed Won |
hs_is_deal_split | boolean | Deal Split Added |
hs_lastmodifieddate | string | Last Modified Date |
hs_likelihood_to_close | string | Likelihood to close by the close date |
hs_line_item_global_term_hs_discount_percentage | string | Global Term Line Item Discount Percentage |
hs_line_item_global_term_hs_discount_percentage_enabled | boolean | Global Term Line Item Discount Percentage Enabled |
hs_line_item_global_term_hs_recurring_billing_period | string | Global Term Line Item Recurring Billing Period |
hs_line_item_global_term_hs_recurring_billing_period_enabled | boolean | Global Term Line Item Recurring Billing Period Enabled |
hs_line_item_global_term_hs_recurring_billing_start_date | string | Global Term Line Item Recurring Billing Start Date |
hs_line_item_global_term_hs_recurring_billing_start_date_enabled | boolean | Global Term Line Item Recurring Billing Start Date Enabled |
hs_line_item_global_term_recurringbillingfrequency | string | Global Term Line Item Recurring Billing Frequency |
hs_line_item_global_term_recurringbillingfrequency_enabled | boolean | Global Term Line Item Recurring Billing Frequency Enabled |
hs_manual_forecast_category | string | Forecast category |
hs_merged_object_ids | string | Merged object IDs |
hs_mrr | string | Monthly recurring revenue |
hs_next_step | string | Next step |
hs_num_associated_active_deal_registrations | string | Number of Active Deal Registrations |
hs_num_associated_deal_registrations | string | Number of Deal Registrations |
hs_num_associated_deal_splits | string | Number of Deal Splits |
hs_num_target_accounts | string | Number of target accounts |
hs_object_id | string | Deal ID |
hs_predicted_amount | string | The predicted deal amount |
hs_predicted_amount_in_home_currency | string | The predicted deal amount in your company's currency |
hs_priority | string | Priority |
hs_projected_amount | string | Weighted amount |
hs_projected_amount_in_home_currency | string | Weighted amount in company currency |
hs_tcv | string | Total contract value |
hs_time_in_13094129 | string | Time in 'New (Renewal Pipeline)' |
hs_time_in_13094130 | string | Time in 'Past Termination (Renewal Pipeline)' |
hs_time_in_13094131 | string | Time in 'Negotiation (Renewal Pipeline)' |
hs_time_in_13094134 | string | Time in 'Closed won (Renewal Pipeline)' |
hs_time_in_13094135 | string | Time in 'Closed lost (Renewal Pipeline)' |
hs_time_in_13103592 | string | Time in 'Trial Signup (Data Virtuality Pipes)' |
hs_time_in_13103593 | string | Time in 'Activation (Data Virtuality Pipes)' |
hs_time_in_13103594 | string | Time in 'DWH Connected (Data Virtuality Pipes)' |
hs_time_in_13103595 | string | Time in 'Pipes Running (Data Virtuality Pipes)' |
hs_time_in_13103596 | string | Time in 'Negotiation (Data Virtuality Pipes)' |
hs_time_in_13103597 | string | Time in 'Closed won (Data Virtuality Pipes)' |
hs_time_in_13103598 | string | Time in 'Closed lost (Data Virtuality Pipes)' |
hs_time_in_13275376 | string | Time in 'New (Partner Acquisition)' |
hs_time_in_13275377 | string | Time in 'Qualification (Partner Acquisition)' |
hs_time_in_13275378 | string | Time in 'Negotiation (Partner Acquisition)' |
hs_time_in_13275381 | string | Time in 'Closed won (Partner Acquisition)' |
hs_time_in_13275382 | string | Time in 'Closed lost (Partner Acquisition)' |
hs_time_in_appointmentscheduled | string | Time in 'New (Data Virtuality Platform)' |
hs_time_in_closedlost | string | Time in 'Closed Lost (Data Virtuality Platform)' |
hs_time_in_closedwon | string | Time in 'Closed Won (Data Virtuality Platform)' |
hs_time_in_contractsent | string | Time in 'Contract Sent (Data Virtuality Platform)' |
hs_time_in_decisionmakerboughtin | string | Time in 'Decision (Data Virtuality Platform)' |
hs_time_in_presentationscheduled | string | Time in 'Negotiation (Data Virtuality Platform)' |
hs_time_in_qualifiedtobuy | string | Time in 'PoC (Data Virtuality Platform)' |
hs_unique_creation_key | string | Unique creation key |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
dealname | string | Deal Name |
amount | string | Amount |
dealstage | string | Deal Stage |
pipeline | string | Pipeline |
closedate | string | Close Date |
createdate | string | Create Date |
engagements_last_meeting_booked | string | Date of last meeting booked in meetings tool |
engagements_last_meeting_booked_campaign | string | Campaign of last booking in meetings tool |
engagements_last_meeting_booked_medium | string | Medium of last booking in meetings tool |
engagements_last_meeting_booked_source | string | Source of last booking in meetings tool |
hs_latest_meeting_activity | string | Latest meeting activity |
hs_sales_email_last_replied | string | Recent Sales Email Replied Date |
hubspot_owner_id | string | Deal owner |
notes_last_contacted | string | Last Contacted |
notes_last_updated | string | Last Activity Date |
notes_next_activity_date | string | Next Activity Date |
num_contacted_notes | string | Number of times contacted |
num_notes | string | Number of Sales Activities |
hs_createdate | string | HubSpot Create Date |
hubspot_team_id | string | HubSpot Team |
dealtype | string | Deal Type |
hs_all_owner_ids | string | All owner ids |
description | string | Deal Description |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
num_associated_contacts | string | Number of Associated Contacts |
closed_lost_reason | string | Closed Lost Reason |
closed_won_reason | string | Closed Won Reason |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Example
CREATE VIEW hubspot_v2_examples.example_Deals
AS
SELECT * FROM hubspot_v2.Deals (
preview => TRUE
)
Deals_Associations
List associations of a deal by type
Parameter
<dealId> (optional): The ID of the deal
<deal_table> (optional): Table name with deal data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
dealId | string | The ID of the deal |
objectId | string | The ID of the object |
type | string | Association type |
Example
CREATE VIEW hubspot_v2_examples.example_Deals_Associations
AS
SELECT * FROM hubspot_v2.Deals_Associations (
preview => TRUE
)
Deals_CreateAssociation
Associate a deal with company or contact
Parameter
<dealId> (required): The ID of the deal
<objectId> (required): The ID of the company or contact
<objectType> (required): Specify whether you would like to associate the deal with a contact or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Deal ID |
amount_in_home_currency | string | Amount in company currency |
days_to_close | string | Days to close |
deal_currency_code | string | Currency |
hs_acv | string | Annual contract value |
hs_all_assigned_business_unit_ids | string | Business units |
hs_all_deal_split_owner_ids | string | Deal Split Users |
hs_analytics_source | string | Original Source Type |
hs_analytics_source_data_1 | string | Original Source Data 1 |
hs_analytics_source_data_2 | string | Original Source Data 2 |
hs_arr | string | Annual recurring revenue |
hs_campaign | string | HubSpot Campaign |
hs_closed_amount | string | Closed Deal Amount |
hs_closed_amount_in_home_currency | string | Closed Deal Amount In Home Currency |
hs_created_by_user_id | string | Created by user ID |
hs_date_entered_13094129 | string | Date entered 'New (Renewal Pipeline)' |
hs_date_entered_13094130 | string | Date entered 'Past Termination (Renewal Pipeline)' |
hs_date_entered_13094131 | string | Date entered 'Negotiation (Renewal Pipeline)' |
hs_date_entered_13094134 | string | Date entered 'Closed won (Renewal Pipeline)' |
hs_date_entered_13094135 | string | Date entered 'Closed lost (Renewal Pipeline)' |
hs_date_entered_13103592 | string | Date entered 'Trial Signup (Data Virtuality Pipes)' |
hs_date_entered_13103593 | string | Date entered 'Activation (Data Virtuality Pipes)' |
hs_date_entered_13103594 | string | Date entered 'DWH Connected (Data Virtuality Pipes)' |
hs_date_entered_13103595 | string | Date entered 'Pipes Running (Data Virtuality Pipes)' |
hs_date_entered_13103596 | string | Date entered 'Negotiation (Data Virtuality Pipes)' |
hs_date_entered_13103597 | string | Date entered 'Closed won (Data Virtuality Pipes)' |
hs_date_entered_13103598 | string | Date entered 'Closed lost (Data Virtuality Pipes)' |
hs_date_entered_13275376 | string | Date entered 'New (Partner Acquisition)' |
hs_date_entered_13275377 | string | Date entered 'Qualification (Partner Acquisition)' |
hs_date_entered_13275378 | string | Date entered 'Negotiation (Partner Acquisition)' |
hs_date_entered_13275381 | string | Date entered 'Closed won (Partner Acquisition)' |
hs_date_entered_13275382 | string | Date entered 'Closed lost (Partner Acquisition)' |
hs_date_entered_appointmentscheduled | string | Date entered 'New (Data Virtuality Platform)' |
hs_date_entered_closedlost | string | Date entered 'Closed Lost (Data Virtuality Platform)' |
hs_date_entered_closedwon | string | Date entered 'Closed Won (Data Virtuality Platform)' |
hs_date_entered_contractsent | string | Date entered 'Contract Sent (Data Virtuality Platform)' |
hs_date_entered_decisionmakerboughtin | string | Date entered 'Decision (Data Virtuality Platform)' |
hs_date_entered_presentationscheduled | string | Date entered 'Negotiation (Data Virtuality Platform)' |
hs_date_entered_qualifiedtobuy | string | Date entered 'PoC (Data Virtuality Platform)' |
hs_date_exited_13094129 | string | Date exited 'New (Renewal Pipeline)' |
hs_date_exited_13094130 | string | Date exited 'Past Termination (Renewal Pipeline)' |
hs_date_exited_13094131 | string | Date exited 'Negotiation (Renewal Pipeline)' |
hs_date_exited_13094134 | string | Date exited 'Closed won (Renewal Pipeline)' |
hs_date_exited_13094135 | string | Date exited 'Closed lost (Renewal Pipeline)' |
hs_date_exited_13103592 | string | Date exited 'Trial Signup (Data Virtuality Pipes)' |
hs_date_exited_13103593 | string | Date exited 'Activation (Data Virtuality Pipes)' |
hs_date_exited_13103594 | string | Date exited 'DWH Connected (Data Virtuality Pipes)' |
hs_date_exited_13103595 | string | Date exited 'Pipes Running (Data Virtuality Pipes)' |
hs_date_exited_13103596 | string | Date exited 'Negotiation (Data Virtuality Pipes)' |
hs_date_exited_13103597 | string | Date exited 'Closed won (Data Virtuality Pipes)' |
hs_date_exited_13103598 | string | Date exited 'Closed lost (Data Virtuality Pipes)' |
hs_date_exited_13275376 | string | Date exited 'New (Partner Acquisition)' |
hs_date_exited_13275377 | string | Date exited 'Qualification (Partner Acquisition)' |
hs_date_exited_13275378 | string | Date exited 'Negotiation (Partner Acquisition)' |
hs_date_exited_13275381 | string | Date exited 'Closed won (Partner Acquisition)' |
hs_date_exited_13275382 | string | Date exited 'Closed lost (Partner Acquisition)' |
hs_date_exited_appointmentscheduled | string | Date exited 'New (Data Virtuality Platform)' |
hs_date_exited_closedlost | string | Date exited 'Closed Lost (Data Virtuality Platform)' |
hs_date_exited_closedwon | string | Date exited 'Closed Won (Data Virtuality Platform)' |
hs_date_exited_contractsent | string | Date exited 'Contract Sent (Data Virtuality Platform)' |
hs_date_exited_decisionmakerboughtin | string | Date exited 'Decision (Data Virtuality Platform)' |
hs_date_exited_presentationscheduled | string | Date exited 'Negotiation (Data Virtuality Platform)' |
hs_date_exited_qualifiedtobuy | string | Date exited 'PoC (Data Virtuality Platform)' |
hs_deal_amount_calculation_preference | string | Deal amount calculation preference |
hs_deal_stage_probability | string | Deal probability |
hs_deal_stage_probability_shadow | string | Deal stage probability shadow |
hs_forecast_amount | string | Forecast amount |
hs_forecast_probability | string | Forecast probability |
hs_is_closed | string | Is Deal Closed? |
hs_is_closed_won | string | Is Closed Won |
hs_is_deal_split | string | Deal Split Added |
hs_lastmodifieddate | string | Last Modified Date |
hs_likelihood_to_close | string | Likelihood to close by the close date |
hs_line_item_global_term_hs_discount_percentage | string | Global Term Line Item Discount Percentage |
hs_line_item_global_term_hs_discount_percentage_enabled | string | Global Term Line Item Discount Percentage Enabled |
hs_line_item_global_term_hs_recurring_billing_period | string | Global Term Line Item Recurring Billing Period |
hs_line_item_global_term_hs_recurring_billing_period_enabled | string | Global Term Line Item Recurring Billing Period Enabled |
hs_line_item_global_term_hs_recurring_billing_start_date | string | Global Term Line Item Recurring Billing Start Date |
hs_line_item_global_term_hs_recurring_billing_start_date_enabled | string | Global Term Line Item Recurring Billing Start Date Enabled |
hs_line_item_global_term_recurringbillingfrequency | string | Global Term Line Item Recurring Billing Frequency |
hs_line_item_global_term_recurringbillingfrequency_enabled | string | Global Term Line Item Recurring Billing Frequency Enabled |
hs_manual_forecast_category | string | Forecast category |
hs_merged_object_ids | string | Merged object IDs |
hs_mrr | string | Monthly recurring revenue |
hs_next_step | string | Next step |
hs_num_associated_active_deal_registrations | string | Number of Active Deal Registrations |
hs_num_associated_deal_registrations | string | Number of Deal Registrations |
hs_num_associated_deal_splits | string | Number of Deal Splits |
hs_num_target_accounts | string | Number of target accounts |
hs_object_id | string | Deal ID |
hs_predicted_amount | string | The predicted deal amount |
hs_predicted_amount_in_home_currency | string | The predicted deal amount in your company's currency |
hs_priority | string | Priority |
hs_projected_amount | string | Weighted amount |
hs_projected_amount_in_home_currency | string | Weighted amount in company currency |
hs_tcv | string | Total contract value |
hs_time_in_13094129 | string | Time in 'New (Renewal Pipeline)' |
hs_time_in_13094130 | string | Time in 'Past Termination (Renewal Pipeline)' |
hs_time_in_13094131 | string | Time in 'Negotiation (Renewal Pipeline)' |
hs_time_in_13094134 | string | Time in 'Closed won (Renewal Pipeline)' |
hs_time_in_13094135 | string | Time in 'Closed lost (Renewal Pipeline)' |
hs_time_in_13103592 | string | Time in 'Trial Signup (Data Virtuality Pipes)' |
hs_time_in_13103593 | string | Time in 'Activation (Data Virtuality Pipes)' |
hs_time_in_13103594 | string | Time in 'DWH Connected (Data Virtuality Pipes)' |
hs_time_in_13103595 | string | Time in 'Pipes Running (Data Virtuality Pipes)' |
hs_time_in_13103596 | string | Time in 'Negotiation (Data Virtuality Pipes)' |
hs_time_in_13103597 | string | Time in 'Closed won (Data Virtuality Pipes)' |
hs_time_in_13103598 | string | Time in 'Closed lost (Data Virtuality Pipes)' |
hs_time_in_13275376 | string | Time in 'New (Partner Acquisition)' |
hs_time_in_13275377 | string | Time in 'Qualification (Partner Acquisition)' |
hs_time_in_13275378 | string | Time in 'Negotiation (Partner Acquisition)' |
hs_time_in_13275381 | string | Time in 'Closed won (Partner Acquisition)' |
hs_time_in_13275382 | string | Time in 'Closed lost (Partner Acquisition)' |
hs_time_in_appointmentscheduled | string | Time in 'New (Data Virtuality Platform)' |
hs_time_in_closedlost | string | Time in 'Closed Lost (Data Virtuality Platform)' |
hs_time_in_closedwon | string | Time in 'Closed Won (Data Virtuality Platform)' |
hs_time_in_contractsent | string | Time in 'Contract Sent (Data Virtuality Platform)' |
hs_time_in_decisionmakerboughtin | string | Time in 'Decision (Data Virtuality Platform)' |
hs_time_in_presentationscheduled | string | Time in 'Negotiation (Data Virtuality Platform)' |
hs_time_in_qualifiedtobuy | string | Time in 'PoC (Data Virtuality Platform)' |
hs_unique_creation_key | string | Unique creation key |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
dealname | string | Deal Name |
amount | string | Amount |
dealstage | string | Deal Stage |
pipeline | string | Pipeline |
closedate | string | Close Date |
createdate | string | Create Date |
engagements_last_meeting_booked | string | Date of last meeting booked in meetings tool |
engagements_last_meeting_booked_campaign | string | Campaign of last booking in meetings tool |
engagements_last_meeting_booked_medium | string | Medium of last booking in meetings tool |
engagements_last_meeting_booked_source | string | Source of last booking in meetings tool |
hs_latest_meeting_activity | string | Latest meeting activity |
hs_sales_email_last_replied | string | Recent Sales Email Replied Date |
hubspot_owner_id | string | Deal owner |
notes_last_contacted | string | Last Contacted |
notes_last_updated | string | Last Activity Date |
notes_next_activity_date | string | Next Activity Date |
num_contacted_notes | string | Number of times contacted |
num_notes | string | Number of Sales Activities |
hs_createdate | string | HubSpot Create Date |
hubspot_team_id | string | HubSpot Team |
dealtype | string | Deal Type |
hs_all_owner_ids | string | All owner ids |
description | string | Deal Description |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
num_associated_contacts | string | Number of Associated Contacts |
closed_lost_reason | string | Closed Lost Reason |
closed_won_reason | string | Closed Won Reason |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Deals_CreateOrUpdate
Create or update deal
Parameter
<dealId> (optional): The ID of the deal. If this value is null, then the deal is created. If this value is specified, then the deal with this ID will be updated
<properties> (required): The line of deal properties. Should be supplied in json. "{"name" : "The Company Name","description" : "The Company Description"
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | deal ID |
amount_in_home_currency | string | Amount in company currency |
days_to_close | string | Days to close |
deal_currency_code | string | Currency |
hs_acv | string | Annual contract value |
hs_all_assigned_business_unit_ids | string | Business units |
hs_all_deal_split_owner_ids | string | Deal Split Users |
hs_analytics_source | string | Original Source Type |
hs_analytics_source_data_1 | string | Original Source Data 1 |
hs_analytics_source_data_2 | string | Original Source Data 2 |
hs_arr | string | Annual recurring revenue |
hs_campaign | string | HubSpot Campaign |
hs_closed_amount | string | Closed Deal Amount |
hs_closed_amount_in_home_currency | string | Closed Deal Amount In Home Currency |
hs_created_by_user_id | string | Created by user ID |
hs_date_entered_13094129 | string | Date entered 'New (Renewal Pipeline)' |
hs_date_entered_13094130 | string | Date entered 'Past Termination (Renewal Pipeline)' |
hs_date_entered_13094131 | string | Date entered 'Negotiation (Renewal Pipeline)' |
hs_date_entered_13094134 | string | Date entered 'Closed won (Renewal Pipeline)' |
hs_date_entered_13094135 | string | Date entered 'Closed lost (Renewal Pipeline)' |
hs_date_entered_13103592 | string | Date entered 'Trial Signup (Data Virtuality Pipes)' |
hs_date_entered_13103593 | string | Date entered 'Activation (Data Virtuality Pipes)' |
hs_date_entered_13103594 | string | Date entered 'DWH Connected (Data Virtuality Pipes)' |
hs_date_entered_13103595 | string | Date entered 'Pipes Running (Data Virtuality Pipes)' |
hs_date_entered_13103596 | string | Date entered 'Negotiation (Data Virtuality Pipes)' |
hs_date_entered_13103597 | string | Date entered 'Closed won (Data Virtuality Pipes)' |
hs_date_entered_13103598 | string | Date entered 'Closed lost (Data Virtuality Pipes)' |
hs_date_entered_13275376 | string | Date entered 'New (Partner Acquisition)' |
hs_date_entered_13275377 | string | Date entered 'Qualification (Partner Acquisition)' |
hs_date_entered_13275378 | string | Date entered 'Negotiation (Partner Acquisition)' |
hs_date_entered_13275381 | string | Date entered 'Closed won (Partner Acquisition)' |
hs_date_entered_13275382 | string | Date entered 'Closed lost (Partner Acquisition)' |
hs_date_entered_appointmentscheduled | string | Date entered 'New (Data Virtuality Platform)' |
hs_date_entered_closedlost | string | Date entered 'Closed Lost (Data Virtuality Platform)' |
hs_date_entered_closedwon | string | Date entered 'Closed Won (Data Virtuality Platform)' |
hs_date_entered_contractsent | string | Date entered 'Contract Sent (Data Virtuality Platform)' |
hs_date_entered_decisionmakerboughtin | string | Date entered 'Decision (Data Virtuality Platform)' |
hs_date_entered_presentationscheduled | string | Date entered 'Negotiation (Data Virtuality Platform)' |
hs_date_entered_qualifiedtobuy | string | Date entered 'PoC (Data Virtuality Platform)' |
hs_date_exited_13094129 | string | Date exited 'New (Renewal Pipeline)' |
hs_date_exited_13094130 | string | Date exited 'Past Termination (Renewal Pipeline)' |
hs_date_exited_13094131 | string | Date exited 'Negotiation (Renewal Pipeline)' |
hs_date_exited_13094134 | string | Date exited 'Closed won (Renewal Pipeline)' |
hs_date_exited_13094135 | string | Date exited 'Closed lost (Renewal Pipeline)' |
hs_date_exited_13103592 | string | Date exited 'Trial Signup (Data Virtuality Pipes)' |
hs_date_exited_13103593 | string | Date exited 'Activation (Data Virtuality Pipes)' |
hs_date_exited_13103594 | string | Date exited 'DWH Connected (Data Virtuality Pipes)' |
hs_date_exited_13103595 | string | Date exited 'Pipes Running (Data Virtuality Pipes)' |
hs_date_exited_13103596 | string | Date exited 'Negotiation (Data Virtuality Pipes)' |
hs_date_exited_13103597 | string | Date exited 'Closed won (Data Virtuality Pipes)' |
hs_date_exited_13103598 | string | Date exited 'Closed lost (Data Virtuality Pipes)' |
hs_date_exited_13275376 | string | Date exited 'New (Partner Acquisition)' |
hs_date_exited_13275377 | string | Date exited 'Qualification (Partner Acquisition)' |
hs_date_exited_13275378 | string | Date exited 'Negotiation (Partner Acquisition)' |
hs_date_exited_13275381 | string | Date exited 'Closed won (Partner Acquisition)' |
hs_date_exited_13275382 | string | Date exited 'Closed lost (Partner Acquisition)' |
hs_date_exited_appointmentscheduled | string | Date exited 'New (Data Virtuality Platform)' |
hs_date_exited_closedlost | string | Date exited 'Closed Lost (Data Virtuality Platform)' |
hs_date_exited_closedwon | string | Date exited 'Closed Won (Data Virtuality Platform)' |
hs_date_exited_contractsent | string | Date exited 'Contract Sent (Data Virtuality Platform)' |
hs_date_exited_decisionmakerboughtin | string | Date exited 'Decision (Data Virtuality Platform)' |
hs_date_exited_presentationscheduled | string | Date exited 'Negotiation (Data Virtuality Platform)' |
hs_date_exited_qualifiedtobuy | string | Date exited 'PoC (Data Virtuality Platform)' |
hs_deal_amount_calculation_preference | string | Deal amount calculation preference |
hs_deal_stage_probability | string | Deal probability |
hs_deal_stage_probability_shadow | string | Deal stage probability shadow |
hs_forecast_amount | string | Forecast amount |
hs_forecast_probability | string | Forecast probability |
hs_is_closed | string | Is Deal Closed? |
hs_is_closed_won | string | Is Closed Won |
hs_is_deal_split | string | Deal Split Added |
hs_lastmodifieddate | string | Last Modified Date |
hs_likelihood_to_close | string | Likelihood to close by the close date |
hs_line_item_global_term_hs_discount_percentage | string | Global Term Line Item Discount Percentage |
hs_line_item_global_term_hs_discount_percentage_enabled | string | Global Term Line Item Discount Percentage Enabled |
hs_line_item_global_term_hs_recurring_billing_period | string | Global Term Line Item Recurring Billing Period |
hs_line_item_global_term_hs_recurring_billing_period_enabled | string | Global Term Line Item Recurring Billing Period Enabled |
hs_line_item_global_term_hs_recurring_billing_start_date | string | Global Term Line Item Recurring Billing Start Date |
hs_line_item_global_term_hs_recurring_billing_start_date_enabled | string | Global Term Line Item Recurring Billing Start Date Enabled |
hs_line_item_global_term_recurringbillingfrequency | string | Global Term Line Item Recurring Billing Frequency |
hs_line_item_global_term_recurringbillingfrequency_enabled | string | Global Term Line Item Recurring Billing Frequency Enabled |
hs_manual_forecast_category | string | Forecast category |
hs_merged_object_ids | string | Merged object IDs |
hs_mrr | string | Monthly recurring revenue |
hs_next_step | string | Next step |
hs_num_associated_active_deal_registrations | string | Number of Active Deal Registrations |
hs_num_associated_deal_registrations | string | Number of Deal Registrations |
hs_num_associated_deal_splits | string | Number of Deal Splits |
hs_num_target_accounts | string | Number of target accounts |
hs_object_id | string | Deal ID |
hs_predicted_amount | string | The predicted deal amount |
hs_predicted_amount_in_home_currency | string | The predicted deal amount in your company's currency |
hs_priority | string | Priority |
hs_projected_amount | string | Weighted amount |
hs_projected_amount_in_home_currency | string | Weighted amount in company currency |
hs_tcv | string | Total contract value |
hs_time_in_13094129 | string | Time in 'New (Renewal Pipeline)' |
hs_time_in_13094130 | string | Time in 'Past Termination (Renewal Pipeline)' |
hs_time_in_13094131 | string | Time in 'Negotiation (Renewal Pipeline)' |
hs_time_in_13094134 | string | Time in 'Closed won (Renewal Pipeline)' |
hs_time_in_13094135 | string | Time in 'Closed lost (Renewal Pipeline)' |
hs_time_in_13103592 | string | Time in 'Trial Signup (Data Virtuality Pipes)' |
hs_time_in_13103593 | string | Time in 'Activation (Data Virtuality Pipes)' |
hs_time_in_13103594 | string | Time in 'DWH Connected (Data Virtuality Pipes)' |
hs_time_in_13103595 | string | Time in 'Pipes Running (Data Virtuality Pipes)' |
hs_time_in_13103596 | string | Time in 'Negotiation (Data Virtuality Pipes)' |
hs_time_in_13103597 | string | Time in 'Closed won (Data Virtuality Pipes)' |
hs_time_in_13103598 | string | Time in 'Closed lost (Data Virtuality Pipes)' |
hs_time_in_13275376 | string | Time in 'New (Partner Acquisition)' |
hs_time_in_13275377 | string | Time in 'Qualification (Partner Acquisition)' |
hs_time_in_13275378 | string | Time in 'Negotiation (Partner Acquisition)' |
hs_time_in_13275381 | string | Time in 'Closed won (Partner Acquisition)' |
hs_time_in_13275382 | string | Time in 'Closed lost (Partner Acquisition)' |
hs_time_in_appointmentscheduled | string | Time in 'New (Data Virtuality Platform)' |
hs_time_in_closedlost | string | Time in 'Closed Lost (Data Virtuality Platform)' |
hs_time_in_closedwon | string | Time in 'Closed Won (Data Virtuality Platform)' |
hs_time_in_contractsent | string | Time in 'Contract Sent (Data Virtuality Platform)' |
hs_time_in_decisionmakerboughtin | string | Time in 'Decision (Data Virtuality Platform)' |
hs_time_in_presentationscheduled | string | Time in 'Negotiation (Data Virtuality Platform)' |
hs_time_in_qualifiedtobuy | string | Time in 'PoC (Data Virtuality Platform)' |
hs_unique_creation_key | string | Unique creation key |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
dealname | string | Deal Name |
amount | string | Amount |
dealstage | string | Deal Stage |
pipeline | string | Pipeline |
closedate | string | Close Date |
createdate | string | Create Date |
engagements_last_meeting_booked | string | Date of last meeting booked in meetings tool |
engagements_last_meeting_booked_campaign | string | Campaign of last booking in meetings tool |
engagements_last_meeting_booked_medium | string | Medium of last booking in meetings tool |
engagements_last_meeting_booked_source | string | Source of last booking in meetings tool |
hs_latest_meeting_activity | string | Latest meeting activity |
hs_sales_email_last_replied | string | Recent Sales Email Replied Date |
hubspot_owner_id | string | Deal owner |
notes_last_contacted | string | Last Contacted |
notes_last_updated | string | Last Activity Date |
notes_next_activity_date | string | Next Activity Date |
num_contacted_notes | string | Number of times contacted |
num_notes | string | Number of Sales Activities |
hs_createdate | string | HubSpot Create Date |
hubspot_team_id | string | HubSpot Team |
dealtype | string | Deal Type |
hs_all_owner_ids | string | All owner ids |
description | string | Deal Description |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
num_associated_contacts | string | Number of Associated Contacts |
closed_lost_reason | string | Closed Lost Reason |
closed_won_reason | string | Closed Won Reason |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Deals_Delete
Move a email to the recycling bin
Parameter
<dealId> (required): Unique identifier for a deal to delete
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Deals_DeleteAssociation
Removes a deal's association with a contact or company
Parameter
<dealId> (required): The ID of the deal
<objectId> (required): The ID of the company or contact
<objectType> (required): Specify whether you would like to associate the deal with a contact or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Deals_GetAssociatedDeals
List of associated deals
Parameter
<deal_table> (optional): Table name with deal data
<association_table> (optional): Table name with association data
Attribute | Type | Description |
---|---|---|
objectId | string | The ID of the object |
type | string | Association type |
id | string | Deal ID |
amount_in_home_currency | string | Amount in company currency |
days_to_close | string | Days to close |
deal_currency_code | string | Currency |
hs_acv | string | Annual contract value |
hs_all_assigned_business_unit_ids | string | Business units |
hs_all_deal_split_owner_ids | string | Deal Split Users |
hs_analytics_source | string | Original Source Type |
hs_analytics_source_data_1 | string | Original Source Data 1 |
hs_analytics_source_data_2 | string | Original Source Data 2 |
hs_arr | string | Annual recurring revenue |
hs_campaign | string | HubSpot Campaign |
hs_closed_amount | string | Closed Deal Amount |
hs_closed_amount_in_home_currency | string | Closed Deal Amount In Home Currency |
hs_created_by_user_id | string | Created by user ID |
hs_date_entered_13094129 | string | Date entered 'New (Renewal Pipeline)' |
hs_date_entered_13094130 | string | Date entered 'Past Termination (Renewal Pipeline)' |
hs_date_entered_13094131 | string | Date entered 'Negotiation (Renewal Pipeline)' |
hs_date_entered_13094134 | string | Date entered 'Closed won (Renewal Pipeline)' |
hs_date_entered_13094135 | string | Date entered 'Closed lost (Renewal Pipeline)' |
hs_date_entered_13103592 | string | Date entered 'Trial Signup (Data Virtuality Pipes)' |
hs_date_entered_13103593 | string | Date entered 'Activation (Data Virtuality Pipes)' |
hs_date_entered_13103594 | string | Date entered 'DWH Connected (Data Virtuality Pipes)' |
hs_date_entered_13103595 | string | Date entered 'Pipes Running (Data Virtuality Pipes)' |
hs_date_entered_13103596 | string | Date entered 'Negotiation (Data Virtuality Pipes)' |
hs_date_entered_13103597 | string | Date entered 'Closed won (Data Virtuality Pipes)' |
hs_date_entered_13103598 | string | Date entered 'Closed lost (Data Virtuality Pipes)' |
hs_date_entered_13275376 | string | Date entered 'New (Partner Acquisition)' |
hs_date_entered_13275377 | string | Date entered 'Qualification (Partner Acquisition)' |
hs_date_entered_13275378 | string | Date entered 'Negotiation (Partner Acquisition)' |
hs_date_entered_13275381 | string | Date entered 'Closed won (Partner Acquisition)' |
hs_date_entered_13275382 | string | Date entered 'Closed lost (Partner Acquisition)' |
hs_date_entered_appointmentscheduled | string | Date entered 'New (Data Virtuality Platform)' |
hs_date_entered_closedlost | string | Date entered 'Closed Lost (Data Virtuality Platform)' |
hs_date_entered_closedwon | string | Date entered 'Closed Won (Data Virtuality Platform)' |
hs_date_entered_contractsent | string | Date entered 'Contract Sent (Data Virtuality Platform)' |
hs_date_entered_decisionmakerboughtin | string | Date entered 'Decision (Data Virtuality Platform)' |
hs_date_entered_presentationscheduled | string | Date entered 'Negotiation (Data Virtuality Platform)' |
hs_date_entered_qualifiedtobuy | string | Date entered 'PoC (Data Virtuality Platform)' |
hs_date_exited_13094129 | string | Date exited 'New (Renewal Pipeline)' |
hs_date_exited_13094130 | string | Date exited 'Past Termination (Renewal Pipeline)' |
hs_date_exited_13094131 | string | Date exited 'Negotiation (Renewal Pipeline)' |
hs_date_exited_13094134 | string | Date exited 'Closed won (Renewal Pipeline)' |
hs_date_exited_13094135 | string | Date exited 'Closed lost (Renewal Pipeline)' |
hs_date_exited_13103592 | string | Date exited 'Trial Signup (Data Virtuality Pipes)' |
hs_date_exited_13103593 | string | Date exited 'Activation (Data Virtuality Pipes)' |
hs_date_exited_13103594 | string | Date exited 'DWH Connected (Data Virtuality Pipes)' |
hs_date_exited_13103595 | string | Date exited 'Pipes Running (Data Virtuality Pipes)' |
hs_date_exited_13103596 | string | Date exited 'Negotiation (Data Virtuality Pipes)' |
hs_date_exited_13103597 | string | Date exited 'Closed won (Data Virtuality Pipes)' |
hs_date_exited_13103598 | string | Date exited 'Closed lost (Data Virtuality Pipes)' |
hs_date_exited_13275376 | string | Date exited 'New (Partner Acquisition)' |
hs_date_exited_13275377 | string | Date exited 'Qualification (Partner Acquisition)' |
hs_date_exited_13275378 | string | Date exited 'Negotiation (Partner Acquisition)' |
hs_date_exited_13275381 | string | Date exited 'Closed won (Partner Acquisition)' |
hs_date_exited_13275382 | string | Date exited 'Closed lost (Partner Acquisition)' |
hs_date_exited_appointmentscheduled | string | Date exited 'New (Data Virtuality Platform)' |
hs_date_exited_closedlost | string | Date exited 'Closed Lost (Data Virtuality Platform)' |
hs_date_exited_closedwon | string | Date exited 'Closed Won (Data Virtuality Platform)' |
hs_date_exited_contractsent | string | Date exited 'Contract Sent (Data Virtuality Platform)' |
hs_date_exited_decisionmakerboughtin | string | Date exited 'Decision (Data Virtuality Platform)' |
hs_date_exited_presentationscheduled | string | Date exited 'Negotiation (Data Virtuality Platform)' |
hs_date_exited_qualifiedtobuy | string | Date exited 'PoC (Data Virtuality Platform)' |
hs_deal_amount_calculation_preference | string | Deal amount calculation preference |
hs_deal_stage_probability | string | Deal probability |
hs_deal_stage_probability_shadow | string | Deal stage probability shadow |
hs_forecast_amount | string | Forecast amount |
hs_forecast_probability | string | Forecast probability |
hs_is_closed | boolean | Is Deal Closed? |
hs_is_closed_won | boolean | Is Closed Won |
hs_is_deal_split | boolean | Deal Split Added |
hs_lastmodifieddate | string | Last Modified Date |
hs_likelihood_to_close | string | Likelihood to close by the close date |
hs_line_item_global_term_hs_discount_percentage | string | Global Term Line Item Discount Percentage |
hs_line_item_global_term_hs_discount_percentage_enabled | boolean | Global Term Line Item Discount Percentage Enabled |
hs_line_item_global_term_hs_recurring_billing_period | string | Global Term Line Item Recurring Billing Period |
hs_line_item_global_term_hs_recurring_billing_period_enabled | boolean | Global Term Line Item Recurring Billing Period Enabled |
hs_line_item_global_term_hs_recurring_billing_start_date | string | Global Term Line Item Recurring Billing Start Date |
hs_line_item_global_term_hs_recurring_billing_start_date_enabled | boolean | Global Term Line Item Recurring Billing Start Date Enabled |
hs_line_item_global_term_recurringbillingfrequency | string | Global Term Line Item Recurring Billing Frequency |
hs_line_item_global_term_recurringbillingfrequency_enabled | boolean | Global Term Line Item Recurring Billing Frequency Enabled |
hs_manual_forecast_category | string | Forecast category |
hs_merged_object_ids | string | Merged object IDs |
hs_mrr | string | Monthly recurring revenue |
hs_next_step | string | Next step |
hs_num_associated_active_deal_registrations | string | Number of Active Deal Registrations |
hs_num_associated_deal_registrations | string | Number of Deal Registrations |
hs_num_associated_deal_splits | string | Number of Deal Splits |
hs_num_target_accounts | string | Number of target accounts |
hs_object_id | string | Deal ID |
hs_predicted_amount | string | The predicted deal amount |
hs_predicted_amount_in_home_currency | string | The predicted deal amount in your company's currency |
hs_priority | string | Priority |
hs_projected_amount | string | Weighted amount |
hs_projected_amount_in_home_currency | string | Weighted amount in company currency |
hs_tcv | string | Total contract value |
hs_time_in_13094129 | string | Time in 'New (Renewal Pipeline)' |
hs_time_in_13094130 | string | Time in 'Past Termination (Renewal Pipeline)' |
hs_time_in_13094131 | string | Time in 'Negotiation (Renewal Pipeline)' |
hs_time_in_13094134 | string | Time in 'Closed won (Renewal Pipeline)' |
hs_time_in_13094135 | string | Time in 'Closed lost (Renewal Pipeline)' |
hs_time_in_13103592 | string | Time in 'Trial Signup (Data Virtuality Pipes)' |
hs_time_in_13103593 | string | Time in 'Activation (Data Virtuality Pipes)' |
hs_time_in_13103594 | string | Time in 'DWH Connected (Data Virtuality Pipes)' |
hs_time_in_13103595 | string | Time in 'Pipes Running (Data Virtuality Pipes)' |
hs_time_in_13103596 | string | Time in 'Negotiation (Data Virtuality Pipes)' |
hs_time_in_13103597 | string | Time in 'Closed won (Data Virtuality Pipes)' |
hs_time_in_13103598 | string | Time in 'Closed lost (Data Virtuality Pipes)' |
hs_time_in_13275376 | string | Time in 'New (Partner Acquisition)' |
hs_time_in_13275377 | string | Time in 'Qualification (Partner Acquisition)' |
hs_time_in_13275378 | string | Time in 'Negotiation (Partner Acquisition)' |
hs_time_in_13275381 | string | Time in 'Closed won (Partner Acquisition)' |
hs_time_in_13275382 | string | Time in 'Closed lost (Partner Acquisition)' |
hs_time_in_appointmentscheduled | string | Time in 'New (Data Virtuality Platform)' |
hs_time_in_closedlost | string | Time in 'Closed Lost (Data Virtuality Platform)' |
hs_time_in_closedwon | string | Time in 'Closed Won (Data Virtuality Platform)' |
hs_time_in_contractsent | string | Time in 'Contract Sent (Data Virtuality Platform)' |
hs_time_in_decisionmakerboughtin | string | Time in 'Decision (Data Virtuality Platform)' |
hs_time_in_presentationscheduled | string | Time in 'Negotiation (Data Virtuality Platform)' |
hs_time_in_qualifiedtobuy | string | Time in 'PoC (Data Virtuality Platform)' |
hs_unique_creation_key | string | Unique creation key |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
dealname | string | Deal Name |
amount | string | Amount |
dealstage | string | Deal Stage |
pipeline | string | Pipeline |
closedate | string | Close Date |
createdate | string | Create Date |
engagements_last_meeting_booked | string | Date of last meeting booked in meetings tool |
engagements_last_meeting_booked_campaign | string | Campaign of last booking in meetings tool |
engagements_last_meeting_booked_medium | string | Medium of last booking in meetings tool |
engagements_last_meeting_booked_source | string | Source of last booking in meetings tool |
hs_latest_meeting_activity | string | Latest meeting activity |
hs_sales_email_last_replied | string | Recent Sales Email Replied Date |
hubspot_owner_id | string | Deal owner |
notes_last_contacted | string | Last Contacted |
notes_last_updated | string | Last Activity Date |
notes_next_activity_date | string | Next Activity Date |
num_contacted_notes | string | Number of times contacted |
num_notes | string | Number of Sales Activities |
hs_createdate | string | HubSpot Create Date |
hubspot_team_id | string | HubSpot Team |
dealtype | string | Deal Type |
hs_all_owner_ids | string | All owner ids |
description | string | Deal Description |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
num_associated_contacts | string | Number of Associated Contacts |
closed_lost_reason | string | Closed Lost Reason |
closed_won_reason | string | Closed Won Reason |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Emails
List of emails
Parameter
<archived> (optional): Whether to return only results that have been archived
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Email ID |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Body preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | boolean | Body Preview Truncated |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_direction_and_unique_id | string | Email direction and unique ID |
hs_email_attached_video_id | string | Attached Video |
hs_email_attached_video_name | string | Attached Video Name |
hs_email_attached_video_opened | boolean | Attached Video Opened |
hs_email_attached_video_watched | boolean | Attached Video Watched |
hs_email_bcc_email | string | Email BCC Address |
hs_email_bcc_firstname | string | Email BCC First Name |
hs_email_bcc_lastname | string | Email BCC Last Name |
hs_email_bcc_raw | string | Email BCC |
hs_email_cc_email | string | Email CC Address |
hs_email_cc_firstname | string | Email CC First Name |
hs_email_cc_lastname | string | Email CC Last Name |
hs_email_cc_raw | string | Email CC |
hs_email_direction | string | Email Direction |
hs_email_encoded_email_associations_request | string | Encoded Email Associations Request |
hs_email_error_message | string | Error Message |
hs_email_facsimile_send_id | string | Email Send Id |
hs_email_from_email | string | Email From Address |
hs_email_from_firstname | string | Email From First Name |
hs_email_from_lastname | string | Email From Last Name |
hs_email_from_raw | string | Email From |
hs_email_headers | string | Email Headers |
hs_email_html | string | Email body |
hs_email_logged_from | string | Logged From |
hs_email_media_processing_status | string | Media Processing Status |
hs_email_member_of_forwarded_subthread | boolean | Email is member of forwarded subthread |
hs_email_message_id | string | Message ID |
hs_email_migrated_via_portal_data_migration | string | email_migrated_via_portal_data_migration |
hs_email_pending_inline_image_ids | string | Email pending inline image file IDs |
hs_email_post_send_status | string | Post-Send Status |
hs_email_recipient_drop_reasons | string | Recipient-Drop Reasons |
hs_email_send_event_id | string | Email Send Event Id |
hs_email_send_event_id_created | string | Email Send Event Id Created |
hs_email_sender_email | string | Email Sender Address |
hs_email_sender_firstname | string | Email Sender First Name |
hs_email_sender_lastname | string | Email Sender Last Name |
hs_email_sender_raw | string | Email Sender |
hs_email_sent_via | string | Sent Via |
hs_email_status | string | Email send status |
hs_email_subject | string | Email subject |
hs_email_text | string | Text |
hs_email_thread_id | string | Thread ID |
hs_email_to_email | string | Email To Address |
hs_email_to_firstname | string | Email To First Name |
hs_email_to_lastname | string | Email To Last Name |
hs_email_to_raw | string | Email To |
hs_email_tracker_key | string | Tracker Key |
hs_email_validation_skipped | string | Validation Skipped |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | boolean | GDPR deleted |
hs_lastmodifieddate | string | Last modified date |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Example
CREATE VIEW hubspot_v2_examples.example_Emails
AS
SELECT * FROM hubspot_v2.Emails (
preview => TRUE
)
Emails_Associations
List associations of a email by type
Parameter
<emailId> (optional): The ID of the email
<email_table> (optional): Table name with email data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
emailId | string | The ID of the email |
objectId | string | The ID of the object |
type | string | Association type |
Example
CREATE VIEW hubspot_v2_examples.example_Emails_Associations
AS
SELECT * FROM hubspot_v2.Emails_Associations (
preview => TRUE
)
Emails_CreateAssociation
Associate a email with company, deal or contact
Parameter
<emailId> (required): The ID of the email
<objectId> (required): The ID of the company, deal or contact
<objectType> (required): Specify whether you would like to associate the email with a contact, deal or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | email ID |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Body preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_direction_and_unique_id | string | Email direction and unique ID |
hs_email_attached_video_id | string | Attached Video |
hs_email_attached_video_name | string | Attached Video Name |
hs_email_attached_video_opened | string | Attached Video Opened |
hs_email_attached_video_watched | string | Attached Video Watched |
hs_email_bcc_email | string | Email BCC Address |
hs_email_bcc_firstname | string | Email BCC First Name |
hs_email_bcc_lastname | string | Email BCC Last Name |
hs_email_bcc_raw | string | Email BCC |
hs_email_cc_email | string | Email CC Address |
hs_email_cc_firstname | string | Email CC First Name |
hs_email_cc_lastname | string | Email CC Last Name |
hs_email_cc_raw | string | Email CC |
hs_email_direction | string | Email Direction |
hs_email_encoded_email_associations_request | string | Encoded Email Associations Request |
hs_email_error_message | string | Error Message |
hs_email_facsimile_send_id | string | Email Send Id |
hs_email_from_email | string | Email From Address |
hs_email_from_firstname | string | Email From First Name |
hs_email_from_lastname | string | Email From Last Name |
hs_email_from_raw | string | Email From |
hs_email_headers | string | Email Headers |
hs_email_html | string | Email body |
hs_email_logged_from | string | Logged From |
hs_email_media_processing_status | string | Media Processing Status |
hs_email_member_of_forwarded_subthread | string | Email is member of forwarded subthread |
hs_email_message_id | string | Message ID |
hs_email_migrated_via_portal_data_migration | string | email_migrated_via_portal_data_migration |
hs_email_pending_inline_image_ids | string | Email pending inline image file IDs |
hs_email_post_send_status | string | Post-Send Status |
hs_email_recipient_drop_reasons | string | Recipient-Drop Reasons |
hs_email_send_event_id | string | Email Send Event Id |
hs_email_send_event_id_created | string | Email Send Event Id Created |
hs_email_sender_email | string | Email Sender Address |
hs_email_sender_firstname | string | Email Sender First Name |
hs_email_sender_lastname | string | Email Sender Last Name |
hs_email_sender_raw | string | Email Sender |
hs_email_sent_via | string | Sent Via |
hs_email_status | string | Email send status |
hs_email_subject | string | Email subject |
hs_email_text | string | Text |
hs_email_thread_id | string | Thread ID |
hs_email_to_email | string | Email To Address |
hs_email_to_firstname | string | Email To First Name |
hs_email_to_lastname | string | Email To Last Name |
hs_email_to_raw | string | Email To |
hs_email_tracker_key | string | Tracker Key |
hs_email_validation_skipped | string | Validation Skipped |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_lastmodifieddate | string | Last modified date |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Emails_CreateOrUpdate
Create or update email
Parameter
<emailId> (optional): The ID of the email. If this value is null, then the email is created. If this value is specified, then the email with this ID will be updated
<properties> (required): The line of email properties. Should be supplied in json. "{"hs_timestamp" : "Required property, format - yyyy-MM-ddTHH:mm:ss.SSSZ","hs_email_direction" : "Required property"
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | email ID |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Body preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_direction_and_unique_id | string | Email direction and unique ID |
hs_email_attached_video_id | string | Attached Video |
hs_email_attached_video_name | string | Attached Video Name |
hs_email_attached_video_opened | string | Attached Video Opened |
hs_email_attached_video_watched | string | Attached Video Watched |
hs_email_bcc_email | string | Email BCC Address |
hs_email_bcc_firstname | string | Email BCC First Name |
hs_email_bcc_lastname | string | Email BCC Last Name |
hs_email_bcc_raw | string | Email BCC |
hs_email_cc_email | string | Email CC Address |
hs_email_cc_firstname | string | Email CC First Name |
hs_email_cc_lastname | string | Email CC Last Name |
hs_email_cc_raw | string | Email CC |
hs_email_direction | string | Email Direction |
hs_email_encoded_email_associations_request | string | Encoded Email Associations Request |
hs_email_error_message | string | Error Message |
hs_email_facsimile_send_id | string | Email Send Id |
hs_email_from_email | string | Email From Address |
hs_email_from_firstname | string | Email From First Name |
hs_email_from_lastname | string | Email From Last Name |
hs_email_from_raw | string | Email From |
hs_email_headers | string | Email Headers |
hs_email_html | string | Email body |
hs_email_logged_from | string | Logged From |
hs_email_media_processing_status | string | Media Processing Status |
hs_email_member_of_forwarded_subthread | string | Email is member of forwarded subthread |
hs_email_message_id | string | Message ID |
hs_email_migrated_via_portal_data_migration | string | email_migrated_via_portal_data_migration |
hs_email_pending_inline_image_ids | string | Email pending inline image file IDs |
hs_email_post_send_status | string | Post-Send Status |
hs_email_recipient_drop_reasons | string | Recipient-Drop Reasons |
hs_email_send_event_id | string | Email Send Event Id |
hs_email_send_event_id_created | string | Email Send Event Id Created |
hs_email_sender_email | string | Email Sender Address |
hs_email_sender_firstname | string | Email Sender First Name |
hs_email_sender_lastname | string | Email Sender Last Name |
hs_email_sender_raw | string | Email Sender |
hs_email_sent_via | string | Sent Via |
hs_email_status | string | Email send status |
hs_email_subject | string | Email subject |
hs_email_text | string | Text |
hs_email_thread_id | string | Thread ID |
hs_email_to_email | string | Email To Address |
hs_email_to_firstname | string | Email To First Name |
hs_email_to_lastname | string | Email To Last Name |
hs_email_to_raw | string | Email To |
hs_email_tracker_key | string | Tracker Key |
hs_email_validation_skipped | string | Validation Skipped |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_lastmodifieddate | string | Last modified date |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Emails_Delete
Move a email to the recycling bin
Parameter
<emailId> (required): Unique identifier for a email to delete
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Emails_DeleteAssociation
Removes a email's association with a contact, deal or company
Parameter
<emailId> (required): The ID of the email
<objectId> (required): The ID of the company or contact
<objectType> (required): Specify whether you would like to associate the email with a contact, deal or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Events
A collection of events matching a query
Parameter
<initialDate> (required): Earliest datetime to retrieve events
<objectType> (required): The type of object being selected
<objectId> (required): The id of the selected object
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | A unique identifier for the event |
objectType | string | The type for the object which did the event |
objectId | string | The Id of the object which did the event |
eventType | string | The type of event |
occurredAt | timestamp | When the event occurred |
Example
CREATE VIEW hubspot_v2_examples.example_Events
AS
SELECT * FROM hubspot_v2.Events (
initialDate => CurDate(),
objectType => 'contact',
objectId => '4903611123',
preview => TRUE
)
Forms
Forms
Parameter
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
guid | string | Form Guid |
name | string | The name of the form |
createdAt | timestamp | Created At |
updatedAt | timestamp | Updated At |
action | string | Action |
method | string | Method |
cssClass | string | CSS Class |
redirect | string | Redirect |
submitText | string | Submit Text |
followUpId | string | Follow Up Id |
notifyRecipients | string | Notify Recipients |
leadNurturingCampaignId | string | Lead Nurturing Campaign Id |
performableHtml | string | Performable Html |
migratedFrom | string | Migrated From |
ignoreCurrentValues | boolean | Ignore Current Values |
deletable | boolean | Deletable |
inlineMessage | string | Inline Message |
tmsId | string | Tms Id |
captchaEnabled | boolean | Captcha Enabled |
campaignGuid | string | Campaign Guid |
cloneable | boolean | Cloneable |
editable | boolean | Editable |
formType | string | Form Type |
deletedAt | timestamp | Deleted At |
themeName | string | Theme Name |
parentId | string | Parent Id |
style | string | Style |
isPublished | boolean | Is Published |
publishAt | timestamp | Publish At |
unpublishAt | timestamp | Unpublish At |
publishedAt | timestamp | Published At |
kickbackEmailWorkflowId | string | Kickback Email Workflow Id |
kickbackEmailsJson | string | Kickback Emails Json |
customUid | string | Custom Uid |
createMarketableContact | boolean | Create Marketable Contact |
editVersion | string | Edit Version |
thankYouMessageJson | string | Thank You Message Json |
themeColor | string | Theme Color |
alwaysCreateNewCompany | boolean | Always Create New Company |
internalUpdatedAt | timestamp | Internal Updated At |
businessUnitId | string | Business Unit Id |
portableKey | string | Portable Key |
Create View hubspot_v2_examples.example_Forms
As
Select * From hubspot_v2.Forms (
preview => true
);;
LineItems
Line items
Parameter
<properties> (optional): Comma-separated list of properties
<line_item_id> (optional): Line item ID
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
objectType | string | Object type |
portalId | string | Portal Id |
objectId | string | Object Id |
version | integer | Version |
isDeleted | boolean | Specifies that a product is deleted |
Meetings
List of Meetings
Parameter
<archived> (optional): Whether to return only results that have been archived
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Meeting ID |
hs_activity_type | string | Call and meeting type |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_attendee_owner_ids | string | HubSpot attendee owner IDs |
hs_body_preview | string | Body preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | boolean | Body Preview Truncated |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | boolean | GDPR deleted |
hs_i_cal_uid | string | iCalUid |
hs_internal_meeting_notes | string | Internal Meeting Notes |
hs_lastmodifieddate | string | Last modified date |
hs_meeting_body | string | Meeting description |
hs_meeting_calendar_event_hash | string | Meeting calendar event hash |
hs_meeting_change_id | string | Meeting change id |
hs_meeting_created_from_link_id | string | Created From Link ID |
hs_meeting_end_time | string | Meeting end time |
hs_meeting_external_url | string | External URL |
hs_meeting_location | string | Meeting location |
hs_meeting_location_type | string | Location type |
hs_meeting_outcome | string | Meeting outcome |
hs_meeting_pre_meeting_prospect_reminders | string | Pre-meeting prospect reminders |
hs_meeting_source | string | Meeting source |
hs_meeting_source_id | string | Source ID |
hs_meeting_start_time | string | Meeting start time |
hs_meeting_title | string | Meeting name |
hs_meeting_web_conference_meeting_id | string | Web conference meeting ID |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_scheduled_tasks | string | Scheduled tasks |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Example
CREATE VIEW hubspot_v2_examples.example_Meetings
AS
SELECT * FROM hubspot_v2.Meetings (
preview => TRUE
)
Meetings_Associations
List associations of a meeting by type
Parameter
<meetingId> (optional): The ID of the meeting
<meeting_table> (optional): Table name with meeting data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
meetingId | string | The ID of the meeting |
objectId | string | The ID of the object |
type | string | Association type |
Example
CREATE VIEW hubspot_v2_examples.example_Meetings_Associations
AS
SELECT * FROM hubspot_v2.Meetings_Associations (
preview => TRUE
)
Meetings_CreateAssociation
Associate a meeting with company, deal or contact
Parameter
<meetingId> (required): The ID of the meeting
<objectId> (required): The ID of the company, deal or contact
<objectType> (required): Specify whether you would like to associate the meeting with a contact, deal or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Meeting ID |
hs_activity_type | string | Call and meeting type |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_attendee_owner_ids | string | HubSpot attendee owner IDs |
hs_body_preview | string | Body preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_i_cal_uid | string | iCalUid |
hs_internal_meeting_notes | string | Internal Meeting Notes |
hs_lastmodifieddate | string | Last modified date |
hs_meeting_body | string | Meeting description |
hs_meeting_calendar_event_hash | string | Meeting calendar event hash |
hs_meeting_change_id | string | Meeting change id |
hs_meeting_created_from_link_id | string | Created From Link ID |
hs_meeting_end_time | string | Meeting end time |
hs_meeting_external_url | string | External URL |
hs_meeting_location | string | Meeting location |
hs_meeting_location_type | string | Location type |
hs_meeting_outcome | string | Meeting outcome |
hs_meeting_pre_meeting_prospect_reminders | string | Pre-meeting prospect reminders |
hs_meeting_source | string | Meeting source |
hs_meeting_source_id | string | Source ID |
hs_meeting_start_time | string | Meeting start time |
hs_meeting_title | string | Meeting name |
hs_meeting_web_conference_meeting_id | string | Web conference meeting ID |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_scheduled_tasks | string | Scheduled tasks |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Meetings_CreateOrUpdate
Create or update meeting
Parameter
<meetingId> (optional): The ID of the meeting. If this value is null, then the meeting is created. If this value is specified, then the meeting with this ID will be updated
<properties> (required): The line of meeting properties. Should be supplied in json. "{"hs_timestamp" : "Required property, format - yyyy-MM-ddTHH:mm:ss.SSSZ","hs_meeting_location" : "The Meeting Location"
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Meeting ID |
hs_activity_type | string | Call and meeting type |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_attendee_owner_ids | string | HubSpot attendee owner IDs |
hs_body_preview | string | Body preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_i_cal_uid | string | iCalUid |
hs_internal_meeting_notes | string | Internal Meeting Notes |
hs_lastmodifieddate | string | Last modified date |
hs_meeting_body | string | Meeting description |
hs_meeting_calendar_event_hash | string | Meeting calendar event hash |
hs_meeting_change_id | string | Meeting change id |
hs_meeting_created_from_link_id | string | Created From Link ID |
hs_meeting_end_time | string | Meeting end time |
hs_meeting_external_url | string | External URL |
hs_meeting_location | string | Meeting location |
hs_meeting_location_type | string | Location type |
hs_meeting_outcome | string | Meeting outcome |
hs_meeting_pre_meeting_prospect_reminders | string | Pre-meeting prospect reminders |
hs_meeting_source | string | Meeting source |
hs_meeting_source_id | string | Source ID |
hs_meeting_start_time | string | Meeting start time |
hs_meeting_title | string | Meeting name |
hs_meeting_web_conference_meeting_id | string | Web conference meeting ID |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_scheduled_tasks | string | Scheduled tasks |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Meetings_Delete
Move a meeting to the recycling bin
Parameter
<meetingId> (required): Unique identifier for a meeting to delete
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Meetings_DeleteAssociation
Removes a meeting's association with a contact, deal or company
Parameter
<meetingId> (required): The ID of the meeting
<objectId> (required): The ID of the company or contact
<objectType> (required): Specify whether you would like to associate the meeting with a contact, deal or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Notes
List of Notes
Parameter
<archived> (optional): Whether to return only results that have been archived
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Note ID |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Body preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | boolean | Body Preview Truncated |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | boolean | GDPR deleted |
hs_lastmodifieddate | string | Last modified date |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_note_body | string | Note body |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Example
CREATE VIEW hubspot_v2_examples.example_Notes
AS
SELECT * FROM hubspot_v2.Notes (
preview => TRUE
)
Notes_Associations
List associations of a note by type
Parameter
<noteId> (optional): The ID of the note
<note_table> (optional): Table name with note data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
noteId | string | The ID of the note |
objectId | string | The ID of the object |
type | string | Association type |
Example
CREATE VIEW hubspot_v2_examples.example_Notes_Associations
AS
SELECT * FROM hubspot_v2.Notes_Associations (
preview => TRUE
)
Notes_CreateAssociation
Associate a note with company, deal or contact
Parameter
<noteId> (required): The ID of the note
<objectId> (required): The ID of the company, deal or contact
<objectType> (required): Specify whether you would like to associate the note with a contact, deal or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Note ID |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Body preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_lastmodifieddate | string | Last modified date |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_note_body | string | Note body |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Notes_CreateOrUpdate
Create or update note
Parameter
<noteId> (optional): The ID of the note. If this value is null, then the note is created. If this value is specified, then the note with this ID will be updated
<properties> (required): The line of note properties. Should be supplied in json. "{"hs_timestamp" : "Required property, format - yyyy-MM-ddTHH:mm:ss.SSSZ","hs_product_name" : "The Product Name"
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Note ID |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Body preview |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_created_by | string | Activity created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Create date |
hs_engagement_source | string | Engagement Source |
hs_engagement_source_id | string | Engagement Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_lastmodifieddate | string | Last modified date |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Updated by |
hs_note_body | string | Note body |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue Memberships |
hs_timestamp | string | Activity date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Activity assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Notes_Delete
Move a note to the recycling bin
Parameter
<noteId> (required): Unique identifier for a note to delete
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Notes_DeleteAssociation
Removes a note's association with a contact, deal or company
Parameter
<noteId> (required): The ID of the note
<objectId> (required): The ID of the company, deal or contact
<objectType> (required): Specify whether you would like to associate the note with a contact, deal or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Products
Products
Parameter
<properties> (optional): Comma-separated list of properties
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
objectType | string | Object type |
portalId | string | Portal Id |
objectId | string | Object Id |
version | integer | Version |
isDeleted | boolean | Specifies that a product is deleted |
Submissions
Submissions of forms
Parameter
<form_guid> (optional): Form Guid
<form_table> (optional): Table with guid of the forms
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
form_guid | string | Form Guid |
submittedAt | string | Submitted At |
value_name | string | The name of the value |
value_value | string | The value |
pageUrl | string | Page Url |
submittedAt_timestamp | timestamp | Submitted At in Human-readable time |
Create View hubspot_v2_examples.example_Submissions
As
Select * From hubspot_v2.Submissions (
form_guid => '06544226-ea86-42e9-bbe2-a34b1332247a',
preview => true
);;
Tasks
List of Tasks
Parameter
<archived> (optional): Whether to return only results that have been archived
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Task ID |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Notes (preview) |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | boolean | Body Preview Truncated |
hs_calendar_event_id | string | Calendar Event ID |
hs_created_by | string | Created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Created at |
hs_engagement_source | string | Source |
hs_engagement_source_id | string | Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | boolean | GDPR deleted |
hs_lastmodifieddate | string | Last modified at |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Last modified by |
hs_msteams_message_id | string | MS Teams message ID |
hs_num_associated_companies | string | Associated Companies |
hs_num_associated_contacts | string | Associated Contacts |
hs_num_associated_deals | string | Associated Deals |
hs_num_associated_queue_objects | string | Associated Queue Objects |
hs_num_associated_tickets | string | Associated Tickets |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue |
hs_scheduled_tasks | string | Scheduled tasks |
hs_task_body | string | Notes |
hs_task_completion_date | string | Completed at |
hs_task_contact_timezone | string | Contact Time Zone |
hs_task_for_object_type | string | For Object Type |
hs_task_is_all_day | boolean | Task is all day |
hs_task_last_contact_outreach | string | Last contacted |
hs_task_last_sales_activity_timestamp | string | Last engagement |
hs_task_priority | string | Priority |
hs_task_probability_to_complete | string | Task probability to complete |
hs_task_relative_reminders | string | Relative Task Reminders |
hs_task_reminders | string | Reminder |
hs_task_repeat_interval | string | Interval |
hs_task_send_default_reminder | boolean | Send Default Reminder |
hs_task_sequence_enrollment_active | boolean | Sequence Enrollment Is Active |
hs_task_sequence_step_enrollment_id | string | Sequence step enrollment Id |
hs_task_sequence_step_order | string | Sequence step number |
hs_task_status | string | Status |
hs_task_subject | string | Title |
hs_task_template_id | string | Task template id |
hs_task_type | string | Type |
hs_timestamp | string | Due date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Example
CREATE VIEW hubspot_v2_examples.example_Tasks
AS
SELECT * FROM hubspot_v2.Tasks (
preview => TRUE
)
Tasks_Associations
List associations of a task by type
Parameter
<taskId> (optional): The ID of the task
<task_table> (optional): Table name with task data
<target_table> (optional): Table name to save the data to
<preview> (optional): Preview only, don't write into table
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
taskId | string | The ID of the task |
objectId | string | The ID of the object |
type | string | Association type |
Example
CREATE VIEW hubspot_v2_examples.example_Tasks_Associations
AS
SELECT * FROM hubspot_v2.Tasks_Associations (
preview => TRUE
)
Tasks_CreateAssociation
Associate a task with company, deal or contact
Parameter
<taskId> (required): The ID of the task
<objectId> (required): The ID of the company, deal or contact
<objectType> (required): Specify whether you would like to associate the task with a contact, deal or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Task ID |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Notes (preview) |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_calendar_event_id | string | Calendar Event ID |
hs_created_by | string | Created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Created at |
hs_engagement_source | string | Source |
hs_engagement_source_id | string | Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_lastmodifieddate | string | Last modified at |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Last modified by |
hs_msteams_message_id | string | MS Teams message ID |
hs_num_associated_companies | string | Associated Companies |
hs_num_associated_contacts | string | Associated Contacts |
hs_num_associated_deals | string | Associated Deals |
hs_num_associated_queue_objects | string | Associated Queue Objects |
hs_num_associated_tickets | string | Associated Tickets |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue |
hs_scheduled_tasks | string | Scheduled tasks |
hs_task_body | string | Notes |
hs_task_completion_date | string | Completed at |
hs_task_contact_timezone | string | Contact Time Zone |
hs_task_for_object_type | string | For Object Type |
hs_task_is_all_day | string | Task is all day |
hs_task_last_contact_outreach | string | Last contacted |
hs_task_last_sales_activity_timestamp | string | Last engagement |
hs_task_priority | string | Priority |
hs_task_probability_to_complete | string | Task probability to complete |
hs_task_relative_reminders | string | Relative Task Reminders |
hs_task_reminders | string | Reminder |
hs_task_repeat_interval | string | Interval |
hs_task_send_default_reminder | string | Send Default Reminder |
hs_task_sequence_enrollment_active | string | Sequence Enrollment Is Active |
hs_task_sequence_step_enrollment_id | string | Sequence step enrollment Id |
hs_task_sequence_step_order | string | Sequence step number |
hs_task_status | string | Status |
hs_task_subject | string | Title |
hs_task_template_id | string | Task template id |
hs_task_type | string | Type |
hs_timestamp | string | Due date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Tasks_CreateOrUpdate
Create or update task
Parameter
<taskId> (optional): The ID of the task. If this value is null, then the task is created. If this value is specified, then the task with this ID will be updated
<properties> (required): The line of task properties. Should be supplied in json. "{"hs_timestamp" : "Required property, format - yyyy-MM-ddTHH:mm:ss.SSSZ","hs_task_body" : "The Body"
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
id | string | Task ID |
hs_all_assigned_business_unit_ids | string | Business units |
hs_at_mentioned_owner_ids | string | At-Mentioned Owner Ids |
hs_attachment_ids | string | Attached file IDs |
hs_body_preview | string | Notes (preview) |
hs_body_preview_html | string | HTML Body Preview |
hs_body_preview_is_truncated | string | Body Preview Truncated |
hs_calendar_event_id | string | Calendar Event ID |
hs_created_by | string | Created by |
hs_created_by_user_id | string | Created by user ID |
hs_createdate | string | Created at |
hs_engagement_source | string | Source |
hs_engagement_source_id | string | Source ID |
hs_follow_up_action | string | Follow up action |
hs_gdpr_deleted | string | GDPR deleted |
hs_lastmodifieddate | string | Last modified at |
hs_merged_object_ids | string | Merged object IDs |
hs_modified_by | string | Last modified by |
hs_msteams_message_id | string | MS Teams message ID |
hs_num_associated_companies | string | Associated Companies |
hs_num_associated_contacts | string | Associated Contacts |
hs_num_associated_deals | string | Associated Deals |
hs_num_associated_queue_objects | string | Associated Queue Objects |
hs_num_associated_tickets | string | Associated Tickets |
hs_object_id | string | Object ID |
hs_product_name | string | Product name |
hs_queue_membership_ids | string | Queue |
hs_scheduled_tasks | string | Scheduled tasks |
hs_task_body | string | Notes |
hs_task_completion_date | string | Completed at |
hs_task_contact_timezone | string | Contact Time Zone |
hs_task_for_object_type | string | For Object Type |
hs_task_is_all_day | string | Task is all day |
hs_task_last_contact_outreach | string | Last contacted |
hs_task_last_sales_activity_timestamp | string | Last engagement |
hs_task_priority | string | Priority |
hs_task_probability_to_complete | string | Task probability to complete |
hs_task_relative_reminders | string | Relative Task Reminders |
hs_task_reminders | string | Reminder |
hs_task_repeat_interval | string | Interval |
hs_task_send_default_reminder | string | Send Default Reminder |
hs_task_sequence_enrollment_active | string | Sequence Enrollment Is Active |
hs_task_sequence_step_enrollment_id | string | Sequence step enrollment Id |
hs_task_sequence_step_order | string | Sequence step number |
hs_task_status | string | Status |
hs_task_subject | string | Title |
hs_task_template_id | string | Task template id |
hs_task_type | string | Type |
hs_timestamp | string | Due date |
hs_unique_creation_key | string | Unique creation key |
hs_unique_id | string | Unique ID |
hs_updated_by_user_id | string | Updated by user ID |
hs_user_ids_of_all_notification_followers | string | User IDs of all notification followers |
hs_user_ids_of_all_notification_unfollowers | string | User IDs of all notification unfollowers |
hs_user_ids_of_all_owners | string | User IDs of all owners |
hubspot_owner_assigneddate | string | Owner Assigned Date |
hubspot_owner_id | string | Assigned to |
hubspot_team_id | string | HubSpot Team |
hs_all_owner_ids | string | All owner ids |
hs_all_team_ids | string | All team ids |
hs_all_accessible_team_ids | string | All accessible team ids |
createdAt | timestamp | Create date |
updatedAt | timestamp | Updated date |
archived | boolean | Is archived |
archivedAt | timestamp | Archive date |
Tasks_Delete
Move a task to the recycling bin
Parameter
<taskId> (required): Unique identifier for a task to delete
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |
Tasks_DeleteAssociation
Removes a task's association with a contact, deal or company
Parameter
<taskId> (required): The ID of the task
<objectId> (required): The ID of the company, deal or contact
<objectType> (required): Specify whether you would like to associate the task with a contact, deal or a company.
<label> (optional): Multi-tenancy label
Attribute | Type | Description |
---|---|---|
message | string | Result |