Endpoint
Autenticación
Authorization: Bearer <clave API>
Descripción
Devuelve una lista de todos los emails enviados.
Parámetros
Nombre | Tipo | Descripción |
domainId | String | ID de dominio. Requerido. |
limit | Integer | Registros por página. Por defecto: 10. Máximo: 100. |
page | Integer | Número de página. Por defecto: 1. |
sort | String | Ordenar por: created_date, from, to, subject. Por defecto: created_date. |
direction | String | Ordenamiento: asc (ascendente), desc (descendente). Por defecto: asc. |
filters | String | Expresión para filtrar registros. Ejemplos: {"status": "excluded"} filtra por estado excluido; {"created_date":{"$gt":{"$ts":1711971302}}} filtra por fecha mayor a; {"to":{"$regex":"prueba"}} filtra por destinatario que contenga "prueba". |
Respuesta
Campo | Descripción |
id | ID del email |
created_date | Fecha de creación (UTC+00:00) |
from | Remitente |
to | Destinatario |
subject | Asunto |
status | Estado: processed, sent, rejected, failed, excluded |
type | Formato: text (texto plano), html |
channel | Canal de envío: http (API), smtp, preview |
Errores
Error | Descripción |
domain_required | El dominio es requerido |
domain_not_allowed | No existe el dominio informado |
invalid_direction | Tipo de ordenamiento incorrecto |
invalid_page | Número de página incorrecto — debe ser entero positivo |
invalid_limit | Cantidad de registros incorrecta — debe ser entero positivo |
malformed_filter | Expresión de filtro incorrecta |
Ejemplo de respuesta
{
"page": 1,
"limit": 20,
"total": 2,
"payload": [
{
"id": "661d0e4cf0f90d40880a5589",
"created_date": "2024-04-15T11:23:56+00:00",
"from": "\"Empresa\" <[email protected]>",
"to": "[email protected]",
"subject": "Recibimos la documentación!",
"status": "sent",
"type": "html",
"channel": "http"
},
{
"id": "661d0f6b6a351e9936375e02",
"created_date": "2024-04-15T11:28:43+00:00",
"from": "\"Empresa\" <[email protected]>",
"to": "[email protected]",
"subject": "Confirmación de pedido",
"status": "sent",
"type": "text",
"channel": "http"
}
]
}