Skip to content

GET /mailing/email-request/{uuid} ​

Recupera lo stato di base e i dettagli di una richiesta di email.

Panoramica ​

Usa questo endpoint per ispezionare la richiesta di invio originale dopo che è stata creata.
Restituisce l'oggetto email_request, che rappresenta la richiesta di base e le informazioni elaborate sui destinatari.

Endpoint ​

http
GET /mailing/email-request/{uuid}

Parametri del percorso ​

ParametroTipoObbligatorioDescrizione
uuidstringSìUUID della richiesta di email.

Esempio di richiesta ​

bash
curl -X GET https://api.mailiqo.com/v1/mailing/email-request/2b687f6a-7e85-4c14-8b17-xxxxxxx \
  -H "X-API-KEY: YOUR_API_KEY"

Struttura della risposta ​

La risposta è incapsulata in {status, data}, e data contiene l'oggetto email_request.
⚠️ Questo endpoint restituisce l'oggetto a livello di richiesta, non il record di una singola email consegnata. La differenza è che l'oggetto email_request contiene le informazioni della richiesta originale, mentre l'oggetto email_message rappresenta il messaggio elaborato e inviato a un singolo destinatario. Ogni email_request può generare più record email_message se ci sono più destinatari.

Campi di email_request ​

CampoTipoDescrizione
uuidstringUUID della richiesta di email.
statusstringStato attuale della richiesta
total_recipientsintegerNumero totale di destinatari della richiesta.
domainstringDominio di invio.
from_emailstringIndirizzo email originale del mittente.
subjectstringOggetto originale dell'email.
email_messagesarrayLista degli UUID dei messaggi generati da questa richiesta.
total_attachmentsintegerNumero totale di allegati della richiesta.
recipientsobjectOggetto con le informazioni originali ed elaborate sui destinatari.
created_atobjectData e ora di creazione della richiesta.

Campi di recipients ​

CampoTipoDescrizione
toarrayDestinatari to originali.
ccarrayDestinatari cc originali.
bccarrayDestinatari bcc originali.

Esempio di risposta ​

json
{
  "status": "success",
  "data": {
    "email_request": {
      "uuid": "2b687f6a-7e85-4c14-8b17-xxxxxxx",
      "status": "QUEUED",
      "total_recipients": 1,
      "domain": "tuodominio.com",
      "from_email": "[email protected]",
      "subject": "Ciao da Mailiqo",
      "email_messages": [
        "c82929b4-8c6e-45f0-b048-xxxxxxxxx"
      ],
      "total_attachments": 0,
      "recipients": {
        "to": [
          {
            "email": "[email protected]",
            "name": ""
          }
        ],
        "cc": [],
        "bcc": []
      },
      "created_at": {
        "date": "2026-03-20 10:29:05.000000",
        "timezone_type": 3,
        "timezone": "UTC"
      }
    }
  }
}

Risposte HTTP ​

StatoSignificato
200Richiesta di email trovata e restituita.
404Richiesta di email non trovata.
500Errore interno del server.

Formato della risposta di errore ​

json
{
  "status": "error",
  "error": {
    "code": "9999",
    "message": "Error message describing the issue."
  }
}

Note ​

  • Questo endpoint restituisce l'oggetto a livello di richiesta, non il record di una singola email consegnata. La differenza è che l'oggetto email_request contiene le informazioni della richiesta originale, mentre l'oggetto email_message rappresenta il messaggio elaborato e inviato a un singolo destinatario. Ogni email_request può generare più record email_message se ci sono più destinatari.
  • Usa questo endpoint quando devi ispezionare i destinatari elaborati o i metadati della richiesta.
  • Per ispezionare un messaggio specifico, usa GET /mailing/email-message/{uuid}.

Endpoint correlati ​

  • POST /v1/mailing/send
  • GET /v1/mailing/email-message/{uuid}

Built with VitePress