Read a property

Lesen Sie eine Eigenschaft, identifiziert durch „“.

GET /crm/v3/properties/{objectType}/{propertyName}

Eine Eigenschaft lesen

cURL

curl --request GET \
  --url https://api.hubapi.com/crm/v3/properties/{objectType}/{propertyName} \
  --header 'Authorization: Bearer <token>'

200

{
  "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"
}

Supported products

Required Scopes

Autorisierungen

Authorization · string · header · erforderlich

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

Pfadparameter

objectType · string · erforderlich

Der Objekttyp, zu dem die Eigenschaft gehört.

propertyName · string · erforderlich

Der Name der abzurufenden Eigenschaft.

Abfrageparameter

archived · boolean · Standard: false

Ob nur Ergebnisse zurückgegeben werden sollen, die archiviert wurden.

dataSensitivity · enum<string> · Standard: non_sensitive

Gibt die Vertraulichkeitsstufe der Daten an, mit folgenden Optionen: highly_sensitive, non_sensitive, sensitive.

Verfügbare Optionen: highly_sensitive, non_sensitive, sensitive

locale · string

Ein Abfrageparameter zur Angabe des Gebietsschemas für die Antwort.

properties · string

Ein Abfrageparameter, um anzugeben, welche Eigenschaften in die Antwort aufgenommen werden sollen.

Antwort

200

application/json

successful operation

HubSpot-Eigenschaft

description · string · erforderlich

Eine Beschreibung der Eigenschaft, die in HubSpot als Hilfetext angezeigt wird.

fieldType · string · erforderlich

Steuert, wie die Eigenschaft in HubSpot angezeigt wird.

groupName · string · erforderlich

Der Name der Eigenschaftsgruppe, zu dem diese Eigenschaft gehört.

label · string · erforderlich

Für Menschen lesbares Eigenschaftslabel, das in HubSpot angezeigt wird.

name · string · erforderlich

Der interne Name der Eigenschaft. Wird verwendet, wenn die Eigenschaft über die API referenziert wird.

options · object[] · erforderlich

Eine Liste der gültigen Optionen für die Eigenschaft. Pflichtfeld bei Aufzählungseigenschaften, bei anderen Eigenschaftstypen ist es leer.

Show child attributes

type · string · erforderlich

Der Eigenschaftsdatentyp.

archived · boolean

Ob die Eigenschaft archiviert wurde oder nicht.

archivedAt · string<date-time>

Wann die Eigenschaft archiviert ist.

calculated · boolean

Bei Standardeigenschaften verweist „true“ (wahr) darauf, dass die Eigenschaft von einem HubSpot-Prozess berechnet wird. Keine Auswirkung für benutzerdefinierte Eigenschaften.

calculationFormula · string

Stellt eine Formel dar, die zur Berechnung einer berechneten Eigenschaft verwendet wird.

createdAt · string<date-time>

Der Zeitstempel, wann die Eigenschaft erstellt wurde (Format ISO 8601).

createdUserId · string

Die interne ID des Benutzers, der die Eigenschaft in HubSpot erstellt hat. Dieses Feld wird ggf. nicht angezeigt, wenn die Eigenschaft außerhalb von HubSpot erstellt wurde.

currencyPropertyName · string

Der Name er zugehörigen Währungseigenschaft.

dataSensitivity · enum<string>

Gibt die Vertraulichkeitsstufe der Eigenschaft an, z. B. „non_sensitive“, „sensitive“ oder „highly_sensitive“.

Verfügbare Optionen: highly_sensitive, non_sensitive, sensitive

dateDisplayHint · enum<string>

Gibt an, wie Datumswerte angezeigt werden sollen, mit Optionen wie „absolut“, „absolute_with_relativ“, „time_since“ oder „time_until“.

Verfügbare Optionen: absolute, absolute_with_relative, time_since, time_until

displayOrder · integer<int32>

Eigenschaften werden in dieser Reihenfolge angezeigt: Das erste angezeigte Objekt hat den niedrigsten positiven Ganzzahlwert.

externalOptions · boolean

Bei Standardeigenschaften verweist „true“ (wahr) darauf, dass die Optionen außerhalb der Eigenschaftseinstellungen gespeichert werden.

formField · boolean

Ob die Eigenschaft in einem HubSpot-Formular verwendet werden kann oder nicht.

hasUniqueValue · boolean

Ob der Wert der Eigenschaft eindeutig sein muss oder nicht. Einmal festgelegt, kann dies nicht mehr geändert werden.

hidden · boolean

Ob die Eigenschaft aus der HubSpot-UI ausgeblendet wird oder nicht. Empfohlen wird, diese Option bei benutzerdefinierten Eigenschaften auf „false“ (falsch) zu setzen.

Beispiel:

false

hubspotDefined · boolean

Gilt für die in HubSpot integrierten Standardobjekteigenschaften.

modificationMetadata · object

Show child attributes

numberDisplayHint · enum<string>

Hinweis, wie eine Zahleneigenschaft in der HubSpot-UI angezeigt und validiert wird. Kann „unformatted“, „formatted“, „currency“, „percentage“, „duration“ oder „probability“ sein.

Verfügbare Optionen: currency, duration, formatted, percentage, probability, unformatted

referencedObjectType · string

Wenn sich diese Eigenschaft auf andere Objekte bezieht, werden diese hier aufgeführt.

sensitiveDataCategories · string[]

Führt den in der Eigenschaft enthaltenen Typ vertraulicher Daten (z. B. „HIPAA“) auf, wenn „sensitiveData“ auf „true“ (wahr) festgelegt ist.

showCurrencySymbol · boolean

Ob die Eigenschaft das in den Account-Einstellungen festgelegte Währungssymbol anzeigt oder nicht.

updatedAt · string<date-time>

Der Zeitstempel, wann die Eigenschaft zuletzt aktualisiert wurde (Format ISO 8601).

updatedUserId · string

Die interne ID des Benutzers, der die Eigenschaft in HubSpot aktualisiert hat. Dieses Feld wird ggf. nicht angezeigt, wenn die Eigenschaft außerhalb von HubSpot aktualisiert wurde.