MailerGetProviders¶

GET mailer/providers/list

Returns the provider catalogue. Every row says whether the module really has the adapter (adapterImplemented) and what it can do, so the UI can show a provider as unavailable instead of letting an operator pick a dead integration.

Access Control¶

Allowed roles: admin, provider.

Request¶

RESTTCPSDK

GET request

GET https://{broker_domain}/mailer/providers/list?limit=50&orderBy=%5B%22name%22%2C%22ASC%22%5D
Authorization: <JWT_TOKEN>

{
  "command": "MailerGetProviders",
  "extID": "1",
  "data": {
    "limit": 50,
    "orderBy": [
      "name",
      "ASC"
    ]
  }
}

const res = await platform.MailerGetProviders({
  limit: 50,
  orderBy: [
    "name",
    "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": 1,
      "name": "postmark",
      "icon": "8f2a1c",
      "description": "Postmark transactional email",
      "url": "https://postmarkapp.com",
      "status": "ENABLED",
      "options": { "serverToken": "string" },
      "supportedUpdateModes": ["WEBHOOK"],
      "adapterImplemented": true,
      "capabilities": { "sendEmail": true, "statusRequest": true, "webhook": true, "balance": false, "domainCheck": true }
    }
  ]
}

Errors¶

Code	Error	Description
`401`	`PERMISSION_DENIED`	Session may not read the catalogue