Skip to content

MailerGetEmail

GET mailer/email/message/:id

Returns one email with everything that happened to it: attempts, the last provider response, the error, opens and clicks, and the delivery events received for it.

This is the page an operator opens after "the customer says the email never arrived" — the webhook events show whether the provider ever reported anything.

Access Control

Allowed roles: admin, leader, manager. A manager sees only their own emails.

Request

GET request
GET https://{broker_domain}/mailer/email/message/{id}
Authorization: <JWT_TOKEN>
{
  "command": "MailerGetEmail",
  "extID": "1",
  "data": {}
}
const res = await platform.MailerGetEmail({});

Path Parameters

Parameter Type Description
id int Email id

Response Data

{
  "id": 812,
  "email": "[email protected]",
  "subject": "Your deposit is confirmed",
  "status": "DELIVERED",
  "kind": "TRANSACTIONAL",
  "attempts": 1,
  "externalId": "prov-99213",
  "bounceType": null,
  "errorCode": null,
  "errorMessage": null,
  "openCount": 1,
  "clickCount": 0,
  "lastClickedUrl": null,
  "closedBy": "PROVIDER",
  "sentAt": "2026-08-24 13:32:41",
  "deliveredAt": "2026-08-24 13:32:49",
  "openedAt": "2026-08-24 13:40:02",
  "data": { "amount": "250 EUR" },
  "webhookEvents": [
    {
      "id": 5121,
      "providerEventId": "EV-99213-1",
      "result": "PROCESSED",
      "payload": { "RecordType": "Delivery" },
      "createdAt": "2026-08-24 13:32:49"
    }
  ]
}

Errors

Code Error Description
403 PERMISSION_DENIED The email belongs to another manager
404 EMAIL_NOT_FOUND Email not found in the brand