Please enable JavaScript to view this site.

Made in EU
HubSpot Forums

HubSpot API Data Model

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

Communications: HubSpot Communications

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

Catalog: BETA

Schema: Basic

Label: Communications

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 Communications. 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 Communications 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

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_communication_body

string

Communication Body

☐

 

prop_hs_communication_channel_type

string

Communication Channel Type

☐

 

prop_hs_communication_conversation_associations_synced_at

datetime

{res:itgen_hubspot_prop_hs_communication_conversation_associations_synced_at}

☐

 

prop_hs_communication_conversation_object_id

decimal

{res:itgen_hubspot_prop_hs_communication_conversation_object_id}

☐

 

prop_hs_communication_conversations_channel_ids

string

{res:itgen_hubspot_prop_hs_communication_conversations_channel_ids}

☐

 

prop_hs_communication_conversations_channel_instance_ids

string

{res:itgen_hubspot_prop_hs_communication_conversations_channel_instance_ids}

☐

 

prop_hs_communication_conversations_first_message_at

datetime

{res:itgen_hubspot_prop_hs_communication_conversations_first_message_at}

☐

 

prop_hs_communication_conversations_thread_id

decimal

{res:itgen_hubspot_prop_hs_communication_conversations_thread_id}

☐

 

prop_hs_communication_logged_from

string

Communication Logged From

☐

 

prop_hs_created_by_user_id

decimal

Created by User ID

☐

 

prop_hs_created_by

decimal

Created by

☐

 

prop_hs_createdate

datetime

Created at

☐

 

prop_hs_engagement_source_id

string

Engagement Source ID

☐

 

prop_hs_engagement_source

string

Engagement Source

☐

 

prop_hs_gdpr_deleted

boolean

GDPR Deleted

☐

 

prop_hs_lastmodifieddate

datetime

Last Modified Date

☐

 

prop_hs_merged_object_ids

string

Merged Object IDs

☐

 

prop_hs_modified_by

decimal

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_read_only

boolean

Read-only

☐

 

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_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

X

Important Safety and Usage Information

Intended Use and Limitations: This software, developed by Invantive, is designed to support a variety of business and information technology data processing functions, such as accounting, financial reporting an sales reporting. It is important to note that this software is not designed, tested, or approved for use in environments where malfunction or failure could lead to life-threatening situations or severe physical or environmental damage. This includes, but is not limited to:

  • Nuclear facilities: The software should not be used for operations or functions related to the control, maintenance, or operation of nuclear facilities.
  • Defense and Military Applications: This software is not suitable for use in defense-related applications, including but not limited to weaponry control, military strategy planning, or any other aspects of national defense.
  • Aviation: The software is not intended for use in the operation, navigation, or communication systems of any aircraft or air traffic control environments.
  • Healthcare and Medicine Production: This software should not be utilized for medical device operation, patient data analysis for critical health decisions, pharmaceutical production, or medical research where its failure or malfunction could impact patient health.
  • Chemical and Hazardous Material Handling: This software is not intended for the management, control, or operational aspects of chemical plants or hazardous material handling facilities. Any malfunction in software used in these settings could result in dangerous chemical spills, explosions, or environmental disasters.
  • Transportation and Traffic Control Systems: The software should not be used for the control, operation, or management of transportation systems, including railway signal controls, subway systems, or traffic light management. Malfunctions in such critical systems could lead to severe accidents and endanger public safety.
  • Energy Grid and Utility Control Systems: This software is not designed for the control or operation of energy grid systems, including electrical substations, renewable energy control systems, or water utility control systems. The failure of software in these areas could lead to significant power outages, water supply disruptions, or other public utility failures, potentially endangering communities and causing extensive damage.
  • Other High-Risk Environments: Any other critical infrastructure and environments where a failure of the software could result in significant harm to individuals or the environment.

User Responsibility: Users must ensure that they understand the intended use of the software and refrain from deploying it in any setting that falls outside of its designed purpose. It is the responsibility of the user to assess the suitability of the software for their intended application, especially in any scenarios that might pose a risk to life, health, or the environment.

Disclaimer of Liability: Invantive disclaims any responsibility for damage, injury, or legal consequences resulting from the use or misuse of this software in prohibited or unintended applications.
  
Disclaimer