HubSpot API Data Model
SchemaPropertiesByObjectType: HubSpot Schema Properties by Object Type |
Get an existing schemaReturns an existing object schema.
Catalog: CRMSchemas
Schema: Core
Label: Schema Properties by Object Type
This is a read-only table function. The HubSpot API may not support changing the data or the Invantive SQL 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 SchemaPropertiesByObjectType. 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 |
|---|---|---|---|---|
objectType |
string |
☑ |
|
Fully qualified name or object type ID of your schema. |
Columns of Table Function
The columns of the table function SchemaPropertiesByObjectType are shown below. Each column has an SQL data type.
Name |
Data Type |
Label |
Required |
Documentation |
|---|---|---|---|---|
archived_1 |
boolean |
Archived (Alternate) |
☐ |
|
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. |
createdAt_1 |
datetime |
Created at (Alternate) |
☐ |
When the object schema was created. |
createdAt |
datetime |
Created at |
☐ |
When the property was created |
createdUserId |
string |
Created User ID |
☐ |
The internal 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 |
☐ |
The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of -1 will cause the property to be displayed **after** any positive values. |
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. |
fullyQualifiedName |
string |
Fully Qualified Name |
☐ |
An assigned unique ID for the object, including portal ID and object name. |
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 |
☐ |
|
hubspotDefined |
boolean |
HubSpot Defined |
☐ |
This will be true for default object properties built into HubSpot. |
id |
string |
ID |
☐ |
A unique ID for this schema's object type. Will be defined as {meta-type}-{unique ID}. |
label |
string |
Label |
☐ |
A human-readable property label that will be shown in HubSpot. |
labels_plural |
string |
Labels Plural |
☐ |
The word for multiple objects. (There’s no way to change this later.) |
labels_singular |
string |
Labels Singular |
☐ |
The word for one object. (There’s no way to change this later.) |
modificationMetadata_archivable |
boolean |
|
☐ |
|
modificationMetadata_readOnlyDefinition |
boolean |
|
☐ |
|
modificationMetadata_readOnlyOptions |
boolean |
|
☐ |
|
modificationMetadata_readOnlyValue |
boolean |
|
☐ |
|
name_1 |
string |
Name (Alternate) |
☐ |
A unique name for the schema's object type. |
name |
string |
Name |
☐ |
The internal property name, which must be used when referencing the property via the API. |
objectTypeId |
string |
Ojbect Type ID |
☐ |
|
primaryDisplayProperty |
string |
Primary Display Property |
☐ |
The name of the primary property for this object. This will be displayed as primary on the HubSpot record page for this object type. |
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 the property will display the currency symbol set in the account settings. |
type |
string |
Type |
☐ |
The property data type. |
updatedAt_1 |
datetime |
Updated at (Alternate) |
☐ |
When the object schema was last updated. |
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. |
17-08-2023 07:25 Version 22.1.262-BETA+4120
