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

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/cms-domains-v3.json GET /cms/v3/domains
openapi: 3.0.1
info:
  title: Domaines
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-api-use-case: >-
    Récupérer tous les domaines actuellement connectés pour voir quels sites
    sont en ligne dans un compte donné.
  x-hubspot-related-documentation:
    - name: Domains Guide
      url: https://developers.hubspot.com/docs/guides/api/cms/domains
  x-hubspot-introduction: >-
    Utilisez l'API de gestion de domaine pour obtenir des informations sur les
    domaines connectés à un compte HubSpot. Vous pouvez récupérer des données
    pour tous les domaines actuellement connectés, ou pour un seul domaine par
    ID.
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
paths:
  /cms/v3/domains:
    get:
      tags:
        - Basic
      operationId: get-/cms/v3/domains_/cms/v3/domains
      parameters:
        - name: after
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: string
        - name: archived
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: boolean
        - name: createdAfter
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: createdAt
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: createdBefore
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: limit
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: integer
            format: int32
        - name: sort
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: array
            items:
              type: string
        - name: updatedAfter
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: updatedAt
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
        - name: updatedBefore
          in: query
          required: false
          style: form
          explode: true
          schema:
            type: string
            format: date-time
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CollectionResponseWithTotalDomain'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - cms.domains.write
        - oauth2:
            - cms.knowledge_base.settings.read
        - oauth2:
            - cms.knowledge_base.settings.write
        - oauth2:
            - cms.domains.read
        - oauth2:
            - content
components:
  schemas:
    CollectionResponseWithTotalDomain:
      required:
        - results
        - total
      type: object
      properties:
        paging:
          $ref: '#/components/schemas/Paging'
        results:
          type: array
          description: Les résultats de la requête.
          items:
            $ref: '#/components/schemas/Domain'
        total:
          type: integer
          description: Le nombre de résultats disponibles.
          format: int32
    Paging:
      type: object
      properties:
        next:
          $ref: '#/components/schemas/NextPage'
        prev:
          $ref: '#/components/schemas/PreviousPage'
      description: >-
        Représente les informations de pagination pour naviguer dans une liste
        de résultats de l'API. Il fournit des détails sur la manière d'accéder à
        l'ensemble de résultats précédent ou suivant.
    Domain:
      required:
        - domain
        - id
        - isResolving
        - isUsedForBlogPost
        - isUsedForEmail
        - isUsedForKnowledge
        - isUsedForLandingPage
        - isUsedForSitePage
      type: object
      properties:
        correctCname:
          type: string
          description: La fiche d'informations CNAME attendue pour le domaine.
        created:
          type: string
          description: La date et l'heure de création du domaine.
          format: date-time
        domain:
          type: string
          description: "Le domaine ou sous-domaine actuel. Ex.\_: www.hubspot.com"
        id:
          type: string
          description: L'ID unique de ce domaine.
        isResolving:
          type: boolean
          description: >-
            Si le DNS de ce domaine est configuré de manière optimale pour être
            utilisé avec HubSpot.
        isSslEnabled:
          type: boolean
          description: Indique si SSL est activé pour le domaine.
        isSslOnly:
          type: boolean
          description: Indique si le domaine est accessible uniquement via SSL.
        isUsedForBlogPost:
          type: boolean
          description: Si le domaine est utilisé pour des articles de blog CMS.
        isUsedForEmail:
          type: boolean
          description: Si le domaine est utilisé pour les pages web de messagerie CMS.
        isUsedForKnowledge:
          type: boolean
          description: Si le domaine est utilisé pour les pages de connaissances CMS.
        isUsedForLandingPage:
          type: boolean
          description: Si le domaine est utilisé pour les pages de destination CMS.
        isUsedForSitePage:
          type: boolean
          description: Si le domaine est utilisé pour les pages de site CMS.
        manuallyMarkedAsResolving:
          type: boolean
          description: Indique si le domaine a été manuellement marqué comme résolu.
        primaryBlogPost:
          type: boolean
          description: >-
            Indique si le domaine est le domaine principal pour les articles de
            blog.
        primaryEmail:
          type: boolean
          description: >-
            Indique si le domaine est le domaine principal pour les pages
            d'e-mail.
        primaryKnowledge:
          type: boolean
          description: >-
            Indique si le domaine est le domaine principal pour les pages de
            connaissances.
        primaryLandingPage:
          type: boolean
          description: >-
            Indique si le domaine est le domaine principal pour les pages de
            destination.
        primarySitePage:
          type: boolean
          description: >-
            Indique si le domaine est le domaine principal pour les pages de
            site.
        secondaryToDomain:
          type: string
          description: Spécifie le domaine dont ce domaine est secondaire.
        updated:
          type: string
          description: Date et heure de la dernière mise à jour du domaine.
          format: date-time
    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
    NextPage:
      required:
        - after
      type: object
      properties:
        after:
          type: string
          description: >-
            Valeur du curseur indiquant où commencer à récupérer la page
            suivante de résultats dans une collection paginée
        link:
          type: string
          description: >-
            URL facultative permettant d'accéder directement à la page suivante
            des résultats.
      description: >-
        Spécifie les informations de pagination nécessaires pour récupérer le
        prochain ensemble de résultats dans une réponse d'API paginée
    PreviousPage:
      required:
        - before
      type: object
      properties:
        before:
          type: string
          description: A paging cursor token for retrieving previous pages.
        link:
          type: string
          description: A URL that can be used to retrieve the previous pages' results.
      description: >-
        specifies the paging information needed to retrieve the previous set of
        results in a paginated API response
    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.
  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:
            cms.domains.read: ''
            cms.domains.write: ''
            cms.knowledge_base.settings.read: ''
            cms.knowledge_base.settings.write: ''
            content: ''

````