Parcourir le catalogue

GET /api/v1/template-gallery Les modèles arrivent dans l'ordre du catalogue — position, puis name.
json
{
  "success": true,
  "data": [
    {
      "id": "…",
      "name": "Plain letter",
      "description": "A one-column letter",
      "defaultSubject": "News of the month",
      "content": "<html>…</html>",
      "previewImageUrl": "https://…/plain-letter.png",
      "colorScheme": "fixed",
      "position": 3,
      "createdAt": "…",
      "updatedAt": "…"
    }
  ],
  "pagination": {"total": 1, "page": 1, "limit": 20, "totalPages": 1}
}
colorScheme est lu dans le HTML à chaque requête, jamais stocké : adaptive signifie que le modèle porte ses propres règles de mode sombre, fixed qu'il a le même aspect partout. Si vous modifiez votre copie plus tard, cette réponse porte sur le modèle dont vous êtes parti — pas sur ce que vous en avez fait.

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
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/template-gallery"

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 du catalogue
data[].namestringSon nom
data[].defaultSubjectstringL'objet fourni avec lui
data[].thumbnailUrlstringnull
paginationobject{total, page, limit, totalPages}

Exemple de réponse

json
{
  "success": true,
  "data": [
    {
      "id": "4d19c0a2",
      "name": "Newsletter",
      "defaultSubject": "August news",
      "thumbnailUrl": "value"
    }
  ],
  "pagination": {
    "total": 1,
    "page": 1,
    "limit": 20,
    "totalPages": 1
  }
}

Voir aussi