Skip to main content
GET
Obtener el esquema de un objeto personalizado específico.

Supported products

Autorizaciones

Authorization
string
header
requerido

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

Parámetros de ruta

objectType
string
requerido

El identificador único para el tipo de objeto de CRM cuyo esquema se está recuperando.

Parámetros de consulta

includeAssociationDefinitions
boolean
predeterminado:true

Un valor booleano que indica si se deben incluir las definiciones de asociación en la respuesta. El valor predeterminado es verdadero.

includeAuditMetadata
boolean
predeterminado:true

Un valor booleano que indica si se deben incluir los metadatos de auditoría en la respuesta. El valor predeterminado es sí.

includePropertyDefinitions
boolean
predeterminado:true

Un valor booleano que indica si se deben incluir las definiciones de propiedades en la respuesta. El valor predeterminado es verdadero.

Respuesta

successful operation

allowsSensitiveProperties
boolean
requerido

Un valor booleano que indica si el esquema del objeto permite propiedades sensibles.

archived
boolean
requerido

Un valor booleano que indica si el esquema del objeto está archivado.

associations
object[]
requerido

Asociaciones definidas para un tipo de objeto determinado.

fullyQualifiedName
string
requerido

Un ID único asignado para el objeto, que incluye el ID del portal y el nombre del objeto.

id
string
requerido

Un ID único para el tipo de objeto de este esquema. Se definirá como {meta-type}-{unique ID}.

labels
object
requerido
name
string
requerido

Un nombre único para el tipo de objeto del esquema.

objectTypeId
string
requerido

Una cadena que representa el ID de tipo del objeto.

properties
object[]
requerido

Propiedades definidas para este tipo de objeto.

requiredProperties
string[]
requerido

Los nombres de las propiedades que deben ser obligatorias cuando se cree un objeto de este tipo.

searchableProperties
string[]
requerido

Los nombres de las propiedades que serán indexadas para este tipo de objeto en la búsqueda de productos de HubSpot.

secondaryDisplayProperties
string[]
requerido

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.

createdAt
string<date-time>

Cuando se creó el esquema de objetos.

createdByUserId
integer<int32>

Un número entero que representa el ID del usuario que creó el esquema del objeto.

description
string

Una cadena que proporciona una descripción del esquema del objeto.

primaryDisplayProperty
string

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.

updatedAt
string<date-time>

Cuando se actualizó por última vez el esquema de objetos.

updatedByUserId
integer<int32>

Un número entero que representa el ID del usuario que actualizó por última vez el esquema del objeto.

Última modificación el 6 de octubre de 2026