Search Lists
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.
Supported products
Supported products
Required Scopes
Required Scopes
Authorizations
The access token received from the authorization server in the OAuth 2.0 flow.
Body
An array of strings representing additional properties to include in the search.
An array of strings specifying the IDs of the lists to search.
An integer used for pagination, indicating the starting point for the search results.
An array of strings indicating the types of processing to apply to the search results.
An integer specifying the number of results to return.
A string representing the object type ID to filter the lists.
A string representing the search query to filter the lists.
A string specifying the sorting criteria for the search results.
Response
successful operation
A boolean indicating whether there are more results available beyond the current page.
An array of objects representing the lists found in the search, each conforming to the PublicObjectListSearchResult schema.
An integer indicating the position in the list of results where the current page starts.
An integer indicating the total number of lists found by the search.