Constructors

Properties

archived?: boolean

Whether or not the property is archived.

archivedAt?: Date

When the property was archived.

calculated?: boolean

For default properties, true indicates that the property is calculated by a HubSpot process. It has no effect for custom properties.

calculationFormula?: string

Represents a formula that is used to compute a calculated property.

createdAt?: Date
createdUserId?: string

The internal user ID of the user who created the property in HubSpot. This field may not exist if the property was created outside of HubSpot.

description: string

A description of the property that will be shown as help text in HubSpot.

displayOrder?: number

Properties are shown in order, starting with the lowest positive integer value.

externalOptions?: boolean

For default properties, true indicates that the options are stored externally to the property settings.

fieldType: string

Controls how the property appears in HubSpot.

formField?: boolean

Whether or not the property can be used in a HubSpot form.

groupName: string

The name of the property group the property belongs to.

hasUniqueValue?: boolean

Whether or not the property's value must be unique. Once set, this can't be changed.

hidden?: boolean

Whether or not the property will be hidden from the HubSpot UI. It's recommended this be set to false for custom properties.

hubspotDefined?: boolean

This will be true for default object properties built into HubSpot.

label: string

A human-readable property label that will be shown in HubSpot.

modificationMetadata?: PropertyModificationMetadata
name: string

The internal property name, which must be used when referencing the property via the API.

options: Option[]

A list of valid options for the property. This field is required for enumerated properties, but will be empty for other property types.

referencedObjectType?: string

If this property is related to other object(s), they'll be listed here.

showCurrencySymbol?: boolean

Whether or not the property will display the currency symbol set in the account settings.

type: string

The property data type.

updatedAt?: Date
updatedUserId?: string

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.

attributeTypeMap: {
    baseName: string;
    format: string;
    name: string;
    type: string;
}[] = ...
discriminator: undefined | string = undefined

Methods

  • Returns {
        baseName: string;
        format: string;
        name: string;
        type: string;
    }[]