Aller au contenu
subagentdocs
Sommaire de la documentation

Documentation › Outils › list_contacts

list_contacts

Voir en .md

Répertoire global de l’espace, indépendant des audiences : recherche, tags, appartenance et désinscription ou autre blocage effectif.

En bref

PropriétéValeur
TitreLister les contacts
Outil MCPlist_contacts, sur https://api.subagent.fr/mcp
Appel HTTPPOST https://api.subagent.fr/v1/list_contacts
Accèspermission read
État de l’espacevérifié ou non
Effetlecture seule
Vue dans l’assistantoui : voir Vues

Ce que fait l’outil

Le serveur décrit l’outil ainsi à l’agent qui se branche :

Répertoire global de l’espace, indépendant des audiences : recherche, tags, appartenance et désinscription ou autre blocage effectif. Accès à toutes les boîtes requis. Aucun envoi.

Paramètres

list_contacts accepte ces paramètres. Un paramètre inconnu est refusé avec le code invalid_argument.

ParamètreTypeObligatoireDescription
querytextenonRecherche dans l’adresse, le nom et les champs. 300 caractères au plus.
labeltextenonTag exact. 80 caractères au plus.
audience_ididentifiant aud_…nonLimiter à une audience de l’espace.
subscriptiontextenonsubscribed : aucun blocage connu (pas une preuve de consentement). unsubscribed : désinscription. blocked : autre blocage effectif.
offsetentiernonDe 0 à 100000.
limitentiernonDe 1 à 200.

Résultat

L’outil rend un texte lisible en français et un objet structuré (structuredContent). En HTTP, la réponse est cet objet.

ChampTypeContenu
itemslisteLes fiches de la page : adresse, nom, champs, tags, audiences, état d’inscription. Chaque élément porte audiences, created_at, email, fields, labels, name, suppression, updated_at.
next_offsetentier ou nullLe rang de la page suivante, ou null.
totalentierLe nombre de fiches qui répondent à la recherche.

Exemple d’appel

Les valeurs sont fictives.

HTTP

curl -X POST https://api.subagent.fr/v1/list_contacts \
  -H "Authorization: Bearer $SUBAGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "query": "atelier",
  "subscription": "subscribed"
}'

MCP · tools/call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "list_contacts",
    "arguments": {
      "query": "atelier",
      "subscription": "subscribed"
    }
  }
}

Refus possibles

CodeHTTPCe qui s’est passéQue faire
contact_scope403Le répertoire des contacts demande un accès à toutes les boîtes de l’espace ; cette clé est limitée à certaines.Passer par une clé qui accède à tout l’espace, ou par l’assistant de l’humain.

S’y ajoutent les refus communs à tous les outils (unauthorized, forbidden, invalid_argument, rate_limited, internal) : voir Erreurs.

Voir aussi

Cette page en Markdown : /docs/reference/list_contacts.md Toute la documentation pour un agent : /llms.txt Mentions légales · Conditions de vente · Confidentialité · Signaler un abus