> ## 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.

# Retrieve all custom object schemas.

> Récupérer tous les schémas d'objets personnalisés, avec des options pour inclure les définitions de propriétés, les définitions d'associations et les métadonnées d'audit.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-03/crm-schemas-v2026-03.json GET /crm-object-schemas/2026-03/schemas
openapi: 3.0.1
info:
  title: Schémas
  description: Basepom for all HubSpot Projects
  version: 2026-03
  x-hubspot-product-tier-requirements:
    marketing: ENTERPRISE
    sales: ENTERPRISE
    service: ENTERPRISE
    cms: ENTERPRISE
    commerce: ENTERPRISE
    crmHub: ENTERPRISE
    dataHub: ENTERPRISE
  x-hubspot-api-use-case: >-
    Créer un nouvel objet pour stocker des informations sur les voitures dans
    une concession automobile. La définition de votre objet pourrait inclure des
    propriétés pour stocker des informations ainsi que les filtres disponibles
    sur la page d'index de l'objet personnalisé.
  x-hubspot-introduction: >-
    Utilisez l'API de schéma d'objets personnalisés pour définir de nouveaux
    types d'enregistrements CRM dans votre compte. Après la configuration d'un
    schéma d'objet, vous serez alors en mesure de créer des fiches
    d'informations pour cet objet personnalisé, tant dans HubSpot qu'avec l'API
    d'objets.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Advanced
  - name: Basic
  - name: Batch
paths:
  /crm-object-schemas/2026-03/schemas:
    get:
      tags:
        - Basic
      summary: Récupérer tous les schémas d'objets personnalisés.
      description: >-
        Récupérer tous les schémas d'objets personnalisés, avec des options pour
        inclure les définitions de propriétés, les définitions d'associations et
        les métadonnées d'audit.
      operationId: get-/crm-object-schemas/2026-03/schemas_getAll
      parameters:
        - name: archived
          in: query
          description: S'il faut renvoyer uniquement les résultats qui ont été archivés.
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: false
        - name: includeAssociationDefinitions
          in: query
          description: "Indique si les définitions d'association doivent être incluses dans la réponse. La valeur par défaut est «\_true\_»."
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: true
        - name: includeAuditMetadata
          in: query
          description: "Indique si les métadonnées d'audit doivent être incluses dans la réponse. La valeur par défaut est «\_true\_»."
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: true
        - name: includePropertyDefinitions
          in: query
          description: "Indique si les définitions de propriétés doivent être incluses dans la réponse. La valeur par défaut est «\_true\_»."
          required: false
          style: form
          explode: true
          schema:
            type: boolean
            default: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseObjectSchemaNoPaging'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.schemas.custom.read
        - oauth2:
            - crm.objects.custom.sensitive.read.v2
        - oauth2:
            - crm.objects.custom.read
        - oauth2:
            - crm.objects.custom.highly_sensitive.read.v2
