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 que representa o token do cursor de paginação, usado para recuperar o próximo conjunto de resultados em uma resposta paginada.

filterGroups
object[]
obrigatório

Uma matriz de grupos de filtros usada para refinar os resultados da pesquisa em que cada um deles contém vários filtros combinados usando operações lógicas AND.

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 indica quais propriedades dos objetos devem ser incluídas nos resultados da pesquisa.

sorts
string[]
obrigatório

Uma matriz de strings que especifica a ordem de classificação dos resultados da pesquisa. Cada string representa uma propriedade pela qual classificar, opcionalmente prefixada com um "-" para indicar ordem decrescente.

query
string

Uma string usada para realizar uma pesquisa de texto completo nas propriedades especificadas.

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 do CRM individual.

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