Skip to main content
GET
Retrieve property

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

objectTypeId
string
required

The unique identifier of the object type whose property is being retrieved.

propertyName
string
required

The name of the property to retrieve information about.

Query Parameters

fields
enum<string>[]

A list of property fields to include in the response. Valid fields include category, label, type, fieldType, groupName, description, options, createdAt, updatedAt, hidden, readOnlyValue, readOnlyDefinition, hasUniqueValue, archivable, readOnlyOptions, calculationFormula, archived, calculated, optionsSource, dateDisplayFormat, numberDisplayFormat, currencyPropertyName, updatedByUserId, createdByUserId, dataEntryInstructions, optionColors, accessAllowlist, dataSensitivity, defaultValue, formField, sensitiveDataCategories, validationRules, rollupConfig, and syncConfig.

Available options:
category,
label,
type,
fieldType,
groupName,
description,
options,
createdAt,
updatedAt,
hidden,
readOnlyValue,
readOnlyDefinition,
hasUniqueValue,
archivable,
readOnlyOptions,
calculationFormula,
archived,
calculated,
optionsSource,
dateDisplayFormat,
numberDisplayFormat,
currencyPropertyName,
updatedByUserId,
createdByUserId,
dataEntryInstructions,
optionColors,
accessAllowlist,
dataSensitivity,
defaultValue,
formField,
sensitiveDataCategories,
validationRules,
rollupConfig,
syncConfig

Response

successful operation

category
enum<string>
required

Indicates the origin of the property, with possible values being 'HUBSPOT_DEFINED', 'INTEGRATION_DEFINED', or 'USER_DEFINED'.

Available options:
HUBSPOT_DEFINED,
INTEGRATION_DEFINED,
USER_DEFINED
fieldType
enum<string>
required

Defines the field type of the property, with options including 'BOOLEANCHECKBOX', 'CALCULATION_EQUATION', 'CALCULATION_READ_TIME', 'CALCULATION_ROLLUP', 'CALCULATION_SCORE', 'CHECKBOX', 'DATE', 'EMAIL', 'FILE', 'HTML', 'NUMBER', 'PHONE_NUMBER', 'RADIO', 'SELECT', 'TEXT', 'TEXTAREA', 'UNKNOWN', or 'URL'.

Available options:
BOOLEANCHECKBOX,
CALCULATION_EQUATION,
CALCULATION_READ_TIME,
CALCULATION_ROLLUP,
CALCULATION_SCORE,
CHECKBOX,
DATE,
EMAIL,
FILE,
HTML,
NUMBER,
PHONE_NUMBER,
RADIO,
SELECT,
TEXT,
TEXTAREA,
UNKNOWN,
URL
name
string
required

The unique name of the property, represented as a string.

type
enum<string>
required

Specifies the data type of the property, such as 'BOOL', 'CURRENCY_NUMBER', 'DATE', 'DATETIME', 'ENUMERATION', 'JSON', 'NUMBER', 'OBJECT_COORDINATES', 'PHONE_NUMBER', 'STRING', or 'TIME_RANGE'.

Available options:
BOOL,
CURRENCY_NUMBER,
DATE,
DATETIME,
ENUMERATION,
JSON,
NUMBER,
OBJECT_COORDINATES,
PHONE_NUMBER,
STRING,
TIME_RANGE
accessAllowlist
object[]

An array of access control entries defining who can view or edit the property.

archivable
boolean

A boolean indicating if the property can be archived.

archived
boolean

A boolean indicating whether the property is archived.

calculated
boolean

A boolean indicating if the property is calculated.

calculationFormula
string

The formula used for calculating the property's value, if applicable.

createdAt
string<date-time>

The date and time when the property was created, in ISO 8601 date-time format.

createdByUserId
string

The ID of the user who created the property.

currencyPropertyName
string

The name of the currency property associated with this property, if applicable.

dataEntryInstructions
string

Instructions for data entry related to the property, represented as a string.

dataSensitivity
enum<string>

Indicates the sensitivity level of the data, with possible values being 'NONE', 'STANDARD', or 'HIGH'.

Available options:
HIGH,
NONE,
STANDARD
dateDisplayFormat
enum<string>

The format used to display date values, with options such as 'ABSOLUTE', 'ABSOLUTE_WITH_RELATIVE', 'TIME_SINCE', or 'TIME_UNTIL'.

Available options:
ABSOLUTE,
ABSOLUTE_WITH_RELATIVE,
TIME_SINCE,
TIME_UNTIL
defaultValue
string

The default value assigned to the property, represented as a string.

description
string

A string providing a description of the property.

formField
boolean

A boolean indicating if the property is used as a form field.

groupName
string

The name of the group to which the property belongs.

hasUniqueValue
boolean

A boolean indicating if the property must have a unique value across records.

hidden
boolean

A boolean indicating if the property is hidden.

label
string

The label of the property, used for display purposes.

numberDisplayFormat
enum<string>

The format used to display number values, with options such as 'UNFORMATTED', 'FORMATTED', 'CURRENCY', 'PERCENTAGE', 'DURATION', or 'PROBABILITY'.

Available options:
CURRENCY,
DURATION,
FORMATTED,
PERCENTAGE,
PROBABILITY,
UNFORMATTED
optionColors
object[]

An array of colors associated with the property's options, used for visual representation.

options
object[]

An array of options available for the property, applicable if the property type is an enumeration.

optionsSource
enum<string>

The source of the property's options, with possible values being 'OWNER', 'PERSONA', or 'CALL_DISPOSITION'.

Available options:
CALL_DISPOSITION,
OWNER,
PERSONA
readOnlyDefinition
boolean

A boolean indicating if the property's definition is read-only.

readOnlyOptions
boolean

A boolean indicating if the property's options are read-only.

readOnlyValue
boolean

A boolean indicating if the property's value is read-only.

rollupConfig
object
sensitiveDataCategories
string[]

An array of strings representing categories of sensitive data associated with the property.

syncConfig
object
updatedAt
string<date-time>

The date and time when the property was last updated, in ISO 8601 date-time format.

updatedByUserId
string

The ID of the user who last updated the property.

validationRules
object[]

An array of validation rules applied to the property.

Last modified on November 5, 2026