Listar dominios y registros

GET /api/v1/domains Todos los dominios declarados por la organización, con su estado de verificación y los registros DNS que quedan por publicar. Los registros nunca se guardan: se vuelven a leer del proveedor en cada llamada, porque cambian si la identidad se vuelve a crear.

Autorización

Rol en la organizaciónEste endpoint
OWNERPermitido
ADMINPermitido
MEMBERPermitido
Una clave lleva el rol que su creador tiene en esta organización, nunca un rol en AgentsMail en sí. Consulta Claves de API.

Ejemplo

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

Respuesta

  • 200 OK: la llamada tuvo éxito.
  • 401 Unauthorized: clave ausente o no válida, o su propietario dejó la organización.
  • 429 Too Many Requests: más de 120 peticiones en un minuto para esta clave.

Campos de la respuesta

data es un array de:
verified responde a la única pregunta que importa. DKIM prueba que el dominio puede firmar; el desafío TXT prueba que esta organización es su propietaria. Un dominio puede estar en dkimStatus: "SUCCESS" y seguir bloqueando, con ownershipProved: false.
CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data[].idstringIdentificador del dominio declarado
data[].domainstringEl dominio en sí
data[].dkimStatusstringPENDING, SUCCESS o FAILED: las claves de firma
data[].mailFromStatusstring \null
data[].mailFromDomainstring \null
data[].verifiedbooleanLa única pregunta que decide el envío: DKIM en SUCCESS y propiedad probada
data[].ownershipProvedbooleanCuál de los dos gestos falta todavía
data[].lastCheckedAtstring \null
data[].sesUnavailablebooleantrue significa que estás leyendo el último estado conocido, no la verdad actual
data[].dnsRecordsarrayLos registros que publicar: {type, name, value, purpose}
paginationobject{total, page, limit, totalPages}

Ejemplo de respuesta

json
{
  "success": true,
  "data": [
    {
      "id": "b71f…",
      "domain": "mail.example.com",
      "dkimStatus": "SUCCESS",
      "mailFromStatus": "SUCCESS",
      "mailFromDomain": "bounce.mail.example.com",
      "verified": true,
      "ownershipProved": true,
      "lastCheckedAt": "2026-08-23T09:41:02.000Z",
      "sesUnavailable": false,
      "dnsRecords": [
        {"type": "CNAME", "name": "abc123._domainkey.mail.example.com", "value": "abc123.dkim.amazonses.com", "purpose": "dkim"},
        {"type": "TXT", "name": "_agentmail-challenge.mail.example.com", "value": "agentmail-verify=9f2c…", "purpose": "ownership"}
      ]
    }
  ]
}

Relacionado