> ## Documentation Index
> Fetch the complete documentation index at: https://docs.notifique.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Listar mensajes correo

> Muestra el historial de correo enviados. Puedes filtrar por fecha y estado.



## OpenAPI

````yaml /es/emails-api/api-reference/openapi-email.json get /v1/email/messages
openapi: 3.0.3
info:
  title: 'Notificar a la API: correo electrónico'
  description: >-
    Envíe correos, gestione dominios y consulte el estado. Autentíquese con
    `Authorization: Bearer sk_live_...` o `x-api-key`.
  version: 1.0.0
servers:
  - url: https://api.notifique.dev
    description: Producción
security:
  - ntfEmailBearerAuth: []
  - ntfEmailApiKeyHeader: []
tags:
  - name: E-mail
    description: Envío de correo electrónico y consulta.
  - name: Dominios
    description: Registro y verificación de dominios para envío de correos electrónicos.
paths:
  /v1/email/messages:
    get:
      tags:
        - E-mail
      summary: Listar mensajes correo
      description: >-
        Muestra el historial de correo enviados. Puedes filtrar por fecha y
        estado.
      operationId: ntfEmail_getV1EmailMessages
      parameters:
        - name: page
          in: query
          schema:
            type: string
          description: Página (por defecto 1).
        - name: limit
          in: query
          schema:
            type: string
          description: Elementos por página (predeterminado 20, máximo 100).
        - name: fromDate
          in: query
          schema:
            type: string
            format: date-time
          description: Inicio del rango (filtrar por creado en, inclusive).
        - name: toDate
          in: query
          schema:
            type: string
            format: date-time
          description: Fin del rango (filtrar por creado en, inclusive).
        - name: status
          in: query
          schema:
            type: string
          description: >-
            Uno o más estados separados por comas: EN COLA, PROGRAMADO,
            PROCESANDO, ENVIADO, ENTREGADO, ABIERTO, HACIENDO CLIC, FALLADO,
            CANCELADO, QUEJADO. Los valores no válidos se ignoran.
        - name: emailDomainId
          in: query
          schema:
            type: string
          description: >-
            Filtra por el ID (cuid) del dominio de envío; debe pertenecer al
            espacio de trabajo. Alternativa: `email_domain_id`.
        - name: email_domain_id
          in: query
          schema:
            type: string
          description: Alias de `emailDomainId`.
      responses:
        '200':
          description: Lista de correo electrónico y paginación.
          content:
            application/json:
              schema:
                type: object
                required:
                  - success
                  - data
                  - pagination
                properties:
                  success:
                    type: boolean
                    example: true
                  data:
                    type: array
                    description: >-
                      Cada elemento tiene los mismos campos que GET
                      /v1/email/messages/{id} en `data`. No incluye cuerpo
                      (`html`/`text`), `emailDomainId`, `externalId` o
                      `providerUsed`.
                    items:
                      $ref: '#/components/schemas/NtfEmail_EmailListItem'
                  pagination:
                    type: object
                    required:
                      - total
                      - page
                      - limit
                      - totalPages
                    properties:
                      total:
                        type: integer
                        description: >-
                          Número total de correos electrónicos que coinciden con
                          los filtros.
                      page:
                        type: integer
                      limit:
                        type: integer
                      totalPages:
                        type: integer
              example:
                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
        '400':
          description: '`emailDomainId` informado no existe en este espacio de trabajo.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfEmail_ErrorResponse'
        '401':
          description: Clave API faltante o no válida.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfEmail_ErrorResponse'
        '403':
          description: >-
            Falta correo electrónico: ámbito de lectura, o `emailDomainId` no
            permitido para la clave API (restricción de **domainIds**), o
            listado con clave restringida a dominios sin acceso al filtro
            solicitado.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NtfEmail_ErrorResponse'
components:
  schemas:
    NtfEmail_EmailListItem:
      type: object
      description: >-
        Metadatos de envío devueltos en el listado y en GET by ID; la API
        siempre devuelve todos estos campos (anulables donde se indique).
      required:
        - id
        - to
        - from
        - fromName
        - subject
        - status
        - scheduledFor
        - sentAt
        - deliveredAt
        - failedAt
        - errorMessage
        - createdAt
      properties:
        id:
          type: string
          description: ID (algunos) de su correo electrónico.
        to:
          type: string
          description: Beneficiario.
        from:
          type: string
          description: Remitente (dirección verificada).
        fromName:
          type: string
          nullable: true
        subject:
          type: string
        status:
          type: string
          enum:
            - QUEUED
            - SCHEDULED
            - PROCESSING
            - SENT
            - DELIVERED
            - OPENED
            - CLICKED
            - FAILED
            - CANCELLED
            - COMPLAINED
          description: Estado actual del correo electrónico.
        scheduledFor:
          type: string
          format: date-time
          nullable: true
        sentAt:
          type: string
          format: date-time
          nullable: true
        deliveredAt:
          type: string
          format: date-time
          nullable: true
        failedAt:
          type: string
          format: date-time
          nullable: true
        errorMessage:
          type: string
          nullable: true
        createdAt:
          type: string
          format: date-time
    NtfEmail_ErrorResponse:
      type: object
      properties:
        success:
          type: boolean
          example: false
        error:
          type: string
          description: >-
            Etiqueta de error de estilo HTTP (por ejemplo, no autorizado,
            solicitud incorrecta, no encontrada).
        message:
          type: string
          description: >-
            Mensaje legible por humanos para usuarios finales (localizado a
            través de Accept-Language/x-locale cuando corresponda).
        code:
          type: string
          description: >-
            Código API v1 estable (enumeración). Siempre presente en los
            errores. Úselo con el estado HTTP para decidir reintentar o
            corregir. Ver [Respuestas de
            error](/es/guides/conceitos/resposta-de-erros).
        details:
          type: array
          items:
            type: object
            properties:
              field:
                type: string
              message:
                type: string
        data:
          type: object
          description: >-
            Datos adicionales en algunos errores (por ejemplo: estado del correo
            electrónico en cancelación).
      required:
        - success
        - error
        - message
        - code
  securitySchemes:
    ntfEmailBearerAuth:
      type: http
      scheme: bearer
      bearerFormat: API Key
      description: >-
        Clave API sin autorización de encabezado. Ejemplo: `Authorization:
        Bearer sk_live_xxxxx`
    ntfEmailApiKeyHeader:
      type: apiKey
      in: header
      name: x-api-key
      description: 'Clave API sin encabezado x-api-key. Ejemplo: `x-api-key: sk_live_xxxxx`'

````