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"
}Recupere os detalhes de um esquema de objeto personalizado, incluindo propriedades e associações, usando o ID do tipo de objeto ou o nome totalmente qualificado.
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"
}Supported products
Required Scopes
The access token received from the authorization server in the OAuth 2.0 flow.
Nome completo ou ID do tipo de objeto do seu esquema.
Inclua as definições das associações relacionadas ao esquema.
Inclua metadados sobre o registro de auditoria do esquema.
Inclua as definições das propriedades associadas ao esquema.
successful operation
Defines an object schema, including its properties and associations.
Associações definidas para um determinado tipo de objeto.
Show child attributes
Um ID exclusivo para o tipo de objeto deste esquema. Será definido como {meta-type}-{unique ID}.
Singular and plural labels for the object. Used in CRM display.
Show child attributes
{
"plural": "My objects",
"singular": "My object"
}Um nome exclusivo para o tipo de objeto do esquema.
Propriedades definidas para este tipo de objeto.
Show child attributes
Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.
Quando o esquema do objeto foi criado.
Um ID exclusivo atribuído ao objeto, incluindo o ID do portal e o nome do objeto.
O nome da propriedade principal para este objeto. Será exibido como principal na página de registro do HubSpot para este tipo de objeto.
Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.
Os nomes das propriedades secundárias para este objeto. Serão exibidas como secundárias na página do registro do HubSpot para este tipo de objeto.
Quando o esquema do objeto foi atualizado pela última vez.