Leer la libreta de direcciones

GET /api/v1/settings/identities Todas las direcciones de remitente que esta organización puede usar, la predeterminada primero: es la que firma campañas, secuencias y confirmaciones de opt-in. Las demás están registradas y listas; no envían nada hasta que se promueven.

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

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:
CampoTipoDescripción
successbooleanIndica si la operación tuvo éxito
data[].idstringIdentificador que pasar como sendingIdentityId en una campaña
data[].senderEmailstringLa dirección en sí
data[].senderNamestring \null
data[].isDefaultbooleanExactamente una dirección lleva true
data[].createdAtstringFecha ISO en que se añadió la dirección
paginationobject{total, page, limit, totalPages}

Ejemplo de respuesta

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"}
  ]
}

Relacionado