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

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
Diese API erfordert einen der folgenden Bereiche:
crm.objects.custom.highly_sensitive.read.v2
crm.objects.custom.read
crm.objects.custom.sensitive.read.v2
crm.schemas.custom.read

Authorizations

Authorization
string
header
required

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

Path Parameters

objectType
string
required

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

Response

successful operation

Defines an object schema, including its properties and associations.

associations
object[]
required

Für einen angegebenen Objekttyp definierte Zuordnungen.

labels
object
required

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

Example:
{
"singular": "My object",
"plural": "My objects"
}
requiredProperties
string[]
required

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

name
string
required

Ein eindeutiger Name für den Objekttyp des Schemas.

id
string
required

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

properties
object[]
required

Für diesen Objekttyp definierte Eigenschaften.

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.

createdByUserId
integer
objectTypeId
string
description
string
updatedByUserId
integer
fullyQualifiedName
string

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

archived
boolean
createdAt
string<date-time>

Wann das Objektschema erstellt wurde.

searchableProperties
string[]

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

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.