HUhubspot
Search

POST /crm/lists/2026-03/search

Changed on

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/lists/2026-03/search
  • Auth
    • HTTP bearer
    • or API key in query parameter hapikey
    • or none

Request body

countinteger

The number of lists to include in the response. Defaults to 20 if no value is provided. The max count is 500.

listIdsstring[] required

ILS list ids to be included in search results. If not specified, all lists matching other criteria will be included

objectTypeIdstring
offsetinteger 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.

processingTypesstring[] required

List processing types to be included in search results. If not specified, all lists with all processing types will be included.

querystring

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.

sortstring

Sort field and order

additional_filter_propertiesstring[]

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.

Response

successful operation

hasMoreboolean required

Whether or not there are more results to page through.

offsetinteger required

Value to be passed in a future request to paginate through list search results.

totalinteger required

The total number of lists that match the search criteria.

Changes

  • b0d8bc008db9Revision changes
    • breaking

      removed the required property // from the response with the status

    • warning

      removed the request property

    • info

      api operation id post-/crm/lists/2026-03/search_/crm/lists/v3/search removed and replaced with post-/crm/lists/2026-03/search

    • info

      added the new optional request property

    • info

      added the optional property // to the response with the status

  • dc2fdad57f7fRevision changes
    • info

      api operation id post-/crm/lists/2026-03/search_doSearch removed and replaced with post-/crm/lists/2026-03/search_/crm/lists/v3/search

Some revisions have not been checked yet.