Rechercher des entreprises avec l'API Freshdesk

Trouve des entreprises par nom et renvoie l'id et le name de chacune, le company_id que prennent tickets et contacts.

Identifiant
freshdesk_search_companies

L'appel

POST https://connect.reportei.com/api/tools/freshdesk_search_companies/execute
Authorization: Bearer <merchant token>
x-customer-token: <customer token>
Content-Type: application/json
Accept: application/json

{
  "customer_toolkit": "<connection UUID>",
  "arguments": {
    "name": "<name>"
  }
}

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ètreTypeObligatoireDescription
namestringOuiStart of a word of the company name, case insensitive. Acme Corporation matches acme or corp, not cme.

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_search_companies. Il devient la définition de tool de votre agent sans conversion.

Autres tools Freshdesk

Voir les 13 tools

Toolkits de la même catégorie

Voir les 100 toolkits

Voyez Connect appliqué à votre produit.

Essayez-le pendant 15 jours sans carte, ou présentez votre cas à notre équipe.