Passer au contenu principal
GET
/
crm
/
v3
/
properties
/
{objectType}
/
{propertyName}
Lire une propriété
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"
}

Produits pris en charge

Exige l'un des produits suivants ou un produit supérieur.
Marketing HubMarketing Hub -Gratuit
Sales HubSales Hub -Gratuit
Service HubService Hub -Gratuit
Content HubContent Hub -Gratuit

Autorisations

​
Authorization
string
header
requis

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

Paramètres de chemin

​
objectType
string
requis
​
propertyName
string
requis

Paramètres de requête

​
archived
boolean
défaut:false

S'il faut renvoyer uniquement les résultats qui ont été archivés.

​
dataSensitivity
enum<string>
défaut:non_sensitive
Options disponibles:
highly_sensitive,
non_sensitive,
sensitive
​
locale
string
​
properties
string

Réponse

successful operation

A HubSpot property

​
description
string
requis

Une description de la propriété qui sera affichée comme texte d'aide dans HubSpot.

​
fieldType
string
requis

Contrôle la façon dont la propriété apparaît dans HubSpot.

​
groupName
string
requis

Le nom du groupe de propriétés auquel appartient la propriété.

​
label
string
requis

Un libellé de propriété qui sera affichée dans HubSpot lisible par les personnes.

​
name
string
requis

Le nom interne de la propriété, qui doit être utilisé lorsque la propriété est référencée par le biais de l'API.

​
options
object[]
requis

Une liste d'options valides pour la propriété. Ce champ est requis pour les propriétés énumérées, mais sera vide pour les autres types de propriétés.

​
type
string
requis

Le type de données de la propriété.

​
archived
boolean

Si la propriété est archivée ou non.

​
archivedAt
string<date-time>

Moment où la propriété a été archivée

​
calculated
boolean

Pour les propriétés par défaut, vrai indique que la propriété est calculée par un processus HubSpot. Cela n'a aucun effet pour les propriétés personnalisées.

​
calculationFormula
string

Cela représente une formule utilisée pour calculer une propriété calculée.

​
createdAt
string<date-time>

Date à laquelle la propriété a été créée, au format ISO 8601.

​
createdUserId
string

L'ID utilisateur interne de l'utilisateur qui a créé la propriété dans HubSpot. Ce champ peut ne pas exister si la propriété a été créée en dehors de HubSpot.

​
dataSensitivity
enum<string>

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

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

Les propriétés sont affichées dans l'ordre croissant en partant de la valeur entière positive la plus basse.

​
externalOptions
boolean

Par défaut, vrai indique que les options sont stockées en dehors des paramètres de propriété.

​
formField
boolean

Si la propriété peut être utilisée dans un formulaire HubSpot ou non.

​
hasUniqueValue
boolean

Si la valeur de la propriété doit être unique ou non. Une fois définie, il n'est pas possible de le modifier.

​
hidden
boolean

Si vrai, l'option ne sera pas affichée dans des formulaires, des bots ou des pages de planification de réunions. Pris en charge pour les propriétés d'énumération de contacts, d'entreprises, de tickets et d'objets personnalisés.

​
hubspotDefined
boolean

Cette valeur sera « vrai » pour les propriétés d'objet par défaut intégrées dans HubSpot.

​
modificationMetadata
object
​
referencedObjectType
string

Si cette propriété est liée à un ou plusieurs autres objets, ils seront répertoriés ici.

​
sensitiveDataCategories
string[]

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

​
showCurrencySymbol
boolean

Si la propriété affiche ou non le symbole de la devise défini dans les paramètres du compte.

​
updatedAt
string<date-time>

L'horodatage du moment où la propriété a été mise à jour pour la dernière fois, au format ISO 8601.

​
updatedUserId
string

L'ID utilisateur interne de l'utilisateur qui a mis à jour la propriété dans HubSpot. Ce champ peut ne pas exister si la propriété a été mise à jour en dehors de HubSpot.

Last modified on January 26, 2026