CustomObjectProperties

Retrieve the available Custom Objects Properties in HubSpot. This table supports both OAuth and APIKey authentications.

Columns

Name	Type	References	Filterable	Description
ObjectId	String		False	An assigned unique ID for the object, including portal ID and object name.
ObjectFullyQualifiedName [KEY]	String		False	A unique ID for this schema's object type. It is defined as {meta-type}-{unique ID}.
ObjectName	String		False	A unique name for the schema's object type.
ObjectLabelSingular	String		False	Singular label for the object. Used in CRM display.
ObjectLabelPlural	String		False	Plural label for the object. Used in CRM display.
Name [KEY]	String		False	The internal property name, which must be used when referencing the property via the API.
Label	String		False	A human-readable property label that will be shown in HubSpot.
UpdatedAt	Datetime		False	When the Custom Object was last updated.
CreatedAt	Datetime		False	When the Custom Object was created.
ArchivedAt	Datetime		False	When the Custom Object was archived.
Type	String		False	The property data type.
FieldType	String		False	Controls how the property appears in HubSpot.
Description	String		False	A description of the property that will be shown as help text in HubSpot.
GroupName	String		False	The name of the property group the property belongs to.
Options	String		False	A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.
CreatedUserId	String		False	The internal ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.
UpdatedUserId	String		False	The internal user ID of the user who updated the property in HubSpot. This field may not exist if the property was updated outside of HubSpot.
ReferencedObjectType	String		False	If this property is related to other object(s), they'll be listed here.
DisplayOrder	Integer		False	The order that this property should be displayed in the HubSpot UI relative to other properties for this object type. Properties are displayed in order starting with the lowest positive integer value. A value of -1 will cause the property to be displayed after any positive values.
Calculated	Boolean		False	For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.
ExternalOptions	Boolean		False	For default properties, true indicates that the options are stored externally to the property settings.
Archived	Boolean		False	Whether or not the property is archived.
HasUniqueValue	Boolean		False	Whether or not the property's value must be unique. Once set, this can't be changed.
Hidden	Boolean		False	Whether or not the property is hidden.
HubspotDefined	Boolean		False	This will be true for default object properties built into HubSpot.
ShowCurrencySymbol	Boolean		False	Whether the property will display the currency symbol set in the account settings.
ModificationMetadata	String		False	The properties' modification metadata.
FormField	Boolean		False	Whether or not the property can be used in a HubSpot form.