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.

Parâmetros de caminho

objectType
string
obrigatório

O tipo de objeto do CRM a ser pesquisado, como contatos, empresas ou negócios.

Corpo

application/json

Descreve uma solicitação de pesquisa

after
string
obrigatório

Uma string que representa o token do cursor de paginação para recuperar resultados após um ponto específico.

filterGroups
object[]
obrigatório

Matriz de objetos FilterGroup que definem os critérios de filtragem para a pesquisa.

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

Uma string que representa a consulta de pesquisa a ser aplicada 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

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