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 'private-app: <api-key>'
{
  "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 -Starter
Diese API erfordert einen der folgenden Bereiche:
automation
crm.objects.appointments.read
crm.objects.appointments.sensitive.read.v2
crm.objects.appointments.sensitive.write.v2
crm.objects.appointments.write
crm.objects.carts.read
crm.objects.commercepayments.write
crm.objects.companies.highly_sensitive.read.v2
crm.objects.companies.highly_sensitive.write.v2
crm.objects.companies.read
crm.objects.companies.sensitive.read.v2
crm.objects.companies.sensitive.write.v2
crm.objects.companies.write
crm.objects.contacts.highly_sensitive.read.v2
crm.objects.contacts.highly_sensitive.write.v2
crm.objects.contacts.read
crm.objects.contacts.sensitive.read.v2
crm.objects.contacts.sensitive.write.v2
crm.objects.contacts.write
crm.objects.courses.read
crm.objects.courses.write
crm.objects.custom.highly_sensitive.read.v2
crm.objects.custom.highly_sensitive.write.v2
crm.objects.custom.read
crm.objects.custom.sensitive.read.v2
crm.objects.custom.sensitive.write.v2
crm.objects.custom.write
crm.objects.deals.highly_sensitive.read.v2
crm.objects.deals.highly_sensitive.write.v2
crm.objects.deals.read
crm.objects.deals.sensitive.read.v2
crm.objects.deals.sensitive.write.v2
crm.objects.deals.write
crm.objects.feedback_submissions.read
crm.objects.goals.read
crm.objects.goals.write
crm.objects.invoices.read
crm.objects.invoices.write
crm.objects.leads.read
crm.objects.leads.write
crm.objects.line_items.read
crm.objects.line_items.write
crm.objects.listings.read
crm.objects.listings.write
crm.objects.marketing_events.read
crm.objects.marketing_events.write
crm.objects.orders.read
crm.objects.owners.read
crm.objects.products.write
crm.objects.quotes.read
crm.objects.quotes.write
crm.objects.services.read
crm.objects.services.write
crm.objects.subscriptions.read
crm.objects.subscriptions.write
crm.objects.users.read
crm.pipelines.orders.read
crm.schemas.appointments.read
crm.schemas.carts.read
crm.schemas.commercepayments.read
crm.schemas.companies.read
crm.schemas.contacts.read
crm.schemas.courses.read
crm.schemas.custom.read
crm.schemas.deals.read
crm.schemas.invoices.read
crm.schemas.line_items.read
crm.schemas.listings.read
crm.schemas.orders.read
crm.schemas.quotes.read
crm.schemas.services.read
crm.schemas.subscriptions.read
e-commerce
media_bridge.read
tickets
tickets.highly_sensitive.v2
tickets.sensitive.v2
timeline

Authorizations

​
private-app
string
header
required

Path Parameters

​
objectType
string
required
​
propertyName
string
required

Query Parameters

​
archived
boolean
default:false

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

​
dataSensitivity
enum<string>
default:non_sensitive
Verfügbare Optionen:
non_sensitive,
sensitive,
highly_sensitive
​
locale
string
​
properties
string

Response

successful operation

A HubSpot property

​
description
string
required

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

​
type
string
required

Der Eigenschaftsdatentyp.

​
options
object[]
required

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

​
label
string
required

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

​
groupName
string
required

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

​
name
string
required

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

​
fieldType
string
required

Steuert, wie die Eigenschaft in HubSpot angezeigt wird.

​
hidden
boolean

„true“ (wahr) verweist darauf, dass die Option nicht in Formularen, in Bots oder auf Terminplanungsseiten für Meetings angezeigt wird. Unterstützt für Kontakt-, Unternehmens-, Ticket- und benutzerdefinierte Objekt-Aufzählungseigenschaften.

​
displayOrder
integer

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

​
showCurrencySymbol
boolean

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

​
hubspotDefined
boolean

Gilt für die in HubSpot integrierten Standardobjekteigenschaften.

​
createdAt
string<date-time>

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

​
archived
boolean

Ob die Eigenschaft archiviert wurde oder nicht.

​
hasUniqueValue
boolean

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

​
calculated
boolean

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

​
externalOptions
boolean

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

​
dateDisplayHint
enum<string>
Verfügbare Optionen:
absolute,
absolute_with_relative,
time_since,
time_until
​
updatedAt
string<date-time>

Der Zeitstempel, wann die Eigenschaft zuletzt aktualisiert 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.

​
modificationMetadata
object
​
sensitiveDataCategories
string[]

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

​
formField
boolean

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

​
dataSensitivity
enum<string>

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

Verfügbare Optionen:
non_sensitive,
sensitive,
highly_sensitive
​
archivedAt
string<date-time>

Wann die Eigenschaft archiviert wurde.

​
referencedObjectType
string

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

​
calculationFormula
string

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

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