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"
}Obtén los detalles de un esquema de objeto personalizado, incluidas sus propiedades y asociaciones, usando el ID de tipo de objeto o el nombre completo.
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"
}Productos compatibles
Ámbitos Requeridos
The access token received from the authorization server in the OAuth 2.0 flow.
Nombre completamente calificado o ID del tipo de objeto de tu esquema.
Incluye las definiciones de las asociaciones relacionadas con el esquema.
Incluye metadatos sobre el registro de auditoría del esquema.
Incluye las definiciones de las propiedades asociadas al esquema.
successful operation
Defines an object schema, including its properties and associations.
Asociaciones definidas para un tipo de objeto determinado.
Show child attributes
Un ID único para este tipo de objeto. Se definirá 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"
}Un nombre único para este objeto. Solo para uso interno.
Propiedades definidas para este tipo de objeto.
Show child attributes
Los nombres de las propiedades que deben ser obligatorias cuando se cree un objeto de este tipo.
Cuando se creó el tipo de objeto.
Un ID único asignado para el objeto, que incluye el ID del portal y el nombre del objeto.
El nombre de la propiedad principal de este objeto. Se mostrará como principal en la página de registro de HubSpot para este tipo de objeto.
Los nombres de las propiedades que serán indexadas para este tipo de objeto en la búsqueda de productos de HubSpot.
Los nombres de las propiedades secundarias de este objeto. Se mostrarán como secundarias en la página de registro de HubSpot para este tipo de objeto.
Cuando se actualizó por última vez el tipo de objeto.