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

Um token de string usado para paginação para recuperar resultados após um ponto específico. Geralmente, é usado para buscar 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. Cada grupo de filtros contém vários filtros que são aplicados em conjunto.

limit
integer<int32>
obrigatório

Um número inteiro que indica o número máximo de resultados a serem retornados. Isso ajuda a controlar o tamanho da resposta.

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

Uma matriz de strings que especifica a ordem de classificação dos resultados da pesquisa. Cada string representa um nome de propriedade seguido por uma direção (por exemplo, 'propertyName ASC' ou 'propertyName DESC').

query
string

Uma string que representa uma consulta de pesquisa para corresponder às propriedades do objeto.

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 público simples retornado 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