Navigation: Catalog: BETA > Schemas > Schema: Basic > Tables

Emails: HubSpot Emails

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

Catalog: BETA

Schema: Basic

Label: Emails

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 Emails. 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 Emails 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_hs_all_accessible_team_ids	string	All Accessible Team IDs	☐
prop_hs_all_assigned_business_unit_ids	string	All Assigned Business Unit IDs	☐
prop_hs_all_owner_ids	string	All Owner IDs	☐
prop_hs_all_team_ids	string	All Team IDs	☐
prop_hs_at_mentioned_owner_ids	string	At Mentioned Owner IDs	☐
prop_hs_attachment_ids	string	Attachment IDs	☐
prop_hs_body_preview_html	string	Body Preview (HTML)	☐
prop_hs_body_preview_is_truncated	boolean	Body Preview is Truncated	☐
prop_hs_body_preview	string	Body Preview	☐
prop_hs_campaign_guid	string	{res:itgen_hubspot_prop_hs_campaign_guid}	☐
prop_hs_created_by_user_id	decimal	Created by User ID	☐
prop_hs_created_by	string	Created by	☐
prop_hs_createdate	datetime	Created at	☐
prop_hs_direction_and_unique_id	string	Direction and Unique ID	☐
prop_hs_email_associated_contact_id	decimal	{res:itgen_hubspot_prop_hs_email_associated_contact_id}	☐
prop_hs_email_bcc_email	string	Email BCC Email	☐
prop_hs_email_bcc_firstname	string	Email BCC First Name	☐
prop_hs_email_bcc_lastname	string	Email BCC Last Name	☐
prop_hs_email_bcc_raw	string	Email Bcc Raw	☐
prop_hs_email_bounce_error_detail_message	string	Email Bounce Error Detail Message	☐
prop_hs_email_bounce_error_detail_status_code	decimal	Email Bounce Error Detail Status Code	☐
prop_hs_email_cc_email	string	Email CC Email	☐
prop_hs_email_cc_firstname	string	Email CC First Name	☐
prop_hs_email_cc_lastname	string	Email CC Last Name	☐
prop_hs_email_cc_raw	string	Email CC Raw	☐
prop_hs_email_click_count	decimal	{res:itgen_hubspot_prop_hs_email_click_count}	☐
prop_hs_email_direction	string	Email Direction	☐
prop_hs_email_encoded_email_associations_request	string	Email Encoded Email Associations Request	☐
prop_hs_email_error_message	string	Email Error Message	☐
prop_hs_email_facsimile_send_id	string	Email Facsimile Send ID	☐
prop_hs_email_from_email	string	Email From Email	☐
prop_hs_email_from_firstname	string	Email From First Name	☐
prop_hs_email_from_lastname	string	Email From Last Name	☐
prop_hs_email_from_raw	string	Email From Raw	☐
prop_hs_email_has_inline_images_stripped	boolean	Email Has Inline Images Stripped	☐
prop_hs_email_headers	string	Email Headers	☐
prop_hs_email_html	string	Email (HTML)	☐
prop_hs_email_logged_from	string	Email Logged from	☐
prop_hs_email_media_processing_status	string	Email Media Processing Status	☐
prop_hs_email_member_of_forwarded_subthread	boolean	Email Member of Forwarded Subthread	☐
prop_hs_email_message_id	string	Email Message ID	☐
prop_hs_email_migrated_via_portal_data_migration	string	Email Migrated via Portal Data Migration	☐
prop_hs_email_ms_teams_payload	string	{res:itgen_hubspot_prop_hs_email_ms_teams_payload}	☐
prop_hs_email_open_count	decimal	{res:itgen_hubspot_prop_hs_email_open_count}	☐
prop_hs_email_pending_inline_image_ids	string	Email Pending Inline Image IDs	☐
prop_hs_email_post_send_status	string	Email Post Send Status	☐
prop_hs_email_recipient_drop_reasons	string	Email Recipient Drop Reasons	☐
prop_hs_email_reply_count	decimal	{res:itgen_hubspot_prop_hs_email_reply_count}	☐
prop_hs_email_send_event_id_created	datetime	Email Send Event ID Created	☐
prop_hs_email_send_event_id	string	Email Send Event ID	☐
prop_hs_email_sender_email	string	Email Sender Email	☐
prop_hs_email_sender_firstname	string	Email Sender First Name	☐
prop_hs_email_sender_lastname	string	Email Sender Last Name	☐
prop_hs_email_sender_raw	string	Email Sender Raw	☐
prop_hs_email_sent_count	decimal	{res:itgen_hubspot_prop_hs_email_sent_count}	☐
prop_hs_email_sent_via	string	Email Sent Via	☐
prop_hs_email_status	string	Email Status	☐
prop_hs_email_stripped_attachment_count	decimal	Email Stripped Attachment Count	☐
prop_hs_email_subject	string	Email Subject	☐
prop_hs_email_text	string	Email Text	☐
prop_hs_email_thread_id	string	Email Thread ID	☐
prop_hs_email_thread_summary	string	{res:itgen_hubspot_prop_hs_email_thread_summary}	☐
prop_hs_email_to_email	string	Email To Email	☐
prop_hs_email_to_firstname	string	Email To First Name	☐
prop_hs_email_to_lastname	string	Email To Last Name	☐
prop_hs_email_to_raw	string	Email To Raw	☐
prop_hs_email_tracker_key	string	Email Tracker Key	☐
prop_hs_email_validation_skipped	string	Email Validation Skipped	☐
prop_hs_engagement_source_id	string	Engagement Source ID	☐
prop_hs_engagement_source	string	Engagement Source	☐
prop_hs_follow_up_action	string	Follow-up Action	☐
prop_hs_gdpr_deleted	boolean	GDPR Deleted	☐
prop_hs_incoming_email_is_out_of_office	boolean	{res:itgen_hubspot_prop_hs_incoming_email_is_out_of_office}	☐
prop_hs_lastmodifieddate	datetime	Last Modified Date	☐
prop_hs_merged_object_ids	string	Merged Object IDs	☐
prop_hs_modified_by	string	Modified by	☐
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_owner_ids_bcc	string	{res:itgen_hubspot_prop_hs_owner_ids_bcc}	☐
prop_hs_owner_ids_cc	string	{res:itgen_hubspot_prop_hs_owner_ids_cc}	☐
prop_hs_owner_ids_from	string	{res:itgen_hubspot_prop_hs_owner_ids_from}	☐
prop_hs_owner_ids_to	string	{res:itgen_hubspot_prop_hs_owner_ids_to}	☐
prop_hs_product_name	string	Product Name	☐
prop_hs_queue_membership_ids	string	Queue Membership IDs	☐
prop_hs_read_only	boolean	Read-only	☐
prop_hs_scs_association_status	string	{res:itgen_hubspot_prop_hs_scs_association_status}	☐
prop_hs_scs_audit_id	string	{res:itgen_hubspot_prop_hs_scs_audit_id}	☐
prop_hs_shared_team_ids	string	{res:itgen_hubspot_prop_hs_shared_team_ids}	☐
prop_hs_shared_user_ids	string	{res:itgen_hubspot_prop_hs_shared_user_ids}	☐
prop_hs_ticket_create_date	datetime	{res:itgen_hubspot_prop_hs_ticket_create_date}	☐
prop_hs_timestamp	datetime	Timestamp	☐
prop_hs_unique_creation_key	string	Unique Creation Key	☐
prop_hs_unique_id	string	Unique ID	☐
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	☐
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

Emails: HubSpot Emails

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information