ContactProperties
Accesses both standard and custom properties assigned to contacts, critical for personalized marketing and sales strategies.
Table Specific Information
Contact properties are a number of custom properties that are available to store data about the contacts in your HubSpot Hub. Some of these properties are added by HubSpot and cannot be deleted. They will be automatically added to the Contacts on a new connection.
SELECT
Contact properties can only be filtered by the unique contact property name or group name. For example:
SELECT * FROM ContactProperties WHERE Name = 'property_name' SELECT * FROM ContactProperties WHERE GroupName = 'group_name'
Columns
| Name | Type | ReadOnly | References | Description |
| Name [KEY] | String | False |
Unique name identifier for the contact property. Must consist of lowercase letters and numbers, starting with a letter. | |
| Label | String | False |
Human-readable label displayed for the contact property in the HubSpot UI. | |
| FieldType | String | False |
The type of input field shown for the contact property, such as text, dropdown, or checkbox. The allowed values are textarea, select, text, date, file, number, radio, checkbox. | |
| Type | String | False |
Machine-readable data type used to store the contact property value. The allowed values are string, number, bool, datetime, enumeration. | |
| GroupName | String | False |
Name of the group or category to which the contact property belongs. | |
| Description | String | False |
Brief description explaining the purpose of the contact property. | |
| DisplayMode | String | False |
Specifies how the property will appear in the user interface, such as a standard field or hidden value. | |
| 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 form field. | |
| 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. | |
| IsFavorited | Boolean | False |
Boolean flag indicating whether the property is marked as favorited in the UI. | |
| FavoritedOrder | Integer | False |
Numerical value determining the order of favorited properties for display purposes. | |
| 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. | |
| 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 contact property data. Format: 'param1=value1, param2=value2, param3=value3'. |