HUhubspot
Search

Search Lists

Changed on

Search for lists within your HubSpot account using various criteria. This endpoint allows you to filter and retrieve lists based on specific search parameters, making it easier to manage and organize your lists effectively.

post/crm/lists/2026-09/search

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/crm/lists/2026-09/search
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.segments.read
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: crm.lists.read

Request body

additionalPropertiesstring[] required

An array of strings representing additional properties to include in the search.

countinteger

An integer specifying the number of results to return.

listIdsstring[] required

An array of strings specifying the IDs of the lists to search.

objectTypeIdstring

A string representing the object type ID to filter the lists.

offsetinteger required

An integer used for pagination, indicating the starting point for the search results.

processingTypesstring[] required

An array of strings indicating the types of processing to apply to the search results.

querystring

A string representing the search query to filter the lists.

sortstring

A string specifying the sorting criteria for the search results.

Response

successful operation

hasMoreboolean required

A boolean indicating whether there are more results available beyond the current page.

offsetinteger required

An integer indicating the position in the list of results where the current page starts.

totalinteger required

An integer indicating the total number of lists found by the search.

Changes

  • 2026-09e1dd745172d1Revision changes
    • info

      the security scope crm.segments.read was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.lists.read was removed from the endpoint's security scheme oauth2

  • 2026-096d0e6dc36ca0Revision changes
    • info

      the security scope crm.segments.read was added to the endpoint's security scheme oauth2

    • info

      the security scope crm.lists.read was removed from the endpoint's security scheme oauth2