Pular para o conteúdo principal
GET
Recupere o esquema de um objeto personalizado específico.

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Parâmetros de caminho

objectType
string
obrigatório

O identificador exclusivo para o tipo de objeto do CRM cujo esquema está sendo recuperado.

Parâmetros de consulta

includeAssociationDefinitions
boolean
padrão:true

Um booleano que indica se as definições de associação devem ser incluídas na resposta. O padrão é verdadeiro.

includeAuditMetadata
boolean
padrão:true

Um booleano que indica se os metadados de auditoria devem ser incluídos na resposta. O padrão é verdadeiro.

includePropertyDefinitions
boolean
padrão:true

Um booleano que indica se as definições de propriedade devem ser incluídas na resposta. O padrão é verdadeiro.

Resposta

successful operation

allowsSensitiveProperties
boolean
obrigatório

Um booleano que indica se o esquema de objeto permite propriedades confidenciais.

archived
boolean
obrigatório

Um valor booleano que indica se o esquema do objeto está arquivado.

associations
object[]
obrigatório

Associações definidas para um determinado tipo de objeto.

fullyQualifiedName
string
obrigatório

Um ID exclusivo atribuído ao objeto, incluindo o ID do portal e o nome do objeto.

id
string
obrigatório

Um ID exclusivo para o tipo de objeto deste esquema. Será definido como {meta-type}-{unique ID}.

labels
object
obrigatório
name
string
obrigatório

Um nome exclusivo para o tipo de objeto do esquema.

objectTypeId
string
obrigatório

Uma string que representa o ID de tipo do objeto.

properties
object[]
obrigatório

Propriedades definidas para este tipo de objeto.

requiredProperties
string[]
obrigatório

Os nomes das propriedades que devem ser obrigatórias ao criar um objeto deste tipo.

searchableProperties
string[]
obrigatório

Nomes das propriedades que serão indexadas para este tipo de objeto na pesquisa de produtos da HubSpot.

secondaryDisplayProperties
string[]
obrigatório

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.

createdAt
string<date-time>

Quando o esquema do objeto foi criado.

createdByUserId
integer<int32>

Um número inteiro que representa o ID do usuário que criou o esquema do objeto.

description
string

Uma string que fornece uma descrição do esquema do objeto.

primaryDisplayProperty
string

O nome da propriedade principal para este objeto. Será exibido como principal na página de registro do HubSpot para este tipo de objeto.

updatedAt
string<date-time>

Quando o esquema do objeto foi atualizado pela última vez.

updatedByUserId
integer<int32>

Um número inteiro que representa o ID do usuário que atualizou pela última vez o esquema do objeto.

Última modificação em 6 de outubro de 2026