Zum Hauptinhalt springen
GET
/
crm-object-schemas
/
v3
/
schemas
/
{objectType}
Rufen Sie Schema eines bestimmten benutzerdefinierten Objekts ab.
curl --request GET \
  --url https://api.hubapi.com/crm-object-schemas/v3/schemas/{objectType} \
  --header 'Authorization: Bearer <token>'
{
  "associations": [
    {
      "fromObjectTypeId": "2-123456",
      "id": "123",
      "name": "my_object_to_contact",
      "toObjectTypeId": "0-1"
    }
  ],
  "createdAt": "2020-02-20T18:07:11.390Z",
  "fullyQualifiedName": "p7878787_my_object\"",
  "id": "123456",
  "labels": {
    "plural": "My objects",
    "singular": "My object"
  },
  "metaType": "PORTAL_SPECIFIC",
  "name": "my_object",
  "primaryDisplayProperty": "my_object_property",
  "properties": [
    {
      "archived": false,
      "calculated": false,
      "createdAt": "2020-02-20T18:07:11.802Z",
      "displayOrder": -1,
      "externalOptions": false,
      "fieldType": "text",
      "groupName": "my_object_information",
      "hasUniqueValue": false,
      "label": "My object property",
      "name": "my_object_property",
      "type": "string",
      "updatedAt": "2020-02-20T18:07:11.802Z"
    }
  ],
  "requiredProperties": [
    "my_object_property"
  ],
  "searchableProperties": [
    "my_object_property"
  ],
  "updatedAt": "2020-02-20T18:09:07.555Z"
}

Unterstützte Produkte

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

Autorisierungen

Authorization
string
header
erforderlich

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

Pfadparameter

objectType
string
erforderlich

Vollständig qualifizierter Name oder Objekttyp-ID Ihres Schemas.

Abfrageparameter

includeAssociationDefinitions
boolean
Standard:true

Schließen Sie Definitionen der mit dem Schema verknüpften Zuordnungen ein.

includeAuditMetadata
boolean
Standard:true

Schließen Sie Metadaten zum Audit-Trail des Schemas ein.

includePropertyDefinitions
boolean
Standard:true

Schließen Sie Definitionen der dem Schema zugeordneten Eigenschaften ein.

Antwort

successful operation

Defines an object schema, including its properties and associations.

associations
object[]
erforderlich

Für einen angegebenen Objekttyp definierte Zuordnungen.

id
string
erforderlich

Eine eindeutige ID für diesen Objekttyp. Wird definiert als {meta-type}-{unique ID}.

labels
object
erforderlich

Singular and plural labels for the object. Used in CRM display.

Beispiel:
{
"plural": "My objects",
"singular": "My object"
}
name
string
erforderlich

Ein eindeutiger Name für dieses Objekt. Nur zur internen Verwendung.

properties
object[]
erforderlich

Für diesen Objekttyp definierte Eigenschaften.

requiredProperties
string[]
erforderlich

Die Namen der erforderlichen Eigenschaften beim Erstellen eines Objekts dieses Typs.

allowsSensitiveProperties
boolean
archived
boolean
createdAt
string<date-time>

Wann der Objekttyp erstellt wurde.

createdByUserId
integer<int32>
description
string
fullyQualifiedName
string

Eine zugewiesene eindeutige ID für das Objekt, einschließlich Portal-ID und Objektname.

objectTypeId
string
primaryDisplayProperty
string

Der Name der primären Eigenschaft für dieses Objekt. Diese wird auf der HubSpot-Datensatzseite für diesen Objekttyp als primär angezeigt.

searchableProperties
string[]

Namen von Eigenschaften, die für diesen Objekttyp in HubSpots Produktsuche indexiert werden.

secondaryDisplayProperties
string[]

Die Namen der sekundären Eigenschaften für dieses Objekt. Diese werden auf der HubSpot-Datensatzseite für diesen Objekttyp als sekundär angezeigt.

updatedAt
string<date-time>

Wann der Objekttyp zuletzt aktualisiert wurde.

updatedByUserId
integer<int32>
Last modified on March 24, 2026