Skip to content

MailerGetProfiles

GET mailer/providerProfiles/list

Returns the provider profiles of the brand with the provider name joined in.

Two fields are worth watching here: domainStatus (an UNVERIFIED sender domain means mail is quietly going to spam) and pausedAt (the reputation guard stopped the profile because bounces or complaints crossed the threshold).

Access Control

Allowed role: admin, within the brand of the caller.

Request

GET request
GET https://{broker_domain}/mailer/providerProfiles/list?limit=50&orderBy=%5B%22routingPriority%22%2C%22ASC%22%5D
Authorization: <JWT_TOKEN>
{
  "command": "MailerGetProfiles",
  "extID": "1",
  "data": {
    "limit": 50,
    "orderBy": [
      "routingPriority",
      "ASC"
    ]
  }
}
const res = await platform.MailerGetProfiles({
  limit: 50,
  orderBy: [
    "routingPriority",
    "ASC"
  ]
});

Request Data

Field Type Required Description
limit int No Page size, 1..1000, default 100
offset int No Rows to skip
orderBy array No Sorting, for example ["id", "DESC"]
count array No Row count aggregate, ["id"]
where object No Filters, see Table filter syntax

Response Data

{
  "rows": [
    {
      "id": 3,
      "brand": "default",
      "providerId": 1,
      "providerName": "postmark",
      "name": "Postmark transactional",
      "mode": "COMMON",
      "deliveryUpdateBy": "WEBHOOK",
      "fromEmail": "[email protected]",
      "fromName": "ScaleTrade",
      "kind": "TRANSACTIONAL",
      "trackOpens": false,
      "trackClicks": false,
      "maxPerMinute": 300,
      "dailyLimit": 0,
      "routingPriority": 100,
      "isDefault": true,
      "status": "ENABLED",
      "domainStatus": "VERIFIED",
      "domainCheckedAt": "2026-08-24 06:00:00",
      "pausedAt": null,
      "pauseReason": null
    }
  ]
}

Errors

Code Error Description
401 PERMISSION_DENIED Not an admin session