Skip to main content
POST
Search Lists

Supported products

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Body

application/json
additionalProperties
string[]
required

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

listIds
string[]
required

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

offset
integer<int32>
required

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

processingTypes
string[]
required

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

count
integer<int32>

An integer specifying the number of results to return.

objectTypeId
string

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

query
string

A string representing the search query to filter the lists.

sort
string

A string specifying the sorting criteria for the search results.

Response

successful operation

hasMore
boolean
required

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

lists
object[]
required

An array of objects representing the lists found in the search, each conforming to the PublicObjectListSearchResult schema.

offset
integer<int32>
required

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

total
integer<int32>
required

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

Last modified on August 6, 2026