Saltar al contenido principal
GET
/
crm
/
v3
/
properties
/
{objectType}
/
{propertyName}
Leer una propiedad
curl --request GET \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>'
{
  "displayOrder": 2,
  "fieldType": "select",
  "formField": true,
  "groupName": "contactinformation",
  "hasUniqueValue": false,
  "hidden": false,
  "label": "My Contact Property",
  "modificationMetadata": {
    "archivable": true,
    "readOnlyDefinition": false,
    "readOnlyOptions": false,
    "readOnlyValue": false
  },
  "name": "my_contact_property",
  "options": [
    {
      "description": "Choice number one",
      "displayOrder": 1,
      "hidden": false,
      "label": "Option A",
      "value": "A"
    },
    {
      "description": "Choice number two",
      "displayOrder": 2,
      "hidden": false,
      "label": "Option B",
      "value": "B"
    }
  ],
  "type": "enumeration"
}

Productos compatibles

Se requiere uno de los siguientes productos o productos de ediciones superiores.
Marketing HubMarketing Hub -Gratuito
Sales HubSales Hub -Gratuito
Service HubService Hub -Gratuito
Content HubContent Hub -Gratuito

Autorizaciones

​
Authorization
string
header
requerido

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

Parámetros de ruta

​
objectType
string
requerido
​
propertyName
string
requerido

Parámetros de consulta

​
archived
boolean
predeterminado:false

Si se quieren devolver solo los resultados que se han archivado.

​
dataSensitivity
enum<string>
predeterminado:non_sensitive
Opciones disponibles:
highly_sensitive,
non_sensitive,
sensitive
​
locale
string
​
properties
string

Respuesta

successful operation

A HubSpot property

​
description
string
requerido

Una descripción de la propiedad que se mostrará como texto de ayuda en HubSpot.

​
fieldType
string
requerido

Controla cómo aparece la propiedad en HubSpot.

​
groupName
string
requerido

El nombre del grupo de propiedades al que pertenece la propiedad.

​
label
string
requerido

Una etiqueta de propiedad legible para humanos que se mostrará en HubSpot.

​
name
string
requerido

El nombre interno de la propiedad, que debe usarse al referenciar la propiedad a través de la API.

​
options
object[]
requerido

Una lista de opciones válidas para la propiedad. Este campo es obligatorio para las propiedades enumeradas, pero estará vacío para otros tipos de propiedad.

​
type
string
requerido

El tipo de datos de la propiedad.

​
archived
boolean

Si la propiedad se archiva o no.

​
archivedAt
string<date-time>

Cuando se archivó la propiedad.

​
calculated
boolean

Para las propiedades predeterminadas, true indica que la propiedad es calculada por un proceso de HubSpot. No tiene ningún efecto para las propiedades personalizadas.

​
calculationFormula
string

Representa una fórmula que se utiliza para calcular una propiedad calculada.

​
createdAt
string<date-time>

La marca de tiempo en la que se creó la propiedad, en formato ISO 8601.

​
createdUserId
string

El ID interno del usuario que creó la propiedad en HubSpot. Este campo puede no existir si la propiedad se creó fuera de HubSpot.

​
dataSensitivity
enum<string>

Indicates the sensitivity level of the property, such as "non_sensitive", "sensitive", or "highly_sensitive".

Opciones disponibles:
highly_sensitive,
non_sensitive,
sensitive
​
dateDisplayHint
enum<string>
Opciones disponibles:
absolute,
absolute_with_relative,
time_since,
time_until
​
displayOrder
integer<int32>

Las propiedades se muestran en orden, comenzando con el valor entero positivo más bajo.

​
externalOptions
boolean

Para las propiedades predeterminadas, true (verdadero) indica que las opciones se almacenan fuera de la configuración de la propiedad.

​
formField
boolean

Si la propiedad se puede usar en un formulario de HubSpot o no.

​
hasUniqueValue
boolean

Si el valor de la propiedad debe ser único o no. Una vez establecido, esto no se puede cambiar.

​
hidden
boolean

Si es verdadero, la opción no se mostrará en formularios, bots o páginas de programación de reuniones. Compatible con las propiedades de enumeración de contactos, empresas, tickets y objetos personalizados.

​
hubspotDefined
boolean

Esto será verdadero para las propiedades de objeto predeterminadas integradas en HubSpot.

​
modificationMetadata
object
​
referencedObjectType
string

Si esta propiedad está relacionada con otros objetos, esos objetos se mostrarán aquí.

​
sensitiveDataCategories
string[]

When sensitiveData is true, lists the type of sensitive data contained in the property (e.g., "HIPAA").

​
showCurrencySymbol
boolean

Si la propiedad mostrará o no el símbolo de divisa en la configuración de la cuenta.

​
updatedAt
string<date-time>

La marca de tiempo en la que se actualizó la propiedad, en formato ISO 8601.

​
updatedUserId
string

El ID interno del usuario que creó la propiedad en HubSpot. Este campo puede no existir si la propiedad se actualizó fuera de HubSpot.

Last modified on January 26, 2026