Navigation: Catalog: Contacts > Schemas

Contacts: HubSpot Contacts

Retrieve contactsRetrieve all contacts, using query parameters to specify the information that gets returned.

Catalog: Contacts

Schema: Basic

Label: Contacts

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 Contacts. 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		☐		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		☐		Whether to return only results that have been archived.

Columns of Table Function

The columns of the table function Contacts 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	Documentation
archived	char	Archived	☐	Whether the object is archived.
archivedAt	datetime	Archived at	☐	The timestamp when the object was archived, in ISO 8601 format.
associations	varchar2	Associations	☐	A list defining relationships with other objects.
createdAt	datetime	Created at	☐	The timestamp when the object was created, in ISO 8601 format.
id	varchar2	ID	☐	The unique ID of the object.
objectWriteTraceId	varchar2		☐	An identifier used for tracing the creation or update request of the object.
prop_address	varchar2	Address	☐
prop_annualrevenue	varchar2	Annual Revenue	☐
prop_associatedcompanyid	decimal	Associated Company ID	☐
prop_associatedcompanylastupdated	decimal	Associated Company Last Updated	☐
prop_city	varchar2	City	☐
prop_closedate	datetime	Close Date	☐
prop_company_size	varchar2	Company Size	☐
prop_company	varchar2	Company	☐
prop_country	varchar2	Country	☐
prop_createdate	datetime	Created at	☐
prop_currentlyinworkflow	varchar2	Currently in Workflow	☐
prop_date_of_birth	varchar2	Date of Birth	☐
prop_days_to_close	decimal	Days to Close	☐
prop_degree	varchar2	Degree	☐
prop_email	varchar2	Email	☐
prop_engagements_last_meeting_booked_campaign	varchar2	Last Meeting Booked Campaign	☐
prop_engagements_last_meeting_booked_medium	varchar2	Last Meeting Booked Medium	☐
prop_engagements_last_meeting_booked_source	varchar2	Last Meeting Booked Source	☐
prop_engagements_last_meeting_booked	datetime	Last Meeting Booked	☐
prop_fax	varchar2	Fax	☐
prop_field_of_study	varchar2	Field of Study	☐
prop_first_conversion_date	datetime	First Conversion Date	☐
prop_first_conversion_event_name	varchar2	First Conversion Event Name	☐
prop_first_deal_created_date	datetime	First Deal Created at	☐
prop_firstname	varchar2	First Name	☐
prop_gender	varchar2	Gender	☐
prop_graduation_date	varchar2	Graduation Date	☐
prop_hs_additional_emails	varchar2	Additional Emails	☐
prop_hs_all_accessible_team_ids	varchar2	All Accessible Team IDs	☐
prop_hs_all_contact_vids	varchar2	All Contact VIDs	☐
prop_hs_all_owner_ids	varchar2	All Owner IDs	☐
prop_hs_all_team_ids	varchar2	All Team IDs	☐
prop_hs_analytics_average_page_views	decimal	Analytics Average Page Views	☐
prop_hs_analytics_first_referrer	varchar2	Analytics First Referrer	☐
prop_hs_analytics_first_timestamp	datetime	Analytics First Timestamp	☐
prop_hs_analytics_first_touch_converting_campaign	varchar2		☐
prop_hs_analytics_first_url	varchar2	Analytics First URL	☐
prop_hs_analytics_first_visit_timestamp	datetime		☐
prop_hs_analytics_last_referrer	varchar2	Analytics Last Referrer	☐
prop_hs_analytics_last_timestamp	datetime		☐
prop_hs_analytics_last_touch_converting_campaign	varchar2		☐
prop_hs_analytics_last_url	varchar2	Analytics Last URL	☐
prop_hs_analytics_last_visit_timestamp	datetime		☐
prop_hs_analytics_num_event_completions	decimal	Analytics Number of Event Completions	☐
prop_hs_analytics_num_page_views	decimal	Analytics Number of Page Views	☐
prop_hs_analytics_num_visits	decimal	Analytics Number of Visits	☐
prop_hs_analytics_revenue	decimal	Analytics Revenue	☐
prop_hs_analytics_source_data_1	varchar2	Analytics Source Data 1	☐
prop_hs_analytics_source_data_2	varchar2	Analytics Source Data 2	☐
prop_hs_analytics_source	varchar2	Analytics Source	☐
prop_hs_associated_target_accounts	decimal		☐
prop_hs_avatar_filemanager_key	varchar2	Avatar Filemanager Key	☐
prop_hs_buying_role	varchar2	Buying Role	☐
prop_hs_calculated_form_submissions	varchar2	Calculated Form Submissions	☐
prop_hs_calculated_merged_vids	varchar2	Calculated Merged VIDs	☐
prop_hs_calculated_mobile_number	varchar2	Calculated Mobile Number	☐
prop_hs_calculated_phone_number_area_code	varchar2	Calculated Phone Number Area Code	☐
prop_hs_calculated_phone_number_country_code	varchar2	Calculated Phone Number Country Code	☐
prop_hs_calculated_phone_number_region_code	varchar2	Calculated Phone Number Region Code	☐
prop_hs_calculated_phone_number	varchar2	Calculated Phone Number	☐
prop_hs_chat_assistant_iql_date	datetime		☐
prop_hs_chat_assistant_source	varchar2		☐
prop_hs_chat_assistant_summary	varchar2		☐
prop_hs_clicked_linkedin_ad	varchar2	Clicked LinkedIn Ad	☐
prop_hs_contact_enrichment_opt_out_timestamp	datetime		☐
prop_hs_contact_enrichment_opt_out	char		☐
prop_hs_content_membership_email_confirmed	char	Content Membership Email Confirmed	☐
prop_hs_content_membership_email	varchar2	Content Membership Email	☐
prop_hs_content_membership_follow_up_enqueued_at	datetime		☐
prop_hs_content_membership_notes	varchar2	Content Membership Notes	☐
prop_hs_content_membership_registered_at	datetime	Content Membership Registered at	☐
prop_hs_content_membership_registration_domain_sent_to	varchar2	Content Membership Registration Domain Sent to	☐
prop_hs_content_membership_registration_email_sent_at	datetime	Content Membership Registration Email Sent at	☐
prop_hs_content_membership_status	varchar2	Content Membership Status	☐
prop_hs_conversations_visitor_email	varchar2	Conversations Visitor Email	☐
prop_hs_count_is_unworked	decimal	Count is Unworked	☐
prop_hs_count_is_worked	decimal	Count is Worked	☐
prop_hs_country_region_code	varchar2		☐
prop_hs_created_by_conversations	char	Created by Conversations	☐
prop_hs_created_by_user_id	decimal	Created by User ID	☐
prop_hs_createdate	datetime	Created at	☐
prop_hs_cross_account_note	varchar2		☐
prop_hs_cross_sell_opportunity	char		☐
prop_hs_document_last_revisited	datetime	Document Last Revisited	☐
prop_hs_email_bad_address	char	Email Bad Address	☐
prop_hs_email_bounce	decimal	Email Bounce	☐
prop_hs_email_click	decimal	Email Click	☐
prop_hs_email_customer_quarantined_reason	varchar2	Email Customer Quarantained Reason	☐
prop_hs_email_delivered	decimal	Email Delivered	☐
prop_hs_email_domain	varchar2	Email Domain	☐
prop_hs_email_first_click_date	datetime	Email First Click Date	☐
prop_hs_email_first_open_date	datetime	Email First Open Date	☐
prop_hs_email_first_reply_date	datetime	Email First Reply Date	☐
prop_hs_email_first_send_date	datetime	Email First Send Date	☐
prop_hs_email_hard_bounce_reason_enum	varchar2	Email Hard Bounce Reason Enumeration	☐
prop_hs_email_hard_bounce_reason	varchar2	Email Hard Bounce Reason	☐
prop_hs_email_is_ineligible	char	Email is Ineligible	☐
prop_hs_email_last_click_date	datetime	Email Last Click Date	☐
prop_hs_email_last_email_name	varchar2	Email Last Email Name	☐
prop_hs_email_last_open_date	datetime	Email Last Open Date	☐
prop_hs_email_last_reply_date	datetime	Email Last Reply Date	☐
prop_hs_email_last_send_date	datetime	Email Last Send Date	☐
prop_hs_email_open	decimal	Email Open	☐
prop_hs_email_optimal_send_day_of_week	varchar2		☐
prop_hs_email_optimal_send_time_of_day	varchar2		☐
prop_hs_email_optout_194989673	varchar2		☐
prop_hs_email_optout_195239151	varchar2		☐
prop_hs_email_optout_329127693	varchar2		☐
prop_hs_email_optout	char	Email Opt-out	☐
prop_hs_email_quarantined_reason	varchar2	Email Quarantained Reason	☐
prop_hs_email_quarantined	char	Email Quarantained	☐
prop_hs_email_replied	decimal	Email Replied	☐
prop_hs_email_sends_since_last_engagement	decimal	Email Sends since Last Engagement	☐
prop_hs_email_type	varchar2		☐
prop_hs_emailconfirmationstatus	varchar2	Email Confirmation Status	☐
prop_hs_enriched_email_bounce_detected	char		☐
prop_hs_excluded_from_cross_account_data_mirroring	char		☐
prop_hs_facebook_ad_clicked	char	Facebook Ad Clicked	☐
prop_hs_facebook_click_id	varchar2	Facebook Click ID	☐
prop_hs_first_closed_order_id	decimal		☐
prop_hs_first_engagement_object_id	decimal	First Engagement Object ID	☐
prop_hs_first_order_closed_date	datetime		☐
prop_hs_first_outreach_date	datetime	First Outreach Date	☐
prop_hs_first_subscription_create_date	datetime	First Subscription Created at	☐
prop_hs_full_name_or_email	varchar2		☐
prop_hs_geohash_1	varchar2		☐
prop_hs_geohash_2	varchar2		☐
prop_hs_geohash_3	varchar2		☐
prop_hs_geohash_4	varchar2		☐
prop_hs_geohash_5	varchar2		☐
prop_hs_geohash_6	varchar2		☐
prop_hs_google_click_id	varchar2	Google Click ID	☐
prop_hs_has_active_subscription	decimal	Has Active Subscription	☐
prop_hs_inferred_language_codes	varchar2		☐
prop_hs_intent_paid_up_to_date	datetime		☐
prop_hs_intent_signals_enabled	char		☐
prop_hs_ip_timezone	varchar2	IP Timezone	☐
prop_hs_is_contact	char	Is Contact	☐
prop_hs_is_enriched	char		☐
prop_hs_is_unworked	char	Is Unworked	☐
prop_hs_language	varchar2	Language	☐
prop_hs_last_metered_enrichment_timestamp	datetime		☐
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	varchar2	Last Sales Activity Type	☐
prop_hs_last_sms_send_date	datetime		☐
prop_hs_last_sms_send_name	varchar2		☐
prop_hs_lastmodifieddate	datetime	Last Modified Date	☐
prop_hs_latest_disqualified_lead_date	datetime		☐
prop_hs_latest_meeting_activity	datetime	Latest Meeting Activity	☐
prop_hs_latest_open_lead_date	datetime		☐
prop_hs_latest_qualified_lead_date	datetime		☐
prop_hs_latest_sequence_ended_date	datetime	Latest Sequence Ended Date	☐
prop_hs_latest_sequence_enrolled_date	datetime	Latest Sequence Enrolled Date	☐
prop_hs_latest_sequence_enrolled	decimal	Latest Sequence Enrolled	☐
prop_hs_latest_sequence_finished_date	datetime	Latest Sequence Finished Date	☐
prop_hs_latest_sequence_unenrolled_date	datetime	Latest Sequence Unenrolled Date	☐
prop_hs_latest_source_data_1	varchar2	Latest Source Data 1	☐
prop_hs_latest_source_data_2	varchar2	Latest Source Data 2	☐
prop_hs_latest_source_timestamp	datetime	Latest Source Timestamp	☐
prop_hs_latest_source	varchar2	Latest Source	☐
prop_hs_latest_subscription_create_date	datetime	Latest Subscription Created at	☐
prop_hs_lead_status	varchar2	Lead Status	☐
prop_hs_legal_basis	varchar2	Legal Basis	☐
prop_hs_linkedin_ad_clicked	varchar2	LinkedIn Ad Clicked	☐
prop_hs_linkedin_click_id	varchar2		☐
prop_hs_linkedin_url	varchar2		☐
prop_hs_live_enrichment_deadline	datetime		☐
prop_hs_manual_campaign_ids	decimal		☐
prop_hs_membership_has_accessed_private_content	decimal		☐
prop_hs_membership_last_private_content_access_date	datetime		☐
prop_hs_merged_object_ids	varchar2	Merged Object IDs	☐
prop_hs_messaging_engagement_score	decimal		☐
prop_hs_mobile_sdk_push_tokens	varchar2		☐
prop_hs_notes_last_activity	varchar2		☐
prop_hs_notes_next_activity_type	varchar2		☐
prop_hs_notes_next_activity	varchar2		☐
prop_hs_object_id	decimal	Object ID	☐
prop_hs_object_source_detail_1	varchar2		☐
prop_hs_object_source_detail_2	varchar2		☐
prop_hs_object_source_detail_3	varchar2		☐
prop_hs_object_source_id	varchar2		☐
prop_hs_object_source_label	varchar2		☐
prop_hs_object_source_user_id	decimal		☐
prop_hs_object_source	varchar2		☐
prop_hs_owning_teams	varchar2		☐
prop_hs_persona	varchar2	Persona	☐
prop_hs_pinned_engagement_id	decimal	Pinned Engagement ID	☐
prop_hs_pipeline	varchar2	Pipeline	☐
prop_hs_prospecting_agent_actively_enrolled_count	decimal		☐
prop_hs_prospecting_agent_enrollment_status	varchar2		☐
prop_hs_prospecting_agent_last_enrolled	datetime		☐
prop_hs_prospecting_agent_sender	varchar2		☐
prop_hs_prospecting_agent_total_enrolled_count	decimal		☐
prop_hs_quarantined_emails	varchar2		☐
prop_hs_read_only	char	Read-only	☐
prop_hs_recent_closed_order_date	datetime		☐
prop_hs_registered_member	decimal		☐
prop_hs_registration_method	varchar2		☐
prop_hs_role	varchar2		☐
prop_hs_sa_first_engagement_date	datetime	First Engagement Date	☐
prop_hs_sa_first_engagement_descr	varchar2	First Engagement Description	☐
prop_hs_sa_first_engagement_object_type	varchar2	First Engagement Object Type	☐
prop_hs_sales_email_last_clicked	datetime	Sales Email Last Clicked	☐
prop_hs_sales_email_last_opened	datetime	Sales Email Last Opened	☐
prop_hs_sales_email_last_replied	datetime	Sales Email Last Replied	☐
prop_hs_searchable_calculated_international_mobile_number	varchar2	Searchable Calculated International Mobile Number	☐
prop_hs_searchable_calculated_international_phone_number	varchar2	Searchable Calculated International Phone Number	☐
prop_hs_searchable_calculated_mobile_number	varchar2	Searchable Calculated Mobile Number	☐
prop_hs_searchable_calculated_phone_number	varchar2	Searchable Calculated Phone Number	☐
prop_hs_seniority	varchar2		☐
prop_hs_sequences_actively_enrolled_count	decimal		☐
prop_hs_sequences_enrolled_count	decimal	Sequences Enrolled Count	☐
prop_hs_sequences_is_enrolled	char	Sequences Is Enrolled	☐
prop_hs_source_object_id	decimal		☐
prop_hs_source_portal_id	decimal		☐
prop_hs_state_code	varchar2		☐
prop_hs_sub_role	varchar2		☐
prop_hs_testpurge	varchar2	Test Purge	☐
prop_hs_testrollback	varchar2	Test Rollback	☐
prop_hs_tiktok_ad_clicked	char		☐
prop_hs_tiktok_click_id	varchar2		☐
prop_hs_time_to_first_engagement	decimal	Time to First Engagement	☐
prop_hs_timezone	varchar2	Timezone	☐
prop_hs_unique_creation_key	varchar2	Unique Creation Key	☐
prop_hs_updated_by_user_id	decimal	Updated by User ID	☐
prop_hs_user_ids_of_all_notification_followers	varchar2	User IDs of All Notification Followers	☐
prop_hs_user_ids_of_all_notification_unfollowers	varchar2	User IDs of All Notification Unfollowers	☐
prop_hs_user_ids_of_all_owners	varchar2	User IDs of All Owners	☐
prop_hs_v2_date_entered_customer	datetime		☐
prop_hs_v2_date_entered_evangelist	datetime		☐
prop_hs_v2_date_entered_lead	datetime		☐
prop_hs_v2_date_entered_marketingqualifiedlead	datetime		☐
prop_hs_v2_date_entered_opportunity	datetime		☐
prop_hs_v2_date_entered_other	datetime		☐
prop_hs_v2_date_entered_salesqualifiedlead	datetime		☐
prop_hs_v2_date_entered_subscriber	datetime		☐
prop_hs_v2_date_exited_customer	datetime		☐
prop_hs_v2_date_exited_evangelist	datetime		☐
prop_hs_v2_date_exited_lead	datetime		☐
prop_hs_v2_date_exited_marketingqualifiedlead	datetime		☐
prop_hs_v2_date_exited_opportunity	datetime		☐
prop_hs_v2_date_exited_other	datetime		☐
prop_hs_v2_date_exited_salesqualifiedlead	datetime		☐
prop_hs_v2_date_exited_subscriber	datetime		☐
prop_hs_was_imported	char	Was Imported	☐
prop_hs_whatsapp_phone_number	varchar2	WhatsApp Phone Number	☐
prop_hs_why_this_contact	varchar2		☐
prop_hubspot_owner_assigneddate	datetime	Owner Assigned Date	☐
prop_hubspot_owner_id	varchar2	Owner ID	☐
prop_hubspot_team_id	varchar2	Team ID	☐
prop_hubspotscore	decimal	Score	☐
prop_industry	varchar2	Industry	☐
prop_ip_city	varchar2	IP Address City	☐
prop_ip_country_code	varchar2	IP Address Country Code	☐
prop_ip_country	varchar2	IP Address Country	☐
prop_ip_latlon	varchar2	IP Address Latitude Longitude	☐
prop_ip_state_code	varchar2	IP Address State Code	☐
prop_ip_state	varchar2	IP Address State	☐
prop_ip_zipcode	varchar2	IP Address ZIP Code	☐
prop_job_function	varchar2	Job Function	☐
prop_jobtitle	varchar2	Job Title	☐
prop_lastmodifieddate	datetime	Last Modified Date	☐
prop_lastname	varchar2	Last Name	☐
prop_lifecyclestage	varchar2	Lifecycle Stage	☐
prop_marital_status	varchar2	Marital Status	☐
prop_message	varchar2	Message	☐
prop_military_status	varchar2	Military Status	☐
prop_mobilephone	varchar2	Mobile Phone	☐
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_deals	decimal	Number of Associated Deals	☐
prop_num_contacted_notes	decimal	Number of Contacted Notes	☐
prop_num_conversion_events	decimal	Number of Conversion Events	☐
prop_num_notes	decimal	Number of Notes	☐
prop_num_unique_conversion_events	decimal	Number of Unique Conversion Events	☐
prop_numemployees	varchar2	Number of Employees	☐
prop_phone	varchar2	Phone Number	☐
prop_recent_conversion_date	datetime	Recent Conversion Date	☐
prop_recent_conversion_event_name	varchar2	Recent Conversion Event Name	☐
prop_recent_deal_amount	decimal	Recent Deal Amount	☐
prop_recent_deal_close_date	datetime	Recent Deal Close Date	☐
prop_relationship_status	varchar2	Relationship Status	☐
prop_salutation	varchar2	Salutation	☐
prop_school	varchar2	School	☐
prop_seniority	varchar2	Seniority	☐
prop_start_date	varchar2	Start Date	☐
prop_state	varchar2	State	☐
prop_surveymonkeyeventlastupdated	decimal	Survey Monkey Event Last Updated	☐
prop_total_revenue	decimal	Total Revenue	☐
prop_twitterhandle	varchar2	Twitter Handle	☐
prop_webinareventlastupdated	decimal	Webinar Event Last Updated	☐
prop_website	varchar2	Website	☐
prop_work_email	varchar2	Work Email	☐
prop_zip	varchar2	ZIP Code	☐
updatedAt	datetime	Updated at	☐	The timestamp when the object was last updated, in ISO 8601 format.
url	varchar2	URL	☐	The URL on the API that provide direct navigation to the corresponding UI pages for the connectors.

Please enable JavaScript to view this site.

HubSpot API Data Model

Contacts: HubSpot Contacts

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information