Zum Hauptinhalt springen
GET
/
crm-object-schemas
/
2026-03
/
schemas
/
{objectType}
Rufen Sie Schema eines bestimmten benutzerdefinierten Objekts ab.
curl --request GET \
  --url https://api.hubapi.com/crm-object-schemas/2026-03/schemas/{objectType} \
  --header 'Authorization: Bearer <token>'
{
  "allowsSensitiveProperties": true,
  "archived": true,
  "associations": [
    {
      "fromObjectTypeId": "<string>",
      "id": "<string>",
      "toObjectTypeId": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "name": "<string>",
      "updatedAt": "2023-11-07T05:31:56Z"
    }
  ],
  "fullyQualifiedName": "<string>",
  "id": "<string>",
  "labels": {
    "plural": "<string>",
    "singular": "<string>"
  },
  "name": "<string>",
  "objectTypeId": "<string>",
  "properties": [
    {
      "description": "<string>",
      "fieldType": "<string>",
      "groupName": "<string>",
      "label": "<string>",
      "name": "<string>",
      "options": [
        {
          "hidden": true,
          "label": "<string>",
          "value": "<string>",
          "description": "<string>",
          "displayOrder": 123
        }
      ],
      "type": "<string>",
      "archived": true,
      "archivedAt": "2023-11-07T05:31:56Z",
      "calculated": true,
      "calculationFormula": "<string>",
      "createdAt": "2023-11-07T05:31:56Z",
      "createdUserId": "<string>",
      "currencyPropertyName": "<string>",
      "displayOrder": 123,
      "externalOptions": true,
      "formField": true,
      "hasUniqueValue": true,
      "hidden": false,
      "hubspotDefined": true,
      "modificationMetadata": {
        "archivable": true,
        "readOnlyDefinition": true,
        "readOnlyValue": true,
        "readOnlyOptions": true
      },
      "referencedObjectType": "<string>",
      "sensitiveDataCategories": [
        "<string>"
      ],
      "showCurrencySymbol": true,
      "updatedAt": "2023-11-07T05:31:56Z",
      "updatedUserId": "<string>"
    }
  ],
  "requiredProperties": [
    "<string>"
  ],
  "searchableProperties": [
    "<string>"
  ],
  "secondaryDisplayProperties": [
    "<string>"
  ],
  "createdAt": "2023-11-07T05:31:56Z",
  "createdByUserId": 123,
  "description": "<string>",
  "primaryDisplayProperty": "<string>",
  "updatedAt": "2023-11-07T05:31:56Z",
  "updatedByUserId": 123
}

Documentation Index

Fetch the complete documentation index at: https://developers.hubspot.de/docs/llms.txt

Use this file to discover all available pages before exploring further.

Supported products

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
includeAuditMetadata
boolean
Standard:true
includePropertyDefinitions
boolean
Standard:true

Antwort

successful operation

allowsSensitiveProperties
boolean
erforderlich
archived
boolean
erforderlich
associations
object[]
erforderlich

Für einen angegebenen Objekttyp definierte Zuordnungen.

fullyQualifiedName
string
erforderlich

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

id
string
erforderlich

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

labels
object
erforderlich
name
string
erforderlich

Ein eindeutiger Name für den Objekttyp des Schemas.

objectTypeId
string
erforderlich
properties
object[]
erforderlich

Für diesen Objekttyp definierte Eigenschaften.

requiredProperties
string[]
erforderlich

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

searchableProperties
string[]
erforderlich

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

secondaryDisplayProperties
string[]
erforderlich

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

createdAt
string<date-time>

Wann das Objektschema erstellt wurde.

createdByUserId
integer<int32>
description
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.

updatedAt
string<date-time>

Wann das Objektschema zuletzt aktualisiert wurde.

updatedByUserId
integer<int32>
Last modified on April 13, 2026