Navigation: Catalog: Companies3 > Schemas

Companies: HubSpot Companies

ListRead a page of companies. Control what is returned via the `properties` query param.

Catalog: Companies3

Schema: Basic

Label: Companies

Retrieve: true

Insert: true

Update: false

Delete: false

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function Companies. A value must be provided at all times for required parameters, but optional parameters in general do not need to have a value and the execution will default to a pre-defined behaviour. Values can be specified by position and by name. In both cases, all parameters not specified will be evaluated using their default values.

Value specification by position is done by listing all values from the first to the last needed value. For example: a `select * from table(value1, value2, value3)` on a table with four parameters will use the default value for the fourth parameter and the specified values for the first three.

Value specification by name is done by listing all values that require a value. For example with `select * from table(name1 => value1, name3 => value3)` on the same table will use the default values for the second and fourth parameters and the specified values for the first and third.

Name	Data Type	Required	Default Value	Documentation
after	string	☐		The paging cursor token of the last successfully read resource will be returned as the `paging.next.after` JSON property of a paged response containing more results.
archived	boolean	☐		Whether to return only results that have been archived.

Columns of Table Function

The columns of the table function Companies are shown below. Each column has an SQL data type. A new non-null value must be provided for every required column at all times during insert.

Name	Data Type	Label	Required
archived	boolean	Archived	☐
archivedAt	datetime	Archived at	☐
associations	string	Associations	☐
createdAt	datetime	Created at	☐
id	string	ID	☐
prop_about_us	string	About Us	☐
prop_address	string	Address	☐
prop_address2	string	Address 2	☐
prop_annualrevenue	decimal	Annual Revenue	☐
prop_city	string	City	☐
prop_closedate	datetime	Close Date	☐
prop_country	string	Country	☐
prop_createdate	datetime	Created at	☐
prop_days_to_close	decimal	Days to Close	☐
prop_description	string	Description	☐
prop_domain	string	Domain	☐
prop_engagements_last_meeting_booked_campaign	string	Last Meeting Booked Campaign	☐
prop_engagements_last_meeting_booked_medium	string	Last Meeting Booked Medium	☐
prop_engagements_last_meeting_booked_source	string	Last Meeting Booked Source	☐
prop_engagements_last_meeting_booked	datetime	Last Meeting Booked	☐
prop_facebook_company_page	string	Facebook Company Page	☐
prop_facebookfans	decimal	Facebook Fans	☐
prop_first_contact_createdate_timestamp_earliest_value_78b50eea	datetime	{res:itgen_hubspot_prop_first_contact_createdate_timestamp_earliest_value_78b50eea}	☐
prop_first_contact_createdate	datetime	First Contact Created at	☐
prop_first_conversion_date	datetime	First Conversion Date	☐
prop_first_conversion_event_name	string	First Conversion Event Name	☐
prop_first_deal_created_date	datetime	First Deal Created at	☐
prop_founded_year	string	Founded Year	☐
prop_googleplus_page	string	Google+ Page	☐
prop_hs_additional_domains	string	Additional Domains	☐
prop_hs_all_accessible_team_ids	string	All Accessible Team IDs	☐
prop_hs_all_owner_ids	string	All Owner IDs	☐
prop_hs_all_team_ids	string	All Team IDs	☐
prop_hs_analytics_first_timestamp	datetime	Analytics First Timestamp	☐
prop_hs_analytics_first_touch_converting_campaign	string	{res:itgen_hubspot_prop_hs_analytics_first_touch_converting_campaign}	☐
prop_hs_analytics_first_visit_timestamp	datetime	{res:itgen_hubspot_prop_hs_analytics_first_visit_timestamp}	☐
prop_hs_analytics_last_timestamp_timestamp_latest_value_4e16365a	datetime	{res:itgen_hubspot_prop_hs_analytics_last_timestamp_timestamp_latest_value_4e16365a}	☐
prop_hs_analytics_last_timestamp	datetime	{res:itgen_hubspot_prop_hs_analytics_last_timestamp}	☐
prop_hs_analytics_last_touch_converting_campaign_timestamp_latest_value_81a64e30	datetime	{res:itgen_hubspot_prop_hs_analytics_last_touch_converting_campaign_timestamp_latest_value_81a64e30}	☐
prop_hs_analytics_last_touch_converting_campaign	string	{res:itgen_hubspot_prop_hs_analytics_last_touch_converting_campaign}	☐
prop_hs_analytics_last_visit_timestamp_timestamp_latest_value_999a0fce	datetime	{res:itgen_hubspot_prop_hs_analytics_last_visit_timestamp_timestamp_latest_value_999a0fce}	☐
prop_hs_analytics_last_visit_timestamp	datetime	{res:itgen_hubspot_prop_hs_analytics_last_visit_timestamp}	☐
prop_hs_analytics_latest_source_data_1	string	Analytics Latest Source Data 1	☐
prop_hs_analytics_latest_source_data_2	string	Analytics Latest Source Data 2	☐
prop_hs_analytics_latest_source_timestamp	datetime	Analytics Latest Source Timestamp	☐
prop_hs_analytics_latest_source	string	Analytics Latest Source	☐
prop_hs_analytics_num_page_views_cardinality_sum_e46e85b0	decimal	{res:itgen_hubspot_prop_hs_analytics_num_page_views_cardinality_sum_e46e85b0}	☐
prop_hs_analytics_num_page_views	decimal	Analytics Number of Page Views	☐
prop_hs_analytics_num_visits_cardinality_sum_53d952a6	decimal	{res:itgen_hubspot_prop_hs_analytics_num_visits_cardinality_sum_53d952a6}	☐
prop_hs_analytics_num_visits	decimal	Analytics Number of Visits	☐
prop_hs_analytics_source_data_1	string	Analytics Source Data 1	☐
prop_hs_analytics_source_data_2	string	Analytics Source Data 2	☐
prop_hs_analytics_source	string	Analytics Source	☐
prop_hs_annual_revenue_currency_code	string	Annual Revenue Currency Code	☐
prop_hs_avatar_filemanager_key	string	Avatar Filemanager Key	☐
prop_hs_country_code	string	{res:itgen_hubspot_prop_hs_country_code}	☐
prop_hs_created_by_user_id	decimal	Created by User ID	☐
prop_hs_createdate	datetime	Created at	☐
prop_hs_date_entered_customer	datetime	Date Entered Customer	☐
prop_hs_date_entered_evangelist	datetime	Date Entered Evangelist	☐
prop_hs_date_entered_lead	datetime	Date Entered Lead	☐
prop_hs_date_entered_marketingqualifiedlead	datetime	Date Entered Marketing Qualified Lead	☐
prop_hs_date_entered_opportunity	datetime	Date Entered Opportunity	☐
prop_hs_date_entered_other	datetime	Date Entered Other	☐
prop_hs_date_entered_salesqualifiedlead	datetime	Date Entered Sales Qualified Lead	☐
prop_hs_date_entered_subscriber	datetime	Date Entered Subscriber	☐
prop_hs_date_exited_customer	datetime	Date Exited Customer	☐
prop_hs_date_exited_evangelist	datetime	Date Exited Evangelist	☐
prop_hs_date_exited_lead	datetime	Date Exited lead	☐
prop_hs_date_exited_marketingqualifiedlead	datetime	Date Exited Marketing Qualified Lead	☐
prop_hs_date_exited_opportunity	datetime	Date Exited Opportunity	☐
prop_hs_date_exited_other	datetime	Date Exited Other	☐
prop_hs_date_exited_salesqualifiedlead	datetime	Date Exited Sales Qualified Lead	☐
prop_hs_date_exited_subscriber	datetime	Date Exited Subscriber	☐
prop_hs_employee_range	string	{res:itgen_hubspot_prop_hs_employee_range}	☐
prop_hs_ideal_customer_profile	string	Ideal Customer Profile	☐
prop_hs_industry_group	string	{res:itgen_hubspot_prop_hs_industry_group}	☐
prop_hs_is_enriched	boolean	{res:itgen_hubspot_prop_hs_is_enriched}	☐
prop_hs_is_target_account	boolean	Is Target Account	☐
prop_hs_keywords	string	{res:itgen_hubspot_prop_hs_keywords}	☐
prop_hs_last_booked_meeting_date	datetime	Last Booked Meeting Date	☐
prop_hs_last_logged_call_date	datetime	Last Logged Call Date	☐
prop_hs_last_open_task_date	datetime	Last Open Task Date	☐
prop_hs_last_sales_activity_date	datetime	Last Sales Activity Date	☐
prop_hs_last_sales_activity_timestamp	datetime	Last Sales Activity Timestamp	☐
prop_hs_last_sales_activity_type	string	Last Sales Activity Type	☐
prop_hs_lastmodifieddate	datetime	Last Modified Date	☐
prop_hs_latest_createdate_of_active_subscriptions	datetime	Lastest Created at of Active Subscription	☐
prop_hs_latest_meeting_activity	datetime	Latest Meeting Activity	☐
prop_hs_lead_status	string	Lead Status	☐
prop_hs_linkedin_handle	string	{res:itgen_hubspot_prop_hs_linkedin_handle}	☐
prop_hs_logo_url	string	Logo (URL)	☐
prop_hs_merged_object_ids	string	Merged Object IDs	☐
prop_hs_notes_next_activity_type	string	{res:itgen_hubspot_prop_hs_notes_next_activity_type}	☐
prop_hs_num_blockers	decimal	Number of Blockers	☐
prop_hs_num_child_companies	decimal	Number of Child Companies	☐
prop_hs_num_contacts_with_buying_roles	decimal	Number of Contacts with Buying Roles	☐
prop_hs_num_decision_makers	decimal	Number of Decision Makers	☐
prop_hs_num_open_deals	decimal	Number of Open Deals	☐
prop_hs_object_id	decimal	Object ID	☐
prop_hs_object_source_detail_1	string	{res:itgen_hubspot_prop_hs_object_source_detail_1}	☐
prop_hs_object_source_detail_2	string	{res:itgen_hubspot_prop_hs_object_source_detail_2}	☐
prop_hs_object_source_detail_3	string	{res:itgen_hubspot_prop_hs_object_source_detail_3}	☐
prop_hs_object_source_id	string	{res:itgen_hubspot_prop_hs_object_source_id}	☐
prop_hs_object_source_label	string	{res:itgen_hubspot_prop_hs_object_source_label}	☐
prop_hs_object_source_user_id	decimal	{res:itgen_hubspot_prop_hs_object_source_user_id}	☐
prop_hs_object_source	string	{res:itgen_hubspot_prop_hs_object_source}	☐
prop_hs_parent_company_id	decimal	Parent Company ID	☐
prop_hs_pinned_engagement_id	decimal	Pinned Engagement ID	☐
prop_hs_pipeline	string	Pipeline	☐
prop_hs_predictivecontactscore_v2_next_max_max_d4e58c1e	decimal	{res:itgen_hubspot_prop_hs_predictivecontactscore_v2_next_max_max_d4e58c1e}	☐
prop_hs_quick_context	string	{res:itgen_hubspot_prop_hs_quick_context}	☐
prop_hs_read_only	boolean	Read-only	☐
prop_hs_revenue_range	string	{res:itgen_hubspot_prop_hs_revenue_range}	☐
prop_hs_sales_email_last_replied	datetime	Sales Email Last Replied	☐
prop_hs_target_account_probability	decimal	Target Account Probability	☐
prop_hs_target_account_recommendation_snooze_time	datetime	Target Account Recommendation Snooze Time	☐
prop_hs_target_account_recommendation_state	string	Target Account Recommendation State	☐
prop_hs_target_account	string	Target Account	☐
prop_hs_time_in_customer	decimal	Time in Customer	☐
prop_hs_time_in_evangelist	decimal	Time in Evangelist	☐
prop_hs_time_in_lead	decimal	Time in Lead	☐
prop_hs_time_in_marketingqualifiedlead	decimal	Time in Marketing Qualified Lead	☐
prop_hs_time_in_opportunity	decimal	Time in Opportunity	☐
prop_hs_time_in_other	decimal	Time in Other	☐
prop_hs_time_in_salesqualifiedlead	decimal	Time in Sales Qualified Lead	☐
prop_hs_time_in_subscriber	decimal	Time in Subscriber	☐
prop_hs_total_deal_value	decimal	Total Deal Value	☐
prop_hs_unique_creation_key	string	Unique Creation Key	☐
prop_hs_updated_by_user_id	decimal	Updated by User ID	☐
prop_hs_user_ids_of_all_notification_followers	string	User IDs of All Notification Followers	☐
prop_hs_user_ids_of_all_notification_unfollowers	string	User IDs of All Notification Unfollowers	☐
prop_hs_user_ids_of_all_owners	string	User IDs of All Owners	☐
prop_hs_was_imported	boolean	Was Imported	☐
prop_hubspot_owner_assigneddate	datetime	Owner Assigned Date	☐
prop_hubspot_owner_id	string	Owner ID	☐
prop_hubspot_team_id	string	Team ID	☐
prop_hubspotscore	decimal	Score	☐
prop_industry	string	Industry	☐
prop_is_public	boolean	Is Public	☐
prop_lifecyclestage	string	Lifecycle Stage	☐
prop_linkedin_company_page	string	LinkedIn Company Page	☐
prop_linkedinbio	string	LinkedIn Bio	☐
prop_name	string	Name	☐
prop_notes_last_contacted	datetime	Notes Last Contacted	☐
prop_notes_last_updated	datetime	Notes Last Updated	☐
prop_notes_next_activity_date	datetime	Notes Next Activity Date	☐
prop_num_associated_contacts	decimal	Number of Associated Contacts	☐
prop_num_associated_deals	decimal	Number of Associated Deals	☐
prop_num_contacted_notes	decimal	Number of Contacted Notes	☐
prop_num_conversion_events_cardinality_sum_d095f14b	decimal	{res:itgen_hubspot_prop_num_conversion_events_cardinality_sum_d095f14b}	☐
prop_num_conversion_events	decimal	Number of Conversion Events	☐
prop_num_notes	decimal	Number of Notes	☐
prop_numberofemployees	decimal	Number of Employees	☐
prop_phone	string	Phone Number	☐
prop_recent_conversion_date_timestamp_latest_value_72856da1	datetime	{res:itgen_hubspot_prop_recent_conversion_date_timestamp_latest_value_72856da1}	☐
prop_recent_conversion_date	datetime	Recent Conversion Date	☐
prop_recent_conversion_event_name_timestamp_latest_value_66c820bf	datetime	{res:itgen_hubspot_prop_recent_conversion_event_name_timestamp_latest_value_66c820bf}	☐
prop_recent_conversion_event_name	string	Recent Conversion Event Name	☐
prop_recent_deal_amount	decimal	Recent Deal Amount	☐
prop_recent_deal_close_date	datetime	Recent Deal Close Date	☐
prop_state	string	State	☐
prop_timezone	string	Timezone	☐
prop_total_money_raised	string	Total Money Raised	☐
prop_total_revenue	decimal	Total Revenue	☐
prop_twitterbio	string	Twitter Biography	☐
prop_twitterfollowers	decimal	Twitter Followers	☐
prop_twitterhandle	string	Twitter Handle	☐
prop_type	string	Type	☐
prop_web_technologies	string	Web Technologies	☐
prop_website	string	Website	☐
prop_zip	string	ZIP Code	☐
updatedAt	datetime	Updated at	☐

18-12-2024 20:09 Version 24.1.33-BETA+5180

Please enable JavaScript to view this site.

HubSpot API Data Model

Companies: HubSpot Companies

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information