Lire le carnet d'adresses

GET /api/v1/settings/identities Toutes les adresses d'expéditeur que cette organisation peut utiliser, celle par défaut en premier — c'est elle qui signe les campagnes, les séquences et les confirmations d'opt-in. Les autres sont enregistrées et prêtes ; elles n'envoient rien tant qu'elles ne sont pas promues.

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/settings/identities"

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

data est un tableau de :
ChampTypeDescription
successbooleanIndique si l'opération a réussi
data[].idstringIdentifiant à passer comme sendingIdentityId sur une campagne
data[].senderEmailstringL'adresse elle-même
data[].senderNamestring \null
data[].isDefaultbooleanExactement une adresse porte true
data[].createdAtstringDate ISO d'ajout de l'adresse
paginationobject{total, page, limit, totalPages}

Exemple de réponse

json
{
  "success": true,
  "data": [
    {"id": "8f1c…", "senderEmail": "hello@mail.example.com", "senderName": "Example", "isDefault": true, "createdAt": "2026-05-02T09:12:44.000Z"},
    {"id": "2ad9…", "senderEmail": "news@mail.example.com", "senderName": "Example News", "isDefault": false, "createdAt": "2026-06-18T14:03:11.000Z"}
  ]
}

Voir aussi