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

# Search Lists

> Recherchez des listes par nom de liste ou parcourez toutes les listes en fournissant une valeur « requête » vide.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/legacy/v3/crm-lists-v3.json POST /crm/v3/lists/search
openapi: 3.0.1
info:
  title: CRM Lists
  description: CRUD operations to manage lists and list memberships
  version: v3
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
  x-hubspot-related-documentation:
    - name: Lists Guide
      url: https://developers.hubspot.com/docs/guides/api/crm/lists/overview
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Batch
  - name: Search
paths:
  /crm/v3/lists/search:
    post:
      tags:
        - Search
      summary: Rechercher des listes
      description: "Recherchez des listes par nom de liste ou parcourez toutes les listes en fournissant une valeur «\_requête\_» vide."
      operationId: post-/crm/v3/lists/search_/crm/v3/lists/search
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/ListSearchRequest'
        required: true
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ListSearchResponse'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.segments.read
        - oauth2:
            - crm.lists.read
components:
  schemas:
    ListSearchRequest:
      required:
        - additionalProperties
        - offset
      type: object
      properties:
        additionalProperties:
          type: array
          description: "Les noms des propriétés de liste supplémentaires à inclure dans la réponse. Les propriétés qui n'existent pas ou qui sont vides pour une liste particulière ne sont pas incluses dans la réponse.\n\nPar défaut, toutes les demandes récupéreront les propriétés suivantes pour chaque liste\_: «\_hs_last_record_added_at\_» «\_hs_last_record_removed_at\_» «\_hs_folder_name\_» «\_hs_list_reference_count\_»."
          items:
            type: string
        count:
          type: integer
          description: "Le nombre de listes à inclure dans la réponse. Par défaut, «\_20\_» si aucune valeur n'est fournie. Le «\_nombre\_» maximum est «\_500\_»."
          format: int32
        listIds:
          type: array
          description: >-
            ID des listes ILS à inclure dans les résultats de recherche. Si rien
            n'est spécifié, toutes les listes correspondant aux autres critères
            seront incluses
          items:
            type: string
        objectTypeId:
          type: string
        offset:
          type: integer
          description: "Valeur utilisée pour paginer les listes. Le «\_décalage\_» fourni dans la réponse peut être utilisé dans la prochaine requête pour récupérer la page suivante des résultats. Par défaut, la valeur est «\_0\_» si aucun décalage n'est fourni."
          format: int32
        processingTypes:
          type: array
          description: >-
            Liste des types de traitement à inclure dans les résultats de
            recherche. Si rien n'est spécifié, toutes les listes avec tous les
            types de traitement seront incluses.
          items:
            type: string
        query:
          type: string
          description: "La «\_requête\_» qui sera utilisée pour rechercher des listes par nom de liste. Si aucune «\_requête\_» n'est fournie, les résultats incluront toutes les listes."
        sort:
          type: string
          description: Trier le champ et l'ordre
      description: The request object used for searching through lists.
      example:
        additionalProperties:
          - hs_list_size_week_delta
        count: 100
        offset: 0
        query: Test
    ListSearchResponse:
      required:
        - hasMore
        - lists
        - offset
        - total
      type: object
      properties:
        hasMore:
          type: boolean
          description: S'il y a plus de résultats à parcourir ou non.
        lists:
          type: array
          description: Les listes qui correspondent aux critères de recherche.
          items:
            $ref: '#/components/schemas/PublicObjectListSearchResult'
        offset:
          type: integer
          description: >-
            Valeur à transmettre dans une future requête pour paginer les
            résultats de recherche de la liste.
          format: int32
        total:
          type: integer
          description: Le nombre total de listes correspondant aux critères de recherche.
          format: int32
      description: >-
        The response object with the list search hits and additional information
        regarding pagination.
      example:
        hasMore: false
        lists:
          - additionalProperties:
              hs_last_record_added_at: '1695938616824'
              hs_list_reference_count: '0'
              hs_list_size: '59'
              hs_list_size_week_delta: '-10'
            createdAt: '2023-09-28T22:03:17.998Z'
            createdById: '1'
            filtersUpdatedAt: '2023-09-28T22:03:17.998Z'
            listId: '123'
            listVersion: 1
            name: Test list
            objectTypeId: 0-1
            processingStatus: COMPLETE
            processingType: SNAPSHOT
            updatedAt: '2023-09-28T22:03:37.005Z'
            updatedById: '1'
        offset: 1
        total: 1
    PublicObjectListSearchResult:
      required:
        - additionalProperties
        - listId
        - listVersion
        - name
        - objectTypeId
        - processingStatus
        - processingType
      type: object
      properties:
        additionalProperties:
          type: object
          additionalProperties:
            type: string
          description: >-
            Le nom et la valeur de toutes les propriétés supplémentaires qui
            existent pour cette liste et qui ont été incluses dans la demande de
            recherche.
        createdAt:
          type: string
          description: L'heure de création de la liste.
          format: date-time
        createdById:
          type: string
          description: L'ID de l'utilisateur qui a créé la liste.
        deletedAt:
          type: string
          description: L'heure de suppression de la liste.
          format: date-time
        filtersUpdatedAt:
          type: string
          description: L'heure de la dernière mise à jour des filtres de cette liste.
          format: date-time
        listId:
          type: string
          description: L'**ID ILS** de la liste.
        listVersion:
          type: integer
          description: La version de la liste.
          format: int32
        name:
          type: string
          description: Le nom de la liste.
        objectTypeId:
          type: string
          description: Le type d'objet de la liste.
        processingStatus:
          type: string
          description: Le statut de traitement de la liste.
        processingType:
          type: string
          description: Le type de traitement de la liste.
        updatedAt:
          type: string
          description: La date de la dernière mise à jour de la liste.
          format: date-time
        updatedById:
          type: string
          description: L'ID du dernier utilisateur à avoir mis à jour la liste.
      example:
        additionalProperties:
          hs_last_record_added_at: 1695938616824
          hs_list_reference_count: 0
          hs_list_size: 59
          hs_list_size_week_delta: -1
        createdAt: '2023-09-28T22:03:17.998Z'
        createdById: '1'
        filtersUpdatedAt: '2023-09-28T22:03:17.998Z'
        listId: '123'
        listVersion: 1
        name: Test list
        objectTypeId: 0-1
        processingStatus: COMPLETED
        processingType: SNAPSHOT
        updatedById: '1'
    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
    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.membership.access_groups.write: ''
            crm.lists.read: ''
            crm.lists.write: ''
            crm.segments.read: ''
            crm.segments.write: ''

````