Lire un domaine

GET /api/v1/domains/{domainId} Un domaine avec son statut de vérification et les enregistrements DNS à publier. Un domainId appartenant à une autre organisation répond 404, jamais 403.

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
`domainId`	string	Obligatoire. Le domaine à lire

Exemple

bash

curl -H "x-api-key: $AGENTMAIL_API_KEY" \
  "https://www.agentsmail.io/api/v1/domains/$DOMAIN_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 — aucune ressource de ce type, 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 du domaine déclaré
`data.domain`	string	Le domaine lui-même
`data.dkimStatus`	string	`PENDING`, `SUCCESS` ou `FAILED` — les clés de signature
`data.mailFromStatus`	string \	null
`data.mailFromDomain`	string \	null
`data.verified`	boolean	La seule question qui décide de l'envoi : DKIM `SUCCESS` et propriété prouvée
`data.ownershipProved`	boolean	Indique lequel des deux gestes manque encore
`data.lastCheckedAt`	string \	null
`data.sesUnavailable`	boolean	`true` signifie que vous lisez le dernier état connu, pas la vérité actuelle
`data.dnsRecords`	array	Les enregistrements à publier — `{type, name, value, purpose}`

Exemple de réponse

json

{
  "success": true,
  "data": {
    "id": "4d19c0a2",
    "domain": "mail.example.com",
    "dkimStatus": "SUCCESS",
    "mailFromStatus": "SUCCESS",
    "mailFromDomain": "bounce.mail.example.com",
    "verified": true,
    "ownershipProved": true,
    "lastCheckedAt": "2026-08-23T10:22:05.000Z",
    "sesUnavailable": true,
    "dnsRecords": [
      {
        "type": "CNAME",
        "name": "abc123._domainkey.mail.example.com",
        "value": "abc123.dkim.amazonses.com",
        "purpose": "dkim"
      }
    ]
  }
}