Lister les sujets

GET /api/v1/topics Tous les sujets de l'organisation. C'est l'appel qui vous donne le topicId qu'exige chaque autre appel sur les sujets, et sa lecture est ouverte à tous les rôles — agir sur un sujet ne l'est pas. La liste est complète : elle n'a ni pagination ni recherche.

Autorisation

Rôle dans l'organisationCet endpoint
OWNERAutorisé
ADMINAutorisé
MEMBERAutorisé
Une clé porte le rôle que son créateur détient dans cette organisation — jamais un rôle sur AgentsMail lui-même. Voir Clés d'API.

Exemple

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/topics"

Réponse

  • 200 OK — les sujets, triés par nom. Une organisation qui n'en a aucun répond un tableau vide.
  • 401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
  • 429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

ChampTypeDescription
successbooleanIndique si l'opération a réussi
dataarrayLes sujets
data[].idstringIdentifiant unique — c'est le topicId utilisé partout ailleurs
data[].namestringNom du sujet, unique dans l'organisation
data[].createdAtstringDate de création ISO
data[].updatedAtstringDate ISO de la dernière modification

Exemple de réponse

json
{
  "success": true,
  "data": [
    {
      "id": "7c2e4b19",
      "name": "freelancing",
      "createdAt": "2026-03-04T08:11:00.000Z",
      "updatedAt": "2026-08-01T10:42:19.000Z"
    }
  ]
}

Remarques

  • Ni ?search= ni pagination ici. Toute la liste revient en un seul appel — filtrez-la de votre côté.
  • Renommer un sujet est sans risque : campagnes, séquences et refus référencent tous l'identifiant, jamais le nom.

Voir aussi