MailerFindEmail¶

GET mailer/email/find

Finds emails by recipient address, by the provider message id, or by campaign. It exists for support work: the customer says nothing arrived, or the provider quotes a message id in a complaint.

The address lookup is case-insensitive: mail servers do not distinguish the case of the local part, so Client@ and client@ find the same messages.

Access Control¶

Allowed roles: admin, leader. Scoped to the brand of the caller.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/mailer/email/[email protected]&limit=20
Authorization: <JWT_TOKEN>

{
  "command": "MailerFindEmail",
  "extID": "1",
  "data": {
    "email": "[email protected]",
    "limit": 20
  }
}

const res = await platform.MailerFindEmail({
  email: "[email protected]",
  limit: 20
});

Request Data¶

Field	Type	Required	Description
`email`	string	No	Recipient address, in any case
`externalId`	string	No	Provider message id
`campaignId`	int	No	Campaign id
`limit`	int	No	How many rows to return, `1..200`, default `20`

Response Data¶

total here is the number of rows returned, capped by limit — this is a lookup, not a paged report. For reports use MailerGetEmails.

{
  "rows": [
    {
      "id": 812,
      "email": "[email protected]",
      "subject": "Your deposit is confirmed",
      "status": "DELIVERED",
      "kind": "TRANSACTIONAL",
      "externalId": "prov-99213",
      "profileId": 3,
      "campaignId": null,
      "openCount": 1,
      "clickCount": 0,
      "sentAt": "2026-08-24 13:32:41",
      "deliveredAt": "2026-08-24 13:32:49"
    }
  ],
  "total": 1
}

Errors¶

Code	Error	Description
`400`	`VALIDATION_ERROR`	None of `email`, `externalId`, `campaignId` was provided