Documentation › Outils › list_contacts
list_contacts
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 |
|---|---|
| Titre | Lister les contacts |
| Outil MCP | list_contacts, sur https://api.subagent.fr/mcp |
| Appel HTTP | POST https://api.subagent.fr/v1/list_contacts |
| Accès | permission read |
| État de l’espace | vérifié ou non |
| Effet | lecture seule |
| Vue dans l’assistant | oui : 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ètre | Type | Obligatoire | Description |
|---|---|---|---|
query | texte | non | Recherche dans l’adresse, le nom et les champs. 300 caractères au plus. |
label | texte | non | Tag exact. 80 caractères au plus. |
audience_id | identifiant aud_… | non | Limiter à une audience de l’espace. |
subscription | texte | non | subscribed : aucun blocage connu (pas une preuve de consentement). unsubscribed : désinscription. blocked : autre blocage effectif. |
offset | entier | non | De 0 à 100000. |
limit | entier | non | De 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.
| Champ | Type | Contenu |
|---|---|---|
items | liste | Les 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_offset | entier ou null | Le rang de la page suivante, ou null. |
total | entier | Le 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
| Code | HTTP | Ce qui s’est passé | Que faire |
|---|---|---|---|
contact_scope | 403 | Le 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.