Saltar al contenido principal

Obtener un correo

GET/v1/mails/{mail_id}

Descripción

Retorna el detalle de un mail por su mail_id. A diferencia de GET /v1/mails, esta consulta no aplica la ventana de 3 meses como filtro: cualquier mail disponible en línea se encuentra por su id, sin enviar rango de fechas. La disponibilidad sí la gobierna la retención: un mail_id anterior a la ventana de retención en línea responde 404 con code mail_outside_retention.

Autenticación

Authorizationbearer tokenheaderobligatorio
API key con scope mail:read. Formato: Bearer FD.<key_id>.<token>.
X-Instance-Slugstringheaderobligatorio

Request

Path params:

mail_idstring
Identificador del mail, devuelto por `GET /v1/mails`.

Response

200 OKDevuelve un objeto con los campos que siguen.
mail_idstringobligatorio
Identificador del mail.
msg_idstring | null
Identificador del mensaje lógico (compartido entre destinatarios de un mismo envío).
tostringobligatorio
Email del destinatario (uno por fila - ver Descripción).
subjectstringobligatorio
Asunto.
senderstring | null
Email del remitente. null cuando el mail no tiene un remitente registrado.
statusinteger | null
Estado de entrega: 1=received, 2=queued, 3=sent, 4=dropped, 5=deferred, 6=bounced, 7=onhold.
opensintegerobligatorio
Cantidad de aperturas registradas.
clicksintegerobligatorio
Cantidad de clicks registrados.
received_atstring (date-time) | null
Fecha y hora de recepción.
queued_atstring (date-time) | null
Fecha y hora de encolado en el MTA.
sent_atstring (date-time) | null
Fecha y hora de entrega al MX del destinatario.
schedule_atstring (date-time) | null
Fecha y hora programada de envío, si aplica.
delaynumber | null
Demora de entrega en segundos, desde la recepción hasta sent_at.
custom_msg_idstring | null
Identificador personalizado del mensaje.
custom_group_codestring | null
Código de grupo personalizado.
Nota

Mismos campos que GET /v1/mails.

Errores

CódigoCuándo
404No existe un mail con ese mail_id en la instancia (mail_not_found).
404El mail_id es anterior a la ventana de retención en línea (mail_outside_retention) - el mail ya no está disponible, aunque haya existido.

Detalle en Errores genéricos y Errores genéricos.

Request
curl -X GET "https://$API_HOST/v1/mails/0190abc..." \
-H "Authorization: Bearer $API_KEY" \
-H "X-Instance-Slug: $SLUG"
Response
{
"mail_id": "0190...",
"msg_id": "0190...",
"to": "alice@example.com",
"subject": "Hello from Fidelizador",
"sender": "newsletter@example.com",
"status": 3,
"opens": 1,
"clicks": 0,
"received_at": "2026-05-08T14:22:31Z",
"queued_at": "2026-05-08T14:22:32Z",
"sent_at": "2026-05-08T14:22:33Z",
"schedule_at": null,
"delay": 2.4,
"custom_msg_id": null,
"custom_group_code": null
}