Properties

OverviewEndpoints

Detailed information about HubSpot’s CRM objects is stored in properties, which can then be organized into groups. In addition to each object’s default properties, you can store specialized data by creating custom properties. The CRM properties endpoints allow you to manage these custom properties as well as view default property details for any object.

It’s important to consider how to architect your data. In many cases created custom properties on HubSpot native objects is the right course of action. However there may be times when you will need to create a separate custom object with its own set of properties.

Default properties

CRM objects are defined by a primary type and a set of properties. Each type has a unique set of standard properties, represented by a map of name-value pairs. 

Learn more about default properties for different objects:

Custom properties

Create custom properties to store specialized information for an object. Custom properties can be managed through the CRM object properties endpoints.

Property groups

Property groups are used to group related properties. Any grouped properties will appear next to each other on HubSpot records. If your integration creates any custom object properties, a custom property group will make it easy to identify that data.

type and fieldType values

When creating or updating properties, both type and fieldType values are required. The type value determines the type of the property, i.e. a string or a number. The fieldType property determines how the property will appear in HubSpot or on a form, i.e. as a plain text field, a dropdown menu, or a date picker.

The following tables list the available type and fieldType values, with the type table including information about which fieldType values are valid for a specific type.

Valid values for type field and compatible fieldType values
type Description Valid fieldType values
enumeration A string representing a set of options, with options separated by a semicolon  booleancheckbox, checkbox, radio, select
date An ISO 8601 formatted value representing a specific day, month, and year. date
dateTime An ISO 8601 formatted value representing a specific day, month, year and time of day. The HubSpot app will not display the time of day. date
string A plain text strings, limited to 65,536 characters. file, text, textarea
number A number value containing numeric digits and at most one decimal. number
Valid values for fieldType field
fieldType Description
booleancheckbox An input that will allow users to select one of either Yes or No. When used in a form, it will be displayed as a single checkbox.
checkbox A list of checkboxes that will allow a user to select multiple options from a set of options allowed for the property.
date A date value, displayed as a date picker.
file Allows for a file to be uploaded to a form. Stored and displayed as a URL link to the file.
number A string of numerals or numbers written in decimal or scientific notation.
radio An input that will allow users to select one of a set of options allowed for the property. When used in a form, this will be displayed as a set of radio buttons.
select A dropdown input that will allow users to select one of a set of options allowed for the property.
text A plain text string, displayed in a single line text input.
textarea A plain text string, displayed as a multi-line text input.
Was this page helpful? *
This form is for feedback on our developer docs. If you have feedback on the HubSpot product, please share it in our Idea Forum instead.