components:
  schemas:
    CollectionResponseObjectSchemaNoPaging:
      required:
        - results
      type: object
      properties:
        results:
          type: array
          description: >-
            Un tableau de schémas d'objets, chacun représenté par un schéma
            ObjectSchema. Cette propriété contient la liste des schémas renvoyés
            par l'appel d'API.
          items:
            $ref: '#/components/schemas/ObjectSchema'
    ObjectSchema:
      required:
        - allowsSensitiveProperties
        - archived
        - associations
        - fullyQualifiedName
        - id
        - labels
        - name
        - objectTypeId
        - properties
        - requiredProperties
        - searchableProperties
        - secondaryDisplayProperties
      type: object
      properties:
        allowsSensitiveProperties:
          type: boolean
          description: >-
            Un booléen indiquant si le schéma d'objet autorise les propriétés
            sensibles.
        archived:
          type: boolean
          description: Un booléen indiquant si le schéma d'objet est archivé.
        associations:
          type: array
          description: Associations définies pour un type d'objet donné.
          items:
            $ref: '#/components/schemas/AssociationDefinition'
        createdAt:
          type: string
          description: Moment où le schéma d'objet a été créé.
          format: date-time
        createdByUserId:
          type: integer
          description: >-
            Un nombre entier représentant l'ID de l'utilisateur qui a créé le
            schéma d'objet.
          format: int32
        description:
          type: string
          description: >-
            Une chaîne de caractères fournissant une description du schéma
            d'objet.
        fullyQualifiedName:
          type: string
          description: >-
            Un ID unique attribué pour l'objet, comprenant l'ID du portail et le
            nom de l'objet.
        id:
          type: string
          description: >-
            Un ID unique pour le type d'objet de ce schéma. Sera défini comme
            {meta-type}-{unique ID}.
        labels:
          $ref: '#/components/schemas/ObjectTypeDefinitionLabels'
        name:
          type: string
          description: Un nom unique pour le type d'objet de ce schéma.
        objectTypeId:
          type: string
          description: Une chaîne de caractère représentant l'ID de type de l'objet.
        primaryDisplayProperty:
          type: string
          description: >-
            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.
        properties:
          type: array
          description: Propriétés définies pour ce type d'objet.
          items:
            $ref: '#/components/schemas/Property'
        requiredProperties:
          type: array
          description: >-
            Les noms des propriétés qui devraient être **obligatoires** lors de
            la création d'un objet de ce type.
          items:
            type: string
        searchableProperties:
          type: array
          description: >-
            Noms des propriétés qui seront indexées pour ce type d'objet dans la
            recherche de produits de HubSpot.
          items:
            type: string
        secondaryDisplayProperties:
          type: array
          description: >-
            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.
          items:
            type: string
        updatedAt:
          type: string
          description: Moment de la dernière mise à jour du schéma.
          format: date-time
        updatedByUserId:
          type: integer
          description: >-
            Un nombre entier représentant l'ID de l'utilisateur qui a mis à jour
            le schéma d'objet en dernier.
          format: int32
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: La catégorie d'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Un identifiant unique pour la demande. Incluez cette valeur dans
            tous les rapports d'erreurs ou tickets d'assistance
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: informations supplémentaires à propos de l'erreur
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Une carte des noms de liens vers les URI associés contenant de la
            documentation sur l'erreur ou les mesures correctives recommandées
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente une réponse d'erreur renvoyée par l'API lorsqu'une opération
        échoue. Ce composant est utilisé dans divers points de terminaison pour
        fournir des informations détaillées sur l'erreur rencontrée.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    AssociationDefinition:
      required:
        - fromObjectTypeId
        - id
        - toObjectTypeId
      type: object
      properties:
        createdAt:
          type: string
          description: Moment où l'association a été définie.
          format: date-time
        fromObjectTypeId:
          type: string
          description: ID du type d'objet principal depuis lequel lier.
        id:
          type: string
          description: Un ID unique pour cette association.
        name:
          type: string
          description: Un nom unique pour cette association.
        toObjectTypeId:
          type: string
          description: ID du type d'objet cible ID vers lequel lier.
        updatedAt:
          type: string
          description: Moment de la dernière mise à jour de l'association.
          format: date-time
      description: The definition of an association
    ObjectTypeDefinitionLabels:
      type: object
      properties:
        plural:
          type: string
          description: >-
            Le mot pour plusieurs objets. (Vous ne pourrez pas le changer plus
            tard.)
        singular:
          type: string
          description: Le mot pour un objet. (Vous ne pourrez pas le changer plus tard.)
    Property:
      required:
        - description
        - fieldType
        - groupName
        - label
        - name
        - options
        - type
      type: object
      properties:
        archived:
          type: boolean
          description: Si la propriété est archivée ou non.
        archivedAt:
          type: string
          description: Moment où la propriété a été archivée
          format: date-time
        calculated:
          type: boolean
          description: >-
            Pour les propriétés par défaut, vrai indique que la propriété est
            calculée par un processus HubSpot. Cela n'a aucun effet pour les
            propriétés personnalisées.
        calculationFormula:
          type: string
          description: >-
            La formule utilisée pour calculer la valeur de cette propriété, s'il
            s'agit d'une propriété calculée.
        createdAt:
          type: string
          description: Quand la propriété a été créée
          format: date-time
        createdUserId:
          type: string
          description: >-
            L'identifiant interne de l'utilisateur qui a créé la propriété dans
            HubSpot. Ce champ peut ne pas exister si la propriété a été créée en
            dehors de HubSpot.
        currencyPropertyName:
          type: string
          description: >-
            Le nom de la propriété qui définit la devise de cette propriété, le
            cas échéant.
        dataSensitivity:
          type: string
          description: "Le niveau de sensibilité des données stockées dans cette propriété, tel que «\_sensitive\_» ou «\_highly_sensitive\_»."
          enum:
            - highly_sensitive
            - non_sensitive
            - sensitive
        dateDisplayHint:
          type: string
          description: >-
            Contrôle la façon dont les propriétés de date sont affichées dans
            l'interface utilisateur de HubSpot, avec des options telles que «
            absolue », « absolue_avec_relative », « depuis » et « jusqu'à ».
          enum:
            - absolute
            - absolute_with_relative
            - time_since
            - time_until
        description:
          type: string
          description: >-
            Une description de la propriété qui sera affichée comme texte d'aide
            dans HubSpot.
        displayOrder:
          type: integer
          description: >-
            L'ordre dans lequel cette propriété doit être affichée dans
            l'interface utilisateur de HubSpot par rapport aux autres propriétés
            de ce type d'objet. Les propriétés sont affichées dans l'ordre en
            commençant par la valeur entière positive la plus basse. Une valeur
            de -1 fera en sorte que la propriété soit affichée **après** toutes
            les valeurs positives.
          format: int32
        externalOptions:
          type: boolean
          description: >-
            Par défaut, vrai indique que les options sont stockées en dehors des
            paramètres de propriété.
        fieldType:
          type: string
          description: Contrôle la façon dont la propriété apparaît dans HubSpot.
        formField:
          type: boolean
          description: >-
            Si la propriété peut être utilisée dans un formulaire HubSpot ou
            non.
        groupName:
          type: string
          description: Le nom du groupe de propriétés auquel appartient la propriété.
        hasUniqueValue:
          type: boolean
          description: >-
            Si la valeur de la propriété doit être unique ou non. Une fois
            définie, il n'est pas possible de le modifier.
        hidden:
          type: boolean
          description: Les option masquées ne seront pas affichées dans HubSpot.
          example: false
        hubspotDefined:
          type: boolean
          description: "Cette valeur sera «\_vrai\_» pour les propriétés d'objet par défaut intégrées dans HubSpot."
        label:
          type: string
          description: >-
            Un libellé de propriété qui sera affichée dans HubSpot lisible par
            les personnes.
        modificationMetadata:
          $ref: '#/components/schemas/PropertyModificationMetadata'
        name:
          type: string
          description: >-
            Le nom interne de la propriété, qui doit être utilisé lorsque la
            propriété est référencée par le biais de l'API.
        numberDisplayHint:
          type: string
          description: "Une indication sur la manière dont les valeurs numériques doivent être affichées, avec des options telles que «\_formatted\_» ou «\_currency\_»."
          enum:
            - currency
            - duration
            - formatted
            - percentage
            - probability
            - unformatted
        options:
          type: array
          description: >-
            Une liste d'options valides pour la propriété. Ce champ est requis
            pour les propriétés énumérées, mais sera vide pour les autres types
            de propriétés.
          items:
            $ref: '#/components/schemas/Option'
        referencedObjectType:
          type: string
          description: >-
            Si cette propriété est liée à un ou plusieurs autres objets, ils
            seront répertoriés ici.
        sensitiveDataCategories:
          type: array
          description: >-
            Un ensemble de catégories décrivant les types de données sensibles
            contenues dans cette propriété.
          items:
            type: string
        showCurrencySymbol:
          type: boolean
          description: >-
            Si la propriété affiche le symbole de la devise défini dans les
            paramètres du compte.
        textDisplayHint:
          type: string
          description: "Une indication sur la manière dont les valeurs de texte doivent être affichées, avec des options telles que «\_email\_» ou «\_phone_number\_»."
          enum:
            - domain_name
            - email
            - ip_address
            - multi_line
            - phone_number
            - physical_address
            - postal_code
            - unformatted_single_line
        type:
          type: string
          description: Le type de données de la propriété.
        updatedAt:
          type: string
          description: Lors de la dernière mise à jour du type d'objet.
          format: date-time
        updatedUserId:
          type: string
          description: >-
            L'ID utilisateur interne de l'utilisateur qui a mis à jour la
            propriété dans HubSpot. Ce champ peut ne pas exister si la propriété
            a été mise à jour en dehors de HubSpot.
      description: A HubSpot property
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: Le code du statut associé au détail de l'erreur
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Contexte concernant la condition d'erreur
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: Le nom du champ ou du paramètre dans lequel l'erreur a été trouvée.
        message:
          type: string
          description: >-
            Un message lisible par la personne décrivant l'erreur ainsi que les
            mesures correctives possibles, le cas échéant
        subCategory:
          type: string
          description: >-
            Une catégorie spécifique qui contient des détails plus précis sur
            l'erreur
      description: >-
        Représente des informations détaillées sur une erreur survenue dans
        l'API. Ce composant est utilisé pour fournir un contexte et des
        spécificités supplémentaires sur les erreurs, généralement dans le cadre
        d'une réponse d'erreur.
    PropertyModificationMetadata:
      required:
        - archivable
        - readOnlyDefinition
        - readOnlyValue
      type: object
      properties:
        archivable:
          type: boolean
          description: Indique si la propriété peut être archivée.
        readOnlyDefinition:
          type: boolean
          description: Indique si la définition de la propriété est en lecture seule.
        readOnlyOptions:
          type: boolean
          description: Indique si les options de la propriété sont en lecture seule.
        readOnlyValue:
          type: boolean
          description: Indique si la valeur de la propriété est en lecture seule.
    Option:
      required:
        - hidden
        - label
        - value
      type: object
      properties:
        description:
          type: string
          description: Une description de l'option.
        displayOrder:
          type: integer
          description: >-
            Les options sont affichées dans l'ordre croissant en partant de la
            valeur entière positive la plus basse. Les valeurs de -1 feront
            apparaître l'option après chaque valeur positive.
          format: int32
        hidden:
          type: boolean
          description: Les option masquées ne seront pas affichées dans HubSpot.
        label:
          type: string
          description: >-
            Un libellé d'option qui sera affiché dans HubSpot lisible par les
            personnes.
        value:
          type: string
          description: >-
            La valeur interne de l'option, qui doit être utilisé lorsque la
            valeur de propriété est définie par le biais de l'API.
      description: A HubSpot property option
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            crm.objects.custom.highly_sensitive.read.v2: ''
            crm.objects.custom.highly_sensitive.write.v2: ''
            crm.objects.custom.read: ''
            crm.objects.custom.sensitive.read.v2: ''
            crm.objects.custom.sensitive.write.v2: ''
            crm.objects.custom.write: ''
            crm.schemas.custom.read: ''
            crm.schemas.custom.write: ''

````