get_audience · Documentation Subagent

En bref

Propriété	Valeur
Titre	Lire une audience
Outil MCP	`get_audience`, sur `https://api.subagent.fr/mcp`
Appel HTTP	`POST https://api.subagent.fr/v1/get_audience`
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 :

Contacts d’une audience, 200 par page ; reprendre à next_offset. Champs personnalisés et tags sont conservés.

Paramètres

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

Paramètre	Type	Obligatoire	Description
`audience_id`	identifiant `aud_…`	oui	Audience.
`offset`	entier	non	De 0 à 100000.

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
`audience`	objet	Une audience : id (aud_…), name, source (subagent, ou l’outil d’où elle est reprise), `external_id`, contacts (leur nombre, dans `list_audiences`), `created_at`, `updated_at`.
`items`	liste	Les contacts de la page, 200 au plus : email, name, fields, labels, `created_at`.
`next_offset`	entier ou `null`	Le rang de la page suivante (offset), ou `null`.

Exemple d’appel

Les valeurs sont fictives.

HTTP

curl -X POST https://api.subagent.fr/v1/get_audience \
  -H "Authorization: Bearer $SUBAGENT_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "audience_id": "aud_3c8f1a5e9d2b47c6a0e4f81b7d5c9e26"
}'

MCP · tools/call

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "get_audience",
    "arguments": {
      "audience_id": "aud_3c8f1a5e9d2b47c6a0e4f81b7d5c9e26"
    }
  }
}

Refus possibles

Code	HTTP	Ce qui s’est passé	Que faire
`audience_scope`	403	Les audiences demandent 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.

`get_audience`