Lister les contacts avec l'API Freshdesk
Liste les contacts, les clients qui ouvrent des tickets, avec id, name, email, phone, mobile, company_id, tags et custom_fields. Les filtres se combinent.
- Identifiant
- freshdesk_list_contacts
L'appel
POST https://connect.reportei.com/api/tools/freshdesk_list_contacts/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json
{
"customer_toolkit": "<connection UUID>",
"arguments": {
"email": "<email>"
}
}Votre système envoie l'id de la connexion de votre client et les arguments de la tool. Les headers sont les mêmes que pour toute l'API Connect : le token de votre produit et celui de votre client.
Paramètres
Les descriptions des paramètres suivent la documentation officielle de l'app, en anglais.
| Paramètre | Type | Obligatoire | Description |
|---|---|---|---|
| string | Non | Only the contact with this email address. | |
| mobile | string | Non | Only contacts with this mobile number. |
| phone | string | Non | Only contacts with this phone number. |
| company_id | integer | Non | Only the contacts of this company, from Search companies. |
| state | string | Non | Only contacts in this state.Valeurs : blocked, deleted, unverified, verified |
| updated_since | string | Non | Only contacts updated at or after this UTC time, for example 2026-10-01T00:00:00Z. |
| page | integer | Non | Page number, starting at 1. |
| per_page | integer | Non | Contacts per page, up to 100. The default is 30. |
Connexions possibles
Votre client connecte son compte Freshdesk une seule fois, avec l'un des modes ci-dessous. La même connexion sert à toutes les tools du toolkit.
Identifiant et mot de passe
Votre client saisit les identifiants de l'app sur un écran de Connect, ou votre système les envoie avec POST /api/customer-toolkits, sans écran.
À la connexion, votre client indique aussi {domain} : l'adresse de son compte sur l'API de l'app.
La réponse
En cas de succès, Connect conserve le statut et le corps de la réponse de l'app. Les erreurs HTTP renvoyées par l'app utilisent l'objet {error, api_error} ; l'authentification ou la validation peuvent échouer avant l'exécution. Le header X-Toolkit-Execution-Id identifie l'exécution enregistrée, consultable avec GET /api/tools/executions/{uuid}.
Prête pour les agents IA
L'input de cette tool est un JSON Schema, disponible via GET /api/tools/freshdesk_list_contacts. Il devient la définition de tool de votre agent sans conversion.
Autres tools Freshdesk
- Lister les ticketsGETListe les tickets, les plus récents d'abord par défaut. Sans updated_since seuls les tickets créés dans les 30 derniers jours reviennent, et spam ou supprimés ne viennent qu'avec un filtre.
- Rechercher des ticketsGETRecherche des tickets avec une query de filtre, par exemple par statut, priorité, agent, groupe, tag ou champ personnalisé. Renvoie total et results, 30 tickets par page.
- Obtenir un ticketGETRenvoie un ticket avec status, priority, requester_id, responder_id, group_id, tags, custom_fields et description.
- Créer un ticketPOSTCrée un ticket. Identifiez le demandeur avec requester_id, email, phone ou unique_external_id ; un email ou phone absent de Freshdesk crée le contact.
- Mettre à jour un ticketPUTMet à jour un ticket : envoyez uniquement les champs à changer, et tags comme la liste complète que le ticket doit garder. Status 4 le résout et 5 le ferme.
- Lister les conversations d'un ticketGETListe les réponses et notes d'un ticket, avec body (HTML), body_text, private, incoming, user_id et source (0 réponse, 2 note). Les pages sont numérotées à partir de 1.
- Créer une réponse de ticketPOSTRépond au demandeur d'un ticket. Freshdesk envoie la réponse par e-mail au demandeur, elle est donc visible du client.
- Créer une note de ticketPOSTAjoute une note à un ticket. Les notes sont privées par défaut, visibles des agents seulement ; avec private à false le demandeur la voit aussi.
Toolkits de la même catégorie
Voir les 100 toolkitsVoyez Connect appliqué à votre produit.
Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.
