Lister les médias

GET /api/v1/media Tous les médias de l'organisation, les plus récents d'abord. Contrairement aux autres listes de cette référence, la couche de stockage qui contient les médias ne renvoie jamais de total — cet endpoint pagine avec hasMore au lieu d'une paire page/total.

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
folderstringRestreint la liste à un sous-dossier. Facultatif, la racine par défaut
searchstringFiltre sur le nom du fichier, sans tenir compte de la casse. Facultatif
limitnumberÉléments par page, 24 par défaut, plafonné à 100
offsetnumberÉléments à sauter, 0 par défaut

Exemple

bash
curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/media?folder=newsletter&limit=10"

Réponse

  • 200 OK — les médias, accompagnés de hasMore.
  • 400 Bad Request — folder ne se compose pas de lettres minuscules, de chiffres et de tirets.
  • 401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.

Champs de la réponse

ChampTypeDescription
successbooleanIndique si l'opération a réussi
data.itemsarrayLes médias
data.items[].pathstringL'identifiant du média — passez-le à Supprimer un média pour retirer ce fichier
data.items[].urlstringURL publique — un client de messagerie n'est jamais authentifié
data.items[].namestringNom du fichier
data.items[].sizenumberTaille du fichier en octets
data.items[].typestringType MIME
data.items[].createdAtstringDate de création ISO
data.items[].folderstringSous-dossier, absent à la racine de la médiathèque
data.hasMorebooleantrue s'il existe une page au-delà de limit + offset
data.limitnumberLe limit réellement appliqué
data.offsetnumberL'offset réellement appliqué

Exemple de réponse

json
{
  "success": true,
  "data": {
    "items": [
      {
        "path": "organizations/7c2e…/media/newsletter/logo-1703123456789.jpg",
        "url": "https://…/logo-1703123456789.jpg",
        "name": "logo-1703123456789.jpg",
        "size": 48213,
        "type": "image/jpeg",
        "createdAt": "2026-08-29T10:00:00.000Z",
        "folder": "newsletter"
      }
    ],
    "hasMore": false,
    "limit": 24,
    "offset": 0
  }
}

Remarques

  • Il n'y a pas de pagination.total. La couche de stockage sur laquelle repose cette médiathèque ne sait pas compter sans tout lister — paginez avec offset et arrêtez-vous quand hasMore vaut false.

Voir aussi