Navigation: Catalog: Properties3 > Schemas > Schema: Core > Tables

PropertyNamesByObjectType: HubSpot

Read a propertyRead a property identified by {propertyName}.

Catalog: Properties3

Schema: Core

This is a read-only table function. The HubSpot API may not support changing the data or the Invantive UniversalSQL driver for HubSpot does not cover it. In the latter case, please use the table NativePlatformScalarRequests to upload data to the HubSpot API.

Parameters of Table Function

The following parameters can be used to control the behaviour of the table function PropertyNamesByObjectType. 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	Documentation
archived	boolean	☐	Whether to return only results that have been archived.
objectType	string	☑
properties	string	☐
propertyName	string	☑

Columns of Table Function

The columns of the table function PropertyNamesByObjectType are shown below. Each column has an SQL data type.

Name	Data Type	Label	Required	Documentation
archived	boolean	Archived	☐	Whether or not the property is archived.
archivedAt	datetime	Archived at	☐	When the property was archived.
calculated	boolean	Calculated	☐	For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
calculationFormula	string	Calculation Formula	☐	Represents a formula that is used to compute a calculated property.
createdAt	datetime	Created at	☐
createdUserId	string	Created User ID	☐	The internal user ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.
description	string	Description	☐	A description of the property that will be shown as help text in HubSpot.
displayOrder	int32	Display Order	☐	Properties are shown in order, starting with the lowest positive integer value.
externalOptions	boolean	External Options	☐	For default properties, true indicates that the options are stored externally to the property settings.
fieldType	string	Field Type	☐	Controls how the property appears in HubSpot.
formField	boolean	Form Field	☐	Whether or not the property can be used in a HubSpot form.
groupName	string	Group Name	☐	The name of the property group the property belongs to.
hasUniqueValue	boolean	Has Unique Value	☐	Whether or not the property's value must be unique. Once set, this can't be changed.
hidden	boolean	Hidden	☐	Whether or not the property will be hidden from the HubSpot UI. It's recommended this be set to false for custom properties.
hubspotDefined	boolean	HubSpot Defined	☐	This will be true for default object properties built into HubSpot.
label	string	Label	☐	A human-readable property label that will be shown in HubSpot.
modificationMetadata_archivable	boolean	{res:itgen_hubspot_modificationmetadata_archivable}	☐
modificationMetadata_readOnlyDefinition	boolean	{res:itgen_hubspot_modificationmetadata_readonlydefinition}	☐
modificationMetadata_readOnlyOptions	boolean	{res:itgen_hubspot_modificationmetadata_readonlyoptions}	☐
modificationMetadata_readOnlyValue	boolean	{res:itgen_hubspot_modificationmetadata_readonlyvalue}	☐
name	string	Name	☐	The internal property name, which must be used when referencing the property via the API.
referencedObjectType	string	Referenced Object Type	☐	If this property is related to other object(s), they'll be listed here.
showCurrencySymbol	boolean	Show Currency Symbol	☐	Whether or not the property will display the currency symbol set in the account settings.
type	string	Type	☐	The property data type.
updatedAt	datetime	Updated at	☐
updatedUserId	string	Updated User ID	☐	The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.

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

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

PropertyNamesByObjectType: HubSpot

Parameters of Table Function

Columns of Table Function

Important Safety and Usage Information