NoteProperties
Retrieves all available property fields for notes, useful for managing note metadata.
Columns
| Name | Type | ReadOnly | References | Filterable | Description |
| Name [KEY] | String | False | True |
Internal name of the note property. Must begin with a lowercase letter and contain only lowercase letters and numbers. | |
| Label | String | False | False |
Display name for the note property, visible to users in the HubSpot interface. | |
| FieldType | String | False | False |
Type of UI control used to enter or display the property's value, such as text, date picker, or dropdown. | |
| Type | String | False | False |
Underlying data type used to store the property's value, such as string, number, or boolean. | |
| GroupName | String | False | False |
Name of the property group to which this note property belongs. | |
| Description | String | False | False |
Explanation of the purpose and intended use of the property. | |
| DisplayOrder | Int | False | False |
Numerical value that determines the order in which this property appears relative to others in the same group. | |
| ExternalOptions | Bool | False | False |
Indicates whether the options for this property are managed from an external source. | |
| IsFormField | Bool | False | False |
Indicates whether this property can be included in forms. | |
| IsCalculated | Bool | False | False |
Indicates whether the value of the property is calculated automatically. | |
| IsHidden | Bool | False | False |
Indicates whether the property is hidden from standard views in the HubSpot interface. | |
| IsHubspotDefined | Bool | False | False |
Indicates whether the property is a standard field created by HubSpot. | |
| Archivable | Bool | False | False |
Indicates whether this property can be archived if no longer in use. | |
| ReadOnlyDefinition | Bool | False | False |
Indicates whether the configuration of this property can be edited. | |
| ReadOnlyValue | Bool | False | False |
Indicates whether the property's value is read-only and cannot be manually changed. | |
| OptionsAggregate | String | False | False |
List of predefined options available for this property if it is a choice field such as checkbox or radio. | |
| HasUniqueValue | Bool | False | False |
Boolean indicating whether the value of the property is unique. |