Pular para o conteúdo principal
POST
Pesquise leads usando critérios específicos.

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 serve como cursor para paginação, indicando onde começar a retornar os resultados.

filterGroups
object[]
obrigatório

Uma matriz de grupos de filtros usada para refinar os resultados da pesquisa com base em critérios especificados.

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

Uma matriz de strings que indica quais propriedades dos objetos do CRM 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.

query
string

Uma string que representa a consulta de pesquisa a ser aplicada aos objetos do CRM.

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 na resposta.

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