Navigation: Catalog: Notes > Schemas

Notes: HubSpot Notes

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

Catalog: Notes

Schema: Basic

Label: Notes

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 Notes. 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 Notes 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_hs_all_accessible_team_ids	varchar2	All Accessible Team IDs	☐
prop_hs_all_assigned_business_unit_ids	varchar2	All Assigned Business Unit IDs	☐
prop_hs_all_owner_ids	varchar2	All Owner IDs	☐
prop_hs_all_team_ids	varchar2	All Team IDs	☐
prop_hs_at_mentioned_owner_ids	varchar2	At Mentioned Owner IDs	☐
prop_hs_attachment_from_form_submission	char		☐
prop_hs_attachment_ids	varchar2	Attachment IDs	☐
prop_hs_body_preview_html	varchar2	Body Preview (HTML)	☐
prop_hs_body_preview_is_truncated	char	Body Preview is Truncated	☐
prop_hs_body_preview	varchar2	Body Preview	☐
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	varchar2	Engagement Source ID	☐
prop_hs_engagement_source	varchar2	Engagement Source	☐
prop_hs_follow_up_action	varchar2	Follow-up Action	☐
prop_hs_gdpr_deleted	char	GDPR Deleted	☐
prop_hs_hd_ticket_ids	decimal		☐
prop_hs_lastmodifieddate	datetime	Last Modified Date	☐
prop_hs_merged_object_ids	varchar2	Merged Object IDs	☐
prop_hs_modified_by	decimal	Modified by	☐
prop_hs_note_body	varchar2	Note Body	☐
prop_hs_note_ms_teams_payload	varchar2		☐
prop_hs_obj_coords	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_pinned_engagement_id	decimal	Pinned Engagement ID	☐
prop_hs_product_name	varchar2	Product Name	☐
prop_hs_queue_membership_ids	varchar2	Queue Membership IDs	☐
prop_hs_read_only	char	Read-only	☐
prop_hs_timestamp	datetime	Timestamp	☐
prop_hs_unique_creation_key	varchar2	Unique Creation Key	☐
prop_hs_unique_id	varchar2	Unique ID	☐
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_was_imported	char	Was Imported	☐
prop_hubspot_owner_assigneddate	datetime	Owner Assigned Date	☐
prop_hubspot_owner_id	varchar2	Owner ID	☐
prop_hubspot_team_id	varchar2	Team ID	☐
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.

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.

Please enable JavaScript to view this site.

HubSpot API Data Model

Notes: HubSpot Notes

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information