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

Le type d'objet auquel la propriété appartient.

​
propertyName
string
requis

Le nom de la propriété à récupérer.

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

Spécifie le niveau de sensibilité des données, avec les options suivantes : highly_sensitive, non_sensitive, sensitive.

Options disponibles:
highly_sensitive,
non_sensitive,
sensitive
​
locale
string

Un paramètre de requête pour spécifier les paramètres régionaux de la réponse.

​
properties
string

Un paramètre de requête pour spécifier les propriétés à inclure dans la réponse.

Réponse

successful operation

Propriété HubSpot

​
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é qui sera affiché dans HubSpot lisible par les personnes.

​
name
string
requis

Le nom de la propriété à lire ou à modifier.

​
options
object[]
requis

Une liste d'options valides pour la propriété. Ce champ est requis pour les propriétés énumérées.

​
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>

Indique le niveau de sensibilité de la propriété, par exemple « non_sensitive », « sensitive » ou « highly_sensitive ».

Options disponibles:
highly_sensitive,
non_sensitive,
sensitive
​
dateDisplayHint
enum<string>

Indique comment les valeurs de date doivent être affichées, avec des options telles que « absolute », « absolute_with_relative », « time_since » ou « time_until ».

Options disponibles:
absolute,
absolute_with_relative,
time_since,
time_until
​
displayOrder
integer<int32>

Les groupes de propriétés sont affichés dans l'ordre croissant en partant de la valeur entière positive la plus basse. Une valeur -1 fera apparaître le groupe de propriétés après toute valeur positive.

​
externalOptions
boolean

Applicable uniquement aux propriétés de type « énumération ». Doit être définie sur « true » en conjonction avec un « referencedObjectType » de « OWNER ». Sinon, définir sur « false ».

​
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, la propriété ne sera pas visible et ne pourra pas être utilisée dans HubSpot.

Exemple:

false

​
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

Cela doit être défini sur « OWNER » lorsque la valeur de « externalOptions » est « vrai », et entraîne l'extraction dynamique des valeurs des options des utilisateurs actuels de HubSpot par la propriété.

​
sensitiveDataCategories
string[]

Lorsque sensitiveData est vrai, liste le type de données sensibles contenues dans la propriété (par exemple, « 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 March 5, 2026