Obtenir une liste

GET /api/v1/lists/{listId} Une liste.

bash

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

Le détail ne porte pas de contactCount : le décompte n'est calculé que dans la liste. Une liste qui n'existe pas, une liste que vous avez supprimée et une liste appartenant à une autre organisation répondent toutes 404 — l'API ne vous dit jamais qu'un identifiant existe quand il n'est pas à vous, et une liste supprimée n'est plus adressable.

Autorisation

Rôle dans l'organisation	Cet endpoint
`OWNER`	Autorisé
`ADMIN`	Autorisé
`MEMBER`	Autorisé

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 chemin

Paramètre	Type	Description
`listId`	string	Obligatoire. La liste à lire

Exemple

bash

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

Réponse

200 OK — l'appel a réussi.
401 Unauthorized — clé absente ou invalide, ou son propriétaire a quitté l'organisation.
404 Not Found — ressource inexistante, ou vous l'avez supprimée, ou elle appartient à une autre organisation. L'API ne confirme jamais qu'un identifiant existe à un appelant qui n'y a pas droit.
429 Too Many Requests — plus de 120 requêtes en une minute pour cette clé.

Champs de la réponse

Champ	Type	Description
`success`	boolean	Indique si l'opération a réussi
`data.id`	string	Identifiant de la liste
`data.name`	string	Son nom
`data.contactCount`	number	Contacts qu'elle contient
`data.createdAt` / `updatedAt`	string	Dates ISO

Exemple de réponse

json

{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "name": "Newsletter",
    "contactCount": 128,
    "createdAt` / `updatedAt": "value"
  }
}

Remarques

Supprimer une liste dans l'interface la fait répondre 404 ici, immédiatement et définitivement. Rien n'est effacé côté rapports : les campagnes qui lui ont été envoyées conservent leurs statistiques et leurs destinataires.