Skip to main content
GET
Récupérer le schéma d'un objet personnalisé spécifié.

Supported products

Autorisations

Authorization
string
header
requis

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

Paramètres de chemin

objectType
string
requis

L'identifiant unique du type d'objet CRM dont le schéma est récupéré.

Paramètres de requête

includeAssociationDefinitions
boolean
défaut:true

Un booléen indiquant s'il faut inclure les définitions d'association dans la réponse. La valeur par défaut est « true ».

includeAuditMetadata
boolean
défaut:true

Un booléen indiquant s'il faut inclure les métadonnées d'audit dans la réponse. La valeur par défaut est « vrai ».

includePropertyDefinitions
boolean
défaut:true

Un booléen indiquant s'il faut inclure les définitions de propriété dans la réponse. La valeur par défaut est « true ».

Réponse

successful operation

allowsSensitiveProperties
boolean
requis

Un booléen indiquant si le schéma d'objet autorise les propriétés sensibles.

archived
boolean
requis

Un booléen indiquant si le schéma d'objet est archivé.

associations
object[]
requis

Associations définies pour un type d'objet donné.

fullyQualifiedName
string
requis

Un ID unique attribué pour l'objet, comprenant l'ID du portail et le nom de l'objet.

id
string
requis

Un ID unique pour le type d'objet de ce schéma. Sera défini comme {meta-type}-{unique ID}.

labels
object
requis
name
string
requis

Un nom unique pour le type d'objet de ce schéma.

objectTypeId
string
requis

Une chaîne de caractère représentant l'ID de type de l'objet.

properties
object[]
requis

Propriétés définies pour ce type d'objet.

requiredProperties
string[]
requis

Les noms des propriétés qui devraient être obligatoires lors de la création d'un objet de ce type.

searchableProperties
string[]
requis

Noms des propriétés qui seront indexées pour ce type d'objet dans la recherche de produits de HubSpot.

secondaryDisplayProperties
string[]
requis

Les noms des propriétés secondaires pour cet objet. Elles seront affichées comme secondaires sur la page de la fiche d'informations HubSpot pour ce type d'objet.

createdAt
string<date-time>

Moment où le schéma d'objet a été créé.

createdByUserId
integer<int32>

Un nombre entier représentant l'ID de l'utilisateur qui a créé le schéma d'objet.

description
string

Une chaîne de caractères fournissant une description du schéma d'objet.

primaryDisplayProperty
string

Le nom de la propriété principale pour cet objet. Elle sera affichée comme principale sur la page de la fiche d'informations HubSpot pour ce type d'objet.

updatedAt
string<date-time>

Moment de la dernière mise à jour du schéma.

updatedByUserId
integer<int32>

Un nombre entier représentant l'ID de l'utilisateur qui a mis à jour le schéma d'objet en dernier.

Dernière modification le 6 octobre 2026