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 usada como um token de cursor de paginação para recuperar resultados após um ponto específico.

filterGroups
object[]
obrigatório

Matriz de grupos de filtros usada para especificar os critérios de filtragem de objetos do CRM.

limit
integer<int32>
obrigatório

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

properties
string[]
obrigatório

Uma matriz de strings que especifica quais propriedades dos objetos do CRM devem ser incluídas nos resultados da pesquisa.

sorts
string[]
obrigatório

Matriz de strings que indica as propriedades pelas quais os resultados da pesquisa devem ser classificados.

query
string

String que representa a consulta de pesquisa a ser correspondida com as propriedades do objeto 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

Matriz de itens SimplePublicObject, cada um representando um objeto do CRM com propriedades básicas.

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