Zum Hauptinhalt springen
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 HubGratuit
Sales HubSales HubGratuit
Service HubService HubGratuit
Content HubContent HubStarter

​
Portées requises

Cette API requiert l’une des portées suivantes :
  • crm.objects.orders.read
  • crm.objects.appointments.sensitive.read.v2
  • crm.schemas.listings.read
  • crm.objects.contacts.highly_sensitive.read.v2
  • crm.schemas.carts.read
  • automation
  • crm.objects.companies.write
  • crm.objects.custom.sensitive.read.v2
  • crm.objects.users.read
  • crm.objects.commercepayments.write
  • crm.objects.invoices.write
  • crm.objects.contacts.highly_sensitive.write.v2
  • crm.objects.appointments.write
  • crm.objects.custom.write
  • tickets
  • crm.objects.deals.sensitive.write.v2
  • crm.schemas.appointments.read
  • crm.objects.deals.highly_sensitive.write.v2
  • crm.objects.companies.highly_sensitive.write.v2
  • tickets.sensitive.v2
  • crm.objects.appointments.read
  • crm.schemas.courses.read
  • crm.objects.appointments.sensitive.write.v2
  • crm.schemas.custom.read
  • crm.objects.marketing_events.write
  • media_bridge.read
  • crm.schemas.commercepayments.read
  • crm.objects.listings.read
  • crm.objects.courses.write
  • crm.objects.carts.read
  • crm.objects.listings.write
  • crm.objects.custom.read
  • crm.objects.deals.read
  • crm.objects.subscriptions.read
  • crm.objects.owners.read
  • crm.objects.companies.sensitive.read.v2
  • crm.schemas.quotes.read
  • crm.objects.companies.read
  • crm.objects.custom.sensitive.write.v2
  • crm.schemas.services.read
  • crm.objects.deals.highly_sensitive.read.v2
  • crm.objects.contacts.sensitive.write.v2
  • crm.objects.companies.highly_sensitive.read.v2
  • crm.schemas.subscriptions.read
  • crm.schemas.companies.read
  • crm.schemas.line_items.read
  • crm.objects.contacts.read
  • crm.objects.services.write
  • crm.objects.subscriptions.write
  • crm.objects.products.write
  • crm.objects.feedback_submissions.read
  • crm.objects.custom.highly_sensitive.read.v2
  • crm.objects.deals.write
  • crm.objects.invoices.read
  • e-commerce
  • crm.schemas.deals.read
  • crm.schemas.orders.read
  • crm.schemas.contacts.read
  • tickets.highly_sensitive.v2
  • crm.objects.quotes.write
  • crm.objects.leads.read
  • crm.objects.leads.write
  • crm.objects.custom.highly_sensitive.write.v2
  • crm.objects.deals.sensitive.read.v2
  • crm.objects.goals.write
  • crm.objects.companies.sensitive.write.v2
  • crm.objects.contacts.write
  • crm.objects.goals.read
  • crm.objects.line_items.read
  • crm.objects.contacts.sensitive.read.v2
  • crm.objects.line_items.write
  • crm.objects.courses.read
  • timeline
  • crm.pipelines.orders.read
  • crm.schemas.invoices.read
  • crm.objects.quotes.read
  • crm.objects.services.read
  • crm.objects.marketing_events.read

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
objectType
string
required
​
propertyName
string
required

Query Parameters

​
archived
boolean
default:false

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

​
properties
string

Response

successful operation

A HubSpot property

​
description
string
required

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

​
type
string
required

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

Example:

"enumeration"

​
options
object[]
required

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.

Example:

"[{\"label\":\"Option A\",\"value\":\"A\",\"hidden\":false,\"description\":\"Choice number one\",\"displayOrder\":1},{\"label\":\"Option B\",\"value\":\"B\",\"hidden\":false,\"description\":\"Choice number two\",\"displayOrder\":2}]"

​
label
string
required

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

Example:

"My Contact Property"

​
groupName
string
required

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

Example:

"contactinformation"

​
name
string
required

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.

Example:

"my_contact_property"

​
fieldType
string
required

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

Example:

"select"

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

​
displayOrder
integer

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

Example:

2

​
showCurrencySymbol
boolean

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

​
hubspotDefined
boolean

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

​
createdAt
string<date-time>

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

​
archived
boolean

Si la propriété est archivée 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.

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

​
externalOptions
boolean

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

​
dateDisplayHint
enum<string>
Available options:
absolute,
absolute_with_relative,
time_since,
time_until
​
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.

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

​
modificationMetadata
object
​
sensitiveDataCategories
string[]

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

​
formField
boolean

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

​
dataSensitivity
enum<string>

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

Available options:
non_sensitive,
sensitive,
highly_sensitive
​
archivedAt
string<date-time>

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

​
referencedObjectType
string

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

​
calculationFormula
string

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

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

⌘I