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

Uma string usada como token de cursor de paginação para recuperar o próximo conjunto de resultados após um determinado objeto.

filterGroups
object[]
obrigatório

Matriz de grupos de filtros, cada um contendo um conjunto de filtros para aplicar à pesquisa. Cada grupo de filtros é combinado usando AND lógico, enquanto os próprios grupos são combinados usando OR lógico.

limit
integer<int32>
obrigatório

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

properties
string[]
obrigatório

Matriz de strings que indicam quais propriedades devem ser incluídas nos resultados da pesquisa.

sorts
string[]
obrigatório

Uma matriz de strings que especifica as propriedades pelas quais os resultados da pesquisa devem ser classificados.

query
string

String usada para realizar uma pesquisa de texto completo em propriedades pesquisáveis.

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 individual no conjunto.

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