DealProperties
Provides access to deal property fields, both standard and custom, supporting deal tracking and analysis.
Table Specific Information
Deal properties are a number of custom properties that are available to store data about the deals in your HubSpot Hub. Some of these properties are added by HubSpot and cannot be deleted. They will be automatically added to the Deals on a new connection.
SELECT
Deal properties can only be filtered by the unique deal property name. For example:
SELECT * FROM DealProperties WHERE Name = 'property_name'
Columns
| Name | Type | ReadOnly | References | Description |
| Name [KEY] | String | False |
Unique name identifier for the deal property. Must consist of lowercase letters and numbers, starting with a letter. | |
| Label | String | False |
Human-readable label displayed for the deal property in the HubSpot UI. | |
| FieldType | String | False |
The type of input field shown for the deal property, such as text, dropdown, or checkbox. The allowed values are textarea, select, text, date, file, number, radio, checkbox, booleancheckbox. | |
| Type | String | False |
Machine-readable data type used to store the deal property value. The allowed values are string, number, bool, datetime, enumeration. | |
| GroupName | String | False |
DealPropertyGroups.Name |
Name of the group or category to which the deal property belongs. |
| Description | String | False |
Brief description explaining the purpose of the deal property. | |
| DisplayMode | String | False |
Specifies how the property will appear in the user interface, such as standard, hidden, or read-only. | |
| DisplayOrder | Integer | False |
Numerical order determining the property's position among others in its group. | |
| ExternalOptions | Boolean | False |
Indicates whether the property's options are sourced externally. | |
| IsFormField | Boolean | False |
Boolean flag indicating whether the property is available as a field in forms. | |
| IsCalculated | Boolean | False |
Indicates whether the property is calculated based on other property values. | |
| IsHidden | Boolean | False |
Boolean flag indicating whether the property is hidden from the standard user interface. | |
| IsDeleted | Boolean | True |
Boolean flag indicating whether the property has been deleted. | |
| IsHubspotDefined | Boolean | True |
Indicates whether the property is a default property defined by HubSpot. | |
| ShowCurrencySymbol | Boolean | False |
Boolean indicating whether a currency symbol is displayed with the property value. Only relevant for numeric fields. | |
| MutableDefinitionNotDeletable | Boolean | False |
Specifies whether the property's definition can be modified but not deleted. | |
| ReadOnlyDefinition | Boolean | False |
Indicates whether the property's structure is read-only and cannot be changed. | |
| ReadOnlyValue | Boolean | False |
Boolean flag indicating whether the property's value is locked and cannot be edited. | |
| OptionsUpdatable | Boolean | False |
Indicates whether the property's options can be updated. | |
| OptionsAggregate | String | False |
Aggregate string of selectable options for the property. Populated for field types like radio buttons, checkboxes, or boolean checkboxes. | |
| ExtraUrlParameters | String | True |
Optional input-only property to specify additional query parameters when retrieving deal property data. Format: 'param1=value1, param2=value2, param3=value3'. |