Skip to main content
GET
/
v1
/
email
/
messages
Listar e-mails
curl --request GET \
  --url https://api.notifique.dev/v1/email/messages \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "data": [
    {
      "id": "clxx123...",
      "to": "cliente@example.com",
      "from": "noreply@seudominio.com",
      "fromName": "Suporte",
      "subject": "Confirmação",
      "status": "SENT",
      "scheduledFor": null,
      "sentAt": "2025-02-16T12:00:00.000Z",
      "deliveredAt": null,
      "failedAt": null,
      "errorMessage": null,
      "createdAt": "2025-02-16T11:59:58.000Z"
    }
  ],
  "pagination": {
    "total": 42,
    "page": 1,
    "limit": 20,
    "totalPages": 3
  }
}

Authorizations

Authorization
string
header
required

API Key no header Authorization. Exemplo: Authorization: Bearer sk_live_xxxxx

Query Parameters

page
string

Página (padrão 1).

limit
string

Itens por página (padrão 20, máx. 100).

fromDate
string<date-time>

Início do intervalo (filtro em createdAt, inclusive).

toDate
string<date-time>

Fim do intervalo (filtro em createdAt, inclusive).

status
string

Um ou mais status separados por vírgula: QUEUED, SCHEDULED, PROCESSING, SENT, DELIVERED, OPENED, CLICKED, FAILED, CANCELLED, COMPLAINED. Valores inválidos são ignorados.

emailDomainId
string

Filtra pelo ID (cuid) do domínio de envio; deve pertencer ao workspace. Alternativa: email_domain_id.

email_domain_id
string

Alias de emailDomainId.

Response

Lista de e-mails e paginação.

success
boolean
required
Example:

true

data
object[]
required

Cada item tem os mesmos campos que GET /v1/email/messages/{id} em data. Não inclui corpo (html/text), emailDomainId, externalId nem providerUsed.

pagination
object
required