Pular para o conteúdo principal
POST
Pesquisar objetos

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

String que representa o token do cursor de paginação. É usada para buscar o próximo conjunto de resultados em uma resposta paginada.

filterGroups
object[]
obrigatório

Uma matriz de grupos de filtros usado para especificar os critérios de filtragem dos resultados da pesquisa. Cada grupo de filtros contém um conjunto de filtros que são combinados usando operações lógicas AND.

limit
integer<int32>
obrigatório

Número inteiro que indica o número máximo de resultados a serem retornados. Isso limita o número de objetos incluídos nos resultados da pesquisa.

properties
string[]
obrigatório

Matriz de strings que especifica as propriedades a serem incluídas nos resultados da pesquisa. Somente as propriedades especificadas serão retornadas para cada objeto.

sorts
string[]
obrigatório

Uma matriz de strings que define a ordem de classificação dos resultados da pesquisa. Cada string especifica uma propriedade para classificar, opcionalmente seguida por "ASC" ou "DESC" para indicar ordem crescente ou decrescente.

query
string

String que representa uma consulta de pesquisa para corresponder aos objetos do CRM. Essa consulta é usada para realizar uma pesquisa de texto completo em 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 individual na coleção.

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