Pular para o conteúdo principal
POST
Pesquisar

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. Serve para recuperar o próximo conjunto de resultados após a página atual.

filterGroups
object[]
obrigatório

Uma matriz de grupos de filtros usada para definir os critérios de pesquisa, em que cada grupo contém filtros que determinam quais objetos do CRM são incluídos nos resultados da pesquisa.

limit
integer<int32>
obrigatório

Um número inteiro que indica o máximo de resultados a serem retornados por página. Esta propriedade controla a paginação dos resultados da pesquisa.

properties
string[]
obrigatório

Uma matriz de strings que especifica as propriedades dos objetos do CRM a serem retornadas nos resultados da pesquisa. Se uma propriedade especificada não estiver presente nos objetos, ela será ignorada.

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 os resultados devem ser classificados.

query
string

Uma string que representa uma consulta de pesquisa para filtrar os objetos do CRM. Este é um campo opcional que pode ser usado para realizar uma pesquisa baseada em texto.

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 contendo os objetos públicos simples retornados na resposta atual.

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