TaskProperties
Retrieves available property fields associated with tasks, useful for managing task records.
Columns
| Name | Type | ReadOnly | References | Filterable | Description |
| Name [KEY] | String | False | True |
Internal name of the task property. Must start with a lowercase letter and contain only lowercase letters and numbers. | |
| Label | String | False | False |
Display label of the task property as shown in the HubSpot interface. | |
| FieldType | String | False | False |
Type of UI component used for this property, such as text field, dropdown, or checkbox. | |
| Type | String | False | False |
Underlying machine-readable data type of the property, such as string, number, or boolean. | |
| GroupName | String | False | False |
Group that organizes the task property within the task object. | |
| Description | String | False | False |
Description explaining the property's purpose and how it is used. | |
| DisplayOrder | Int | False | False |
Numeric value that controls the position of this property within its group. | |
| ExternalOptions | Bool | False | False |
Indicates whether the property's options are defined externally rather than within HubSpot. | |
| IsFormField | Bool | False | False |
Indicates whether this property can be included in a form for data input. | |
| IsCalculated | Bool | False | False |
Indicates whether the property's value is automatically calculated based on other properties. | |
| IsHidden | Bool | False | False |
Indicates whether the property is hidden from the standard user interface. | |
| IsHubspotDefined | Bool | False | False |
Indicates whether the property is part of HubSpot's default schema. | |
| Archivable | Bool | False | False |
Indicates whether the property can be archived and excluded from future use. | |
| ReadOnlyDefinition | Bool | False | False |
Indicates whether the configuration of the property is locked from editing. | |
| ReadOnlyValue | Bool | False | False |
Indicates whether the value of the property is locked and cannot be manually changed. | |
| OptionsAggregate | String | False | False |
List of selectable options available for this property, applicable if the field type supports choices such as radio or checkbox. | |
| HasUniqueValue | Bool | False | False |
Boolean indicating whether the value of the property is unique. |