Zum Hauptinhalt springen
GET
/
crm
/
v3
/
properties
/
{objectType}
/
{propertyName}
Eine Eigenschaft lesen
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"
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.
Marketing HubMarketing Hub -Kostenlos
Sales HubSales Hub -Kostenlos
Service HubService Hub -Kostenlos
Content HubContent Hub -Kostenlos

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

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 Label, das in HubSpot angezeigt wird.

​
name
string
erforderlich

Der Name der Eigenschaft, die gelesen oder geändert werden soll.

​
options
object[]
erforderlich

Eine Liste der gültigen Optionen für die Eigenschaft. Pflichtfeld bei Aufzählungseigenschaften.

​
type
string
erforderlich

Der Datentyp der Eigenschaft.

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

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

Eigenschaftsgruppen werden in dieser Reihenfolge angezeigt: Das erste angezeigte Objekt hat den niedrigsten positiven Ganzzahlwert. Bei einem Wert von -1 wird die Eigenschaftsgruppe nach allen positiven Werten angezeigt.

​
externalOptions
boolean

Gilt nur für Eigenschaften vom Typ „Aufzählung“. Muss in Verbindung mit einem „referencedObjectType“ von „OWNER“ auf „true“ (wahr) festgelegt werden. Ist andernfalls „false“ (falsch).

​
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

„true“ (wahr) verweist darauf, dass die Eigenschaft nicht sichtbar ist und nicht in HubSpot verwendet werden kann.

Beispiel:

false

​
hubspotDefined
boolean

Gilt für die in HubSpot integrierten Standardobjekteigenschaften.

​
modificationMetadata
object
​
referencedObjectType
string

Muss auf „OWNER“ festgelegt sein, wenn „externalOptions“ wahr ist, was dazu führt, dass die Eigenschaft dynamisch Optionswerte von den aktuellen HubSpot-Benutzern bezieht.

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

Last modified on March 24, 2026