Pular para o conteúdo principal
POST
Pesquisar objetos

Supported products

Autorizações

Authorization
string
header
obrigatório

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

Corpo

application/json

Descreve uma solicitação de pesquisa

after
string
obrigatório

String usada como cursor para paginação para indicar onde começar a retornar os resultados.

filterGroups
object[]
obrigatório

Uma matriz de grupos de filtros usado para refinar os resultados da pesquisa com base em critérios específicos.

limit
integer<int32>
obrigatório

Um número inteiro que indica o número máximo de resultados a serem retornados.

properties
string[]
obrigatório

Uma matriz de strings que especifica quais propriedades dos objetos devem ser incluídas na resposta.

sorts
string[]
obrigatório

Uma matriz de strings que especifica a ordem em que os resultados da pesquisa devem ser retornados.

query
string

Uma string que representa uma consulta de pesquisa para corresponder aos objetos.

Resposta

successful operation

Representa uma lista de objetos simples retornados de uma solicitação de API, juntamente com o número total de objetos disponíveis.

results
object[]
obrigatório

Uma matriz de itens SimplePublicObject, cada um representando um objeto público na coleção.

total
integer<int32>
obrigatório

O número de resultados disponíveis

paging
object

Representa as informações de paginação para navegar por uma lista de resultados na API. Ele fornece detalhes sobre como acessar o conjunto anterior ou seguinte de resultados.

Última modificação em 6 de outubro de 2026