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"
}Rufen Sie Details eines benutzerdefinierten Objektschemas, einschließlich seiner Eigenschaften und Zuordnungen, mithilfe der Objekttyp-ID oder des vollständig qualifizierten Namens 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
Erforderliche Bereiche
The access token received from the authorization server in the OAuth 2.0 flow.
Vollständig qualifizierter Name oder Objekttyp-ID Ihres Schemas.
Schließen Sie Definitionen der mit dem Schema verknüpften Zuordnungen ein.
Schließen Sie Metadaten zum Audit-Trail des Schemas ein.
Schließen Sie Definitionen der dem Schema zugeordneten Eigenschaften ein.
successful operation
Defines an object schema, including its properties and associations.
Für einen angegebenen Objekttyp definierte Zuordnungen.
Show child attributes
Eine eindeutige ID für diesen Objekttyp. Wird definiert als {meta-type}-{unique ID}.
Singular and plural labels for the object. Used in CRM display.
Show child attributes
{
"plural": "My objects",
"singular": "My object"
}Ein eindeutiger Name für dieses Objekt. Nur zur internen Verwendung.
Für diesen Objekttyp definierte Eigenschaften.
Show child attributes
Die Namen der erforderlichen Eigenschaften beim Erstellen eines Objekts dieses Typs.
Wann der Objekttyp erstellt wurde.
Eine zugewiesene eindeutige ID für das Objekt, einschließlich Portal-ID und Objektname.
Der Name der primären Eigenschaft für dieses Objekt. Diese wird auf der HubSpot-Datensatzseite für diesen Objekttyp als primär angezeigt.
Namen von Eigenschaften, die für diesen Objekttyp in HubSpots Produktsuche indexiert werden.
Die Namen der sekundären Eigenschaften für dieses Objekt. Diese werden auf der HubSpot-Datensatzseite für diesen Objekttyp als sekundär angezeigt.
Wann der Objekttyp zuletzt aktualisiert wurde.