API ReferenceDocumentation APIToken PortailContacts

Rechercher des contacts

Afficher en MarkdownOuvrir dans Claude
Recherche dans tous les contacts. <Note title="Rôle requis"> Aucun. Autorisés : le propriétaire. </Note>

Authentification

AuthorizationBearer

Authentification Bearer par jeton utilisateur ou jeton d’accès : Authorization: Bearer <token>.

Paramètres de requête

textstringOptionnel

Le texte à rechercher.

items.idstringOptionnel
La ou les valeurs de filtre du champ id.
items.tenantIdstringOptionnel
La ou les valeurs de filtre du champ tenantId.
items.userIdstringOptionnel
La ou les valeurs de filtre du champ userId.
items.namestringOptionnel
La ou les valeurs de filtre du champ name.
items.emailstringOptionnel
La ou les valeurs de filtre du champ email.
items.phoneNumberstringOptionnel
La ou les valeurs de filtre du champ phoneNumber.
items.firstNamestringOptionnel
La ou les valeurs de filtre du champ firstName.
items.lastNamestringOptionnel
La ou les valeurs de filtre du champ lastName.
items.countrystringOptionnel
La ou les valeurs de filtre du champ country.
items.createdstringOptionnel
La ou les valeurs de filtre du champ created.
items.updatedstringOptionnel
La ou les valeurs de filtre du champ updated.
sortBystringOptionnel

Le champ utilisé pour trier le résultat de la recherche.

sortOrderenumOptionnel

L’ordre de tri du résultat de la recherche.

Valeurs autorisées:
itemsPerPageintegerOptionnel1-50Par défaut 50

Le nombre d’éléments par page à renvoyer.

pageIndexintegerOptionnel>=0Par défaut 0

L’index de la page à renvoyer.

Réponse

Une page d’entités Contact.

pageIndexintegerOptionnel
L'index de la page.
itemsPerPageintegerOptionnel

Le nombre d’éléments par page.

totalItemsintegerOptionnel

Le nombre total d’éléments, toutes pages comprises.

itemslist of objectsOptionnel

Erreurs

400
Bad Request Error
403
Forbidden Error