> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Search Lists

> Pesquise listas na sua conta da HubSpot usando vários critérios. Este endpoint permite filtrar e recuperar listas com base em parâmetros de pesquisa específicos, facilitando o gerenciamento e a organização eficaz das suas listas.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2026-09/crm-lists-v2026-09.json POST /crm/lists/2026-09/search
openapi: 3.0.1
info:
  title: CRM Lists
  description: Basepom for all HubSpot Projects
  version: 2026-09
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
  - name: Batch
  - name: Search
paths:
  /crm/lists/2026-09/search:
    post:
      tags:
        - Search
      summary: Pesquisar listas
      description: >-
        Pesquise listas na sua conta da HubSpot usando vários critérios. Este
        endpoint permite filtrar e recuperar listas com base em parâmetros de
        pesquisa específicos, facilitando o gerenciamento e a organização eficaz
        das suas listas.
      operationId: post-/crm/lists/2026-09/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
        - listIds
        - offset
        - processingTypes
      type: object
      properties:
        additionalProperties:
          type: array
          description: >-
            Matriz de strings que representa propriedades adicionais a serem
            incluídas na pesquisa.
          items:
            type: string
        count:
          type: integer
          description: >-
            Número inteiro que especifica o número de resultados a serem
            retornados.
          format: int32
        listIds:
          type: array
          description: >-
            Matriz de strings que especifica os IDs das listas a serem
            pesquisadas.
          items:
            type: string
        objectTypeId:
          type: string
          description: >-
            Uma string que representa o ID do tipo de objeto para filtrar as
            listas.
        offset:
          type: integer
          description: >-
            Número inteiro usado para paginação, indicando o ponto de partida
            dos resultados da pesquisa.
          format: int32
        processingTypes:
          type: array
          description: >-
            Matriz de strings que indicam os tipos de processamento a serem
            aplicados aos resultados da pesquisa.
          items:
            type: string
        query:
          type: string
          description: String que representa a consulta de pesquisa para filtrar as listas.
        sort:
          type: string
          description: >-
            String que especifica os critérios de classificação para os
            resultados da pesquisa.
    ListSearchResponse:
      required:
        - hasMore
        - lists
        - offset
        - total
      type: object
      properties:
        hasMore:
          type: boolean
          description: >-
            Booleano que indica se há mais resultados disponíveis além da página
            atual.
        lists:
          type: array
          description: >-
            Matriz de objetos que representam as listas encontradas na pesquisa,
            cada uma em conformidade com o esquema PublicObjectListSearchResult.
          items:
            $ref: '#/components/schemas/PublicObjectListSearchResult'
        offset:
          type: integer
          description: >-
            Um número inteiro que indica a posição na lista de resultados onde a
            página atual começa.
          format: int32
        total:
          type: integer
          description: >-
            Número inteiro que indica o total de listas encontradas pela
            pesquisa.
          format: int32
    PublicObjectListSearchResult:
      required:
        - additionalProperties
        - listId
        - listVersion
        - name
        - objectTypeId
        - processingStatus
        - processingType
      type: object
      properties:
        additionalProperties:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto que contém propriedades adicionais da lista, com cada
            propriedade representada como uma string.
        createdAt:
          type: string
          description: A data e a hora em que a lista foi criada, no formato ISO 8601.
          format: date-time
        createdById:
          type: string
          description: >-
            O identificador exclusivo do usuário que criou a lista, representado
            como uma string.
        deletedAt:
          type: string
          description: A data e hora em que a lista foi excluída, no formato ISO 8601.
          format: date-time
        filtersUpdatedAt:
          type: string
          description: >-
            A data e a hora da última atualização dos filtros da lista, no
            formato ISO 8601.
          format: date-time
        listId:
          type: string
          description: O identificador exclusivo da lista, representado como uma string.
        listVersion:
          type: integer
          description: Um número inteiro que indica a versão da lista.
          format: int32
        name:
          type: string
          description: O nome da lista, representado por uma string.
        objectTypeId:
          type: string
          description: >-
            O identificador exclusivo para o tipo de objeto associado à lista,
            representado como uma string.
        processingStatus:
          type: string
          description: Uma string que representa o status de processamento atual da lista.
        processingType:
          type: string
          description: Uma string que indica o tipo de processamento aplicado à lista.
        updatedAt:
          type: string
          description: A data e a hora da última atualização da lista, no formato ISO 8601.
          format: date-time
        updatedById:
          type: string
          description: >-
            O identificador exclusivo do usuário que atualizou a lista pela
            última vez, representado como uma string.
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: Uma string que indica a categoria do erro.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Um objeto com contexto adicional sobre o erro, representado como um
            mapa de pares de chave-valor.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a instância do erro, usado para fins
            de rastreamento e depuração.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            Uma matriz de objetos ErrorDetail, cada um fornecendo informações
            adicionais sobre erros específicos que ocorreram.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um objeto com links relacionados, representado como um mapa de nomes
            de links para URLs.
        message:
          type: string
          description: Uma string que fornece uma descrição legível do erro.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Um objeto que representa uma classificação mais específica do erro
            dentro de sua categoria.
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      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: >-
            Uma string que representa um código de erro específico que
            identifica o tipo de erro.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Um objeto com contexto adicional sobre o erro, representado como um
            mapa de strings para matrizes de strings, que pode incluir
            parâmetros ou valores específicos relacionados ao erro.
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: >-
            Uma string que indica o local onde o erro ocorreu, como 'query',
            'header' ou 'body'.
        message:
          type: string
          description: Uma string contendo uma descrição legível do erro.
        subCategory:
          type: string
          description: >-
            Um objeto que fornece categorização adicional do erro, que pode
            conter mais detalhes.
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  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: ''

````