Retrieve property
Retrieve detailed information about a specific property of an object type in your HubSpot account. This endpoint allows you to specify which fields of the property to include in the response, providing flexibility in the data you receive.
Supported products
Supported products
Scope requirements
Scope requirements
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Path Parameters
The unique identifier of the object type whose property is being retrieved.
The name of the property to retrieve information about.
Query Parameters
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.
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
Indicates the origin of the property, with possible values being 'HUBSPOT_DEFINED', 'INTEGRATION_DEFINED', or 'USER_DEFINED'.
HUBSPOT_DEFINED, INTEGRATION_DEFINED, USER_DEFINED 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'.
BOOLEANCHECKBOX, CALCULATION_EQUATION, CALCULATION_READ_TIME, CALCULATION_ROLLUP, CALCULATION_SCORE, CHECKBOX, DATE, EMAIL, FILE, HTML, NUMBER, PHONE_NUMBER, RADIO, SELECT, TEXT, TEXTAREA, UNKNOWN, URL The unique name of the property, represented as a string.
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'.
BOOL, CURRENCY_NUMBER, DATE, DATETIME, ENUMERATION, JSON, NUMBER, OBJECT_COORDINATES, PHONE_NUMBER, STRING, TIME_RANGE An array of access control entries defining who can view or edit the property.
A boolean indicating if the property can be archived.
A boolean indicating whether the property is archived.
A boolean indicating if the property is calculated.
The formula used for calculating the property's value, if applicable.
The date and time when the property was created, in ISO 8601 date-time format.
The ID of the user who created the property.
The name of the currency property associated with this property, if applicable.
Instructions for data entry related to the property, represented as a string.
Indicates the sensitivity level of the data, with possible values being 'NONE', 'STANDARD', or 'HIGH'.
HIGH, NONE, STANDARD The format used to display date values, with options such as 'ABSOLUTE', 'ABSOLUTE_WITH_RELATIVE', 'TIME_SINCE', or 'TIME_UNTIL'.
ABSOLUTE, ABSOLUTE_WITH_RELATIVE, TIME_SINCE, TIME_UNTIL The default value assigned to the property, represented as a string.
A string providing a description of the property.
A boolean indicating if the property is used as a form field.
The name of the group to which the property belongs.
A boolean indicating if the property must have a unique value across records.
A boolean indicating if the property is hidden.
The label of the property, used for display purposes.
The format used to display number values, with options such as 'UNFORMATTED', 'FORMATTED', 'CURRENCY', 'PERCENTAGE', 'DURATION', or 'PROBABILITY'.
CURRENCY, DURATION, FORMATTED, PERCENTAGE, PROBABILITY, UNFORMATTED An array of colors associated with the property's options, used for visual representation.
An array of options available for the property, applicable if the property type is an enumeration.
The source of the property's options, with possible values being 'OWNER', 'PERSONA', or 'CALL_DISPOSITION'.
CALL_DISPOSITION, OWNER, PERSONA A boolean indicating if the property's definition is read-only.
A boolean indicating if the property's options are read-only.
A boolean indicating if the property's value is read-only.
An array of strings representing categories of sensitive data associated with the property.
The date and time when the property was last updated, in ISO 8601 date-time format.
The ID of the user who last updated the property.
An array of validation rules applied to the property.