Account & Settings
Gestion des applications
Authentification
Automatisation
CMS
Communication preferences
Conversations
Événements
Fichiers
Marketing
Reporting
Scheduler
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"
}Retrieve the schema of a specified custom object.
Récupérer les détails d’un schéma d’objet personnalisé, y compris ses propriétés et ses associations, en utilisant l’ID de type d’objet ou le nom entièrement qualifié.
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"
}Documentation Index
Fetch the complete documentation index at: https://developers.hubspot.fr/docs/llms.txt
Use this file to discover all available pages before exploring further.
Supported products
Supported products
Required Scopes
Required Scopes
Autorisations
The access token received from the authorization server in the OAuth 2.0 flow.
Paramètres de chemin
Nom complet ou identifiant de type d'objet de votre schéma.
Paramètres de requête
Inclure les définitions des associations liées au schéma.
Inclure les métadonnées relatives à la piste d'audit du schéma.
Inclure les définitions des propriétés associées au schéma.
Réponse
successful operation
Defines an object schema, including its properties and associations.
Associations définies pour un type d'objet donné.
Show child attributes
Show child attributes
Un ID unique pour le type d'objet de ce schéma. Sera défini comme {meta-type}-{unique ID}.
Singular and plural labels for the object. Used in CRM display.
Show child attributes
Show child attributes
{
"plural": "My objects",
"singular": "My object"
}Un nom unique pour le type d'objet de ce schéma.
Propriétés définies pour ce type d'objet.
Show child attributes
Show child attributes
Les noms des propriétés qui devraient être obligatoires lors de la création d'un objet de ce type.
Moment où le schéma d'objet a été créé.
Un ID unique attribué pour l'objet, comprenant l'ID du portail et le nom de l'objet.
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.
Noms des propriétés qui seront indexées pour ce type d'objet dans la recherche de produits de HubSpot.
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.
Moment de la dernière mise à jour du schéma.