DealProperties

Retrieves all available deal property fields in HubSpot, both standard and custom properties.

Table Specific Information

SELECT

SELECT * FROM DealProperties

INSERT

To create a new DealProperties record, the type, fieldType, and groupName fields are required. For example:

INSERT INTO DealProperties (Name, Label, type, fieldType, groupName) VALUES ('test','test', 'string', 'text', 'deal_revenue')

UPDATE

UPDATE DealProperties Set Label='TestProperty11' WHERE  Name = 'testproperty'

DELETE

DELETE FROM DealProperties WHERE Name='test'

Columns


Name	Type	ReadOnly	References	Filterable	Description
Name [KEY]	String	False		True	Internal name of the deal property, consisting of lowercase letters and numbers, starting with a letter. Serves as the unique identifier.
Label	String	False		False	User-friendly label displayed in the HubSpot UI to represent the deal property.
FieldType	String	False		False	Defines the input field type (such as text, dropdown, or checkbox) for this property as displayed in the UI.
Type	String	False		False	Underlying machine data type (such as string, number, or date) used to store the property's value.
GroupName	String	False		False	Identifies the property group this deal property belongs to for organizational display.
Description	String	False		False	Detailed explanation of the property's purpose and how it is used in deal records.
DisplayOrder	Int	False		False	Numeric value determining the order this property appears relative to others within its group.
ExternalOptions	Bool	False		False	Indicates whether the property's selectable options are sourced externally.
IsFormField	Bool	False		False	Specifies whether this property appears as an editable field within HubSpot forms.
IsCalculated	Bool	False		False	Indicates whether the property's value is automatically calculated based on other properties or data.
IsHidden	Bool	False		False	Determines whether the property is hidden from standard views in the HubSpot interface.
IsHubspotDefined	Bool	False		False	True if the property is predefined by HubSpot, false if it was custom-created.
Archivable	Bool	False		False	Indicates whether this property can be archived and removed from active use.
ReadOnlyDefinition	Bool	False		False	Specifies whether the property's definition (such as type or label) is locked and cannot be modified.
ReadOnlyValue	Bool	False		False	Specifies whether the property's value is read-only and not editable by users.
OptionsAggregate	String	False		False	Serialized list of selectable options for the property, relevant when FieldType supports multiple-choice fields (such as radio buttons or checkboxes).
HasUniqueValue	Bool	False		False	Indicates whether each deal's value for this property must be unique across all records.