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

---
id: 64c5225a-f3ba-4ca6-8898-5be40f9b50b0
---

# Search Lists

> Search lists by list name or page through all lists by providing an empty `query` value.

export const ScopesList = ({scopes = [], description = "This API requires one of the following scopes:"}) => {
  if (!scopes || scopes.length === 0) {
    return null;
  }
  const sortedScopes = scopes.sort((a, b) => a.localeCompare(b));
  return <div>
      <div className="text-sm mb-2">{description}</div>
      <div>
        {sortedScopes.map((scope, index) => <div key={index}>
            <code>
              <span className="text-xs">{scope}</span>
            </code>
          </div>)}
      </div>
    </div>;
};

export const SupportedProducts = ({marketing, sales, service, cms, data, commerce, marketingLevel, salesLevel, serviceLevel, cmsLevel, dataLevel, commerceLevel}) => {
  const translations = {
    description: "Requires one of the following products or higher.",
    productNames: {
      marketing: "Marketing Hub",
      sales: "Sales Hub",
      service: "Service Hub",
      cms: "Content Hub",
      data: "Data Hub",
      commerce: "Revenue Hub"
    },
    tiers: {
      free: "Free",
      starter: "Starter",
      professional: "Professional",
      enterprise: "Enterprise"
    }
  };
  const translateTier = tier => {
    if (!tier) return '';
    const lowerTier = tier.toLowerCase();
    return translations.tiers[lowerTier] || tier;
  };
  const products = [{
    name: marketing ? translations.productNames.marketing : '',
    level: translateTier(marketingLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/marketing-bolt.svg",
    alt: "Marketing Hub"
  }, {
    name: sales ? translations.productNames.sales : '',
    level: translateTier(salesLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/sales-star.svg",
    alt: "Sales Hub"
  }, {
    name: service ? translations.productNames.service : '',
    level: translateTier(serviceLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/service-heart.svg",
    alt: "Service Hub"
  }, {
    name: cms ? translations.productNames.cms : '',
    level: translateTier(cmsLevel),
    icon: "https://mintlify-assets.b-cdn.net/Icons/content-play.svg",
    alt: "Content Hub"
  }, {
    name: data ? translations.productNames.data : '',
    level: translateTier(dataLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base_2023-24-25/subscription_key_icons/operations_icon.svg",
    alt: "Data Hub"
  }, {
    name: commerce ? translations.productNames.commerce : '',
    level: translateTier(commerceLevel),
    icon: "https://developers.hubspot.com/hubfs/Knowledge_Base/subscription_key_icons/commerce_icon.svg",
    alt: "Revenue Hub"
  }].filter(product => product.name && product.level);
  if (products.length === 0) return null;
  return <div>
      <div className="text-sm mb-2">{translations.description}</div>
      <div className={`grid ${products.length === 1 ? 'grid-cols-1' : 'grid-cols-2'} gap-1.5`}>
        {products.map((product, index) => <div key={index} style={{
    display: 'flex',
    alignItems: 'center'
  }}>
            <img src={product.icon} alt={product.alt} className="w-3.5 h-3.5 mr-1.5 mt-2.5 mb-2.5 flex-shrink-0 align-middle" />
            <span className="font-medium mr-1 text-sm">{product.name} -</span>
            <span className="text-sm">{product.level}</span>
          </div>)}
      </div>
    </div>;
};

<AccordionGroup>
  <Accordion title="Supported products" defaultOpen="true" icon="cubes">
    <SupportedProducts marketing={true} sales={true} service={true} cms={true} marketingLevel="FREE" salesLevel="FREE" serviceLevel="FREE" cmsLevel="FREE" />
  </Accordion>

  <Accordion title="Required Scopes" icon="key">
    <ScopesList
      scopes={[
  'crm.lists.read'
]}
    />
  </Accordion>
</AccordionGroup>


## 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: Search Lists
      description: >-
        Search lists by list name or page through all lists by providing an
        empty `query` value.
      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.lists.read
components:
  schemas:
    ListSearchRequest:
      required:
        - additionalProperties
        - offset
      type: object
      properties:
        additionalProperties:
          type: array
          description: >-
            The property names of any additional list properties to include in
            the response. Properties that do not exist or that are empty for a
            particular list are not included in the response.


            By default, all requests will fetch the following properties for
            each list: `hs_list_size`, `hs_last_record_added_at`,
            `hs_last_record_removed_at`, `hs_folder_name`, and
            `hs_list_reference_count`.
          items:
            type: string
        count:
          type: integer
          description: >-
            The number of lists to include in the response. Defaults to `20` if
            no value is provided. The max `count` is `500`.
          format: int32
        listIds:
          type: array
          description: >-
            ILS list ids to be included in search results. If not specified, all
            lists matching other criteria will be included
          items:
            type: string
        objectTypeId:
          type: string
        offset:
          type: integer
          description: >-
            Value used to paginate through lists. The `offset` provided in the
            response can be used in the next request to fetch the next page of
            results. Defaults to `0` if no offset is provided.
          format: int32
        processingTypes:
          type: array
          description: >-
            List processing types to be included in search results. If not
            specified, all lists with all processing types will be included.
          items:
            type: string
        query:
          type: string
          description: >-
            The `query` that will be used to search for lists by list name. If
            no `query` is provided, then the results will include all lists.
        sort:
          type: string
          description: Sort field and order
      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: Whether or not there are more results to page through.
        lists:
          type: array
          description: The lists that matched the search criteria.
          items:
            $ref: '#/components/schemas/PublicObjectListSearchResult'
        offset:
          type: integer
          description: >-
            Value to be passed in a future request to paginate through list
            search results.
          format: int32
        total:
          type: integer
          description: The total number of lists that match the search criteria.
          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: >-
            The name and value of any additional properties that exist for this
            list and that were included in the search request.
        createdAt:
          type: string
          description: The time when the list was created.
          format: date-time
        createdById:
          type: string
          description: The ID of the user that created the list.
        deletedAt:
          type: string
          description: The time when the list was deleted.
          format: date-time
        filtersUpdatedAt:
          type: string
          description: The time when the filters for this list were last updated.
          format: date-time
        listId:
          type: string
          description: The **ILS ID** of the list.
        listVersion:
          type: integer
          description: The version of the list.
          format: int32
        name:
          type: string
          description: The name of the list.
        objectTypeId:
          type: string
          description: The object type of the list.
        processingStatus:
          type: string
          description: The processing status of the list.
        processingType:
          type: string
          description: The processing type of the list.
        updatedAt:
          type: string
          description: The time the list was last updated.
          format: date-time
        updatedById:
          type: string
          description: The ID of the user that last updated the list.
      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: The error category
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            A unique identifier for the request. Include this value with any
            error reports or support tickets
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: further information about the error
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            A map of link names to associated URIs containing documentation
            about the error or recommended remediation steps
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
          example: An error occurred
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
      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: The status code associated with the error detail
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Context about the error condition
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: The name of the field or parameter in which the error was found.
        message:
          type: string
          description: >-
            A human readable message describing the error along with remediation
            steps where appropriate
        subCategory:
          type: string
          description: >-
            A specific category that contains more specific detail about the
            error
  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: ''

````