OrderProperties
Retrieves all properties associated with orders, including standard and custom fields.
Columns
| Name | Type | ReadOnly | References | Filterable | Description |
| Name [KEY] | String | False | True |
Internal name of the order property. Must begin with a lowercase letter and include only lowercase letters and numbers. | |
| Label | String | False | False |
User-friendly label for the property as it appears in the HubSpot interface. | |
| FieldType | String | False | False |
UI input type used to display the property, such as text field, dropdown, or date picker. | |
| Type | String | False | False |
Underlying data type used to store the property's value, such as string, number, or datetime. | |
| GroupName | String | False | False |
Name of the property group this field belongs to within the order object. | |
| Description | String | False | False |
Explanation of the property's purpose and how it is used. | |
| DisplayOrder | Int | False | False |
Numeric value that determines this property's position relative to others in its group. | |
| ExternalOptions | Bool | False | False |
Indicates whether selectable options for this property are managed externally from HubSpot. | |
| IsFormField | Bool | False | False |
Indicates whether the property can be used as a field on a form. | |
| IsCalculated | Bool | False | False |
Indicates whether the property's value is derived from calculations rather than manually entered. | |
| IsHidden | Bool | False | False |
Indicates whether the property is hidden from standard views in the user interface. | |
| IsHubspotDefined | Bool | False | False |
Indicates whether the property was created by HubSpot as part of the standard object model. | |
| Archivable | Bool | False | False |
Indicates whether the property can be archived and removed from active use. | |
| ReadOnlyDefinition | Bool | False | False |
Indicates whether the property's configuration (such as name or type) is locked from editing. | |
| ReadOnlyValue | Bool | False | False |
Indicates whether the property's value is read-only and cannot be modified by users. | |
| OptionsAggregate | String | False | False |
List of possible options for the property, used if the field type supports selectable values such as checkboxes or radio buttons. | |
| HasUniqueValue | Bool | False | False |
Indicates whether the property must contain a unique value across all order records. |