Lister les modèles

GET /api/v1/templates Chaque modèle porte id, name, defaultSubject, content et ses dates createdAt / updatedAt. Rien d'autre.

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.

Paramètres de requête

ParamètreTypeDescription
searchstringCherche dans le nom du modèle, sans tenir compte de la casse
pagenumberVaut 1 par défaut
limitnumberVaut 20 par défaut, plafonné à 100

Exemple

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/templates?search=newsletter"

Réponse

  • 200 OK — l'appel a réussi.
  • 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
data[].idstringIdentifiant unique du modèle
data[].namestringNom du modèle
data[].defaultSubjectstringObjet dont hérite une campagne, et qu'elle peut remplacer
data[].contentstringLe document HTML complet
data[].createdAtstringDate de création ISO
data[].updatedAtstringDate ISO de la dernière modification
paginationobject{total, page, limit, totalPages}

Exemple de réponse

json
{
  "success": true,
  "data": [
    {
      "id": "4d19c0a2",
      "name": "Newsletter",
      "defaultSubject": "August news",
      "content": "<html>…</html>",
      "createdAt": "2026-08-23T10:22:05.000Z",
      "updatedAt": "2026-08-23T10:22:05.000Z"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Voir aussi