Alle Eigenschaften lesen

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

{
  "results": [
    {
      "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"
    }
  ],
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}

GET

crm

properties

{objectType}

Alle Eigenschaften lesen

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

{
  "results": [
    {
      "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"
    }
  ],
  "paging": {
    "next": {
      "after": "<string>",
      "link": "<string>"
    },
    "prev": {
      "before": "<string>",
      "link": "<string>"
    }
  }
}

Unterstützte Produkte

Erfordert eines der folgenden Produkte oder höher.

Marketing Hub -Kostenlos

Sales Hub -Kostenlos

Service Hub -Kostenlos

Content Hub -Starter

Erforderliche Bereiche

Authorizations

Authorization

string

header

required

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

Path Parameters

objectType

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:

highly_sensitive,

non_sensitive,

sensitive

locale

string

properties

string

Response

successful operation

results

object[]

required

Anzeigen untergeordnete attribute

results.description

string

required

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

results.fieldType

string

required

Steuert, wie die Eigenschaft in HubSpot angezeigt wird.

results.groupName

string

required

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

results.label

string

required

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

results.name

string

required

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

results.options

object[]

required

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

Anzeigen untergeordnete attribute

results.options.hidden

boolean

required

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

results.options.label

string

required

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

results.options.value

string

required

Der interne Wert der Option. Wird verwendet, wenn der Eigenschaftswert über die API festgelegt wird.

results.options.description

string

Eine Beschreibung der Option.

results.options.displayOrder

integer<int32>

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

results.type

string

required

Der Eigenschaftsdatentyp.

results.archived

boolean

Ob die Eigenschaft archiviert wurde oder nicht.

results.archivedAt

string<date-time>

Wann die Eigenschaft archiviert wurde.

results.calculated

boolean

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

results.calculationFormula

string

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

results.createdAt

string<date-time>

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

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

results.dataSensitivity

enum<string>

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

Verfügbare Optionen:

highly_sensitive,

non_sensitive,

sensitive

results.dateDisplayHint

enum<string>

Verfügbare Optionen:

absolute,

absolute_with_relative,

time_since,

time_until

results.displayOrder

integer<int32>

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

results.externalOptions

boolean

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

results.formField

boolean

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

results.hasUniqueValue

boolean

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

results.hidden

boolean

results.hubspotDefined

boolean

Gilt für die in HubSpot integrierten Standardobjekteigenschaften.

results.modificationMetadata

object

Anzeigen untergeordnete attribute

results.modificationMetadata.archivable

boolean

required

results.modificationMetadata.readOnlyDefinition

boolean

required

results.modificationMetadata.readOnlyValue

boolean

required

results.modificationMetadata.readOnlyOptions

boolean

results.referencedObjectType

string

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

results.sensitiveDataCategories

string[]

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

results.showCurrencySymbol

boolean

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

results.updatedAt

string<date-time>

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

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

paging

object

Anzeigen untergeordnete attribute

paging.next

object

Specifies the paging information needed to retrieve the next set of results in a paginated API response

Anzeigen untergeordnete attribute

paging.next.after

string

required

A paging cursor token for retrieving subsequent pages.

paging.next.link

string

A URL that can be used to retrieve the next page results.

paging.prev

object

specifies the paging information needed to retrieve the previous set of results in a paginated API response

Anzeigen untergeordnete attribute

paging.prev.before

string

required

A paging cursor token for retrieving previous pages.

paging.prev.link

string

A URL that can be used to retrieve the previous pages' results.

CRM-API | Eigenschaften

Zurück

Eigenschaft erstellen

Weiter

⌘I

Termine

Zuordnungen v3

Schema für Zuordnungen v3

Zuordnungen v4

Schema für Zuordnungen v4

Warenkörbe

Commerce-Zahlungen

Commerce-Abonnements

Unternehmen

Kontakte

Kurse

Benutzerdefinierte Objekte

Deals

Rabatte

Exporte

Gebühren

Ziele

Importe

Rechnungen

Leads

Artikel

Listen

Listings

Objekte

Bestellungen

Inhaber

Partnerkunden

Partner-Services

Pipelines

Produkte

Projekte

Eigenschaften

Eigenschaftsvalidierungen

Angebote

Services

Steuern

Tickets

Kommunikationen

Dealaufteilungen

Feedback-Einsendungen

Tracking von Limits

Objektbibliothek

Schemas

Authorizations

Path Parameters

Query Parameters

Response