---
title: "Search Lists"
method: POST
path: "/crm/v3/lists/search"
tags: ["Search"]
---

# Search Lists

`POST /crm/v3/lists/search`

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

## Request body

- ListSearchRequest — The request object used for searching through lists.
  - `additionalProperties` string[], required — 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`.
  - `count` integer — The number of lists to include in the response. Defaults to `20` if no value is provided. The max `count` is `500`.
  - `listIds` string[] — ILS list ids to be included in search results. If not specified, all lists matching other criteria will be included
  - `objectTypeId` string
  - `offset` integer, required — 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.
  - `processingTypes` string[] — List processing types to be included in search results. If not specified, all lists with all processing types will be included.
  - `query` string — 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` string — Sort field and order

## Response `200`

successful operation

- ListSearchResponse — The response object with the list search hits and additional information regarding pagination.
  - `hasMore` boolean, required — Whether or not there are more results to page through.
  - `lists` PublicObjectListSearchResult[], required — The lists that matched the search criteria.
    - `additionalProperties` object, required — The name and value of any additional properties that exist for this list and that were included in the search request.
    - `createdAt` string, date-time — The time when the list was created.
    - `createdById` string — The ID of the user that created the list.
    - `deletedAt` string, date-time — The time when the list was deleted.
    - `filtersUpdatedAt` string, date-time — The time when the filters for this list were last updated.
    - `listId` string, required — The **ILS ID** of the list.
    - `listVersion` integer, required — The version of the list.
    - `name` string, required — The name of the list.
    - `objectTypeId` string, required — The object type of the list.
    - `processingStatus` string, required — The processing status of the list.
    - `processingType` string, required — The processing type of the list.
    - `updatedAt` string, date-time — The time the list was last updated.
    - `updatedById` string — The ID of the user that last updated the list.
  - `offset` integer, required — Value to be passed in a future request to paginate through list search results.
  - `total` integer, required — The total number of lists that match the search criteria.

## Other responses

- `default` — An error occurred.

---

[API](https://skmtc.net/hubspot/apis/crm-lists.md) · [All operations](https://skmtc.net/hubspot/apis/crm-lists/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/hubspot/crm-lists/revisions/2ba1203b03a0/schema)