v4
latestOpenAPI 3.0.12026-07-131067109.8 KBPath parameters
Request body
A description of the property that will be shown as help text in HubSpot.
Human readable label for the property. Used in HubSpot UI
Internal property name, which must be used when referencing the property from the API
The data type of the property. Can be one of the following: [string, number, enumeration, datetime]
Response
successful operation
Whether the property is archived.
The timestamp when the property was archived, in ISO 8601 format.
Whether the property is a calculated field.
The formula used for calculated properties.
The timestamp when the property was created, in ISO 8601 format.
The ID of the user who created the property.
Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".
A summary of the property's purpose.
The position of the item relative to others in the list.
Applicable only for enumeration type properties. Should be set to true with a 'referencedObjectType' of 'OWNER'. Otherwise false.
Determines how the property will appear in HubSpot's UI or on a form. Learn more in the properties API guide.
Whether the property can appear on forms.
The name of the group to which the property is assigned.
Whether the property is a unique identifier property.
Whether or not the property will be hidden from the HubSpot UI. It's recommended that this be set to false for custom properties.
A boolean value set to true for HubSpot default properties.
The display label for the property.
The internal name for the property.
Deprecated. Use externalOptionsReferenceType instead.
When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").
Whether to show the currency symbol in HubSpot's UI.
The data type of the property, such as string or number.
The timestamp when the property was last updated, in ISO 8601 format.