Skip to main content
POST
Recherche

Supported products

Autorisations

Authorization
string
header
requis

The access token received from the authorization server in the OAuth 2.0 flow.

Corps

application/json

Décrit une demande de recherche

after
string
requis

Une chaîne de caractères représentant le jeton de curseur de pagination. Il est utilisé pour récupérer l'ensemble de résultats suivant après la page actuelle.

filterGroups
object[]
requis

Un tableau de groupes de filtres utilisé pour définir les critères de recherche. Chaque groupe de filtres contient des filtres qui déterminent quels objets CRM sont inclus dans les résultats de recherche.

limit
integer<int32>
requis

Un entier indiquant le nombre maximal de résultats à renvoyer par page. Cette propriété contrôle la pagination des résultats de recherche.

properties
string[]
requis

Un tableau de chaînes spécifiant les propriétés des objets CRM à renvoyer dans les résultats de recherche. Si une propriété spécifiée n'est pas présente sur les objets, elle sera ignorée.

sorts
string[]
requis

Un tableau de chaînes spécifiant l'ordre de tri des résultats de recherche. Chaque chaîne représente une propriété par laquelle les résultats doivent être triés.

query
string

Une chaîne de caractères représentant une requête de recherche pour filtrer les objets CRM. Ce champ facultatif peut être utilisé pour effectuer une recherche textuelle.

Réponse

successful operation

Représente une liste d'objets simples renvoyés par une requête API, ainsi que le nombre total d'objets disponibles.

results
object[]
requis

Un tableau contenant les objets publics simples renvoyés dans la réponse actuelle.

total
integer<int32>
requis

Le nombre de résultats disponibles

paging
object

Représente les informations de pagination pour naviguer dans une liste de résultats de l'API. Il fournit des détails sur la manière d'accéder à l'ensemble de résultats précédent ou suivant.

Dernière modification le 6 octobre 2026