MonitorsSmtp monitors
List SMTP Monitors
Lists SMTP monitors in an organization.
GET /api/smtp-monitors
Authentication
Requires a valid session.
- Header:
Authorization: Bearer <token>
Parameters
organizationId(Query, optional): Organization ID. Defaults to the current user's organization.customerId(Query, optional): Filter by customer ID.search(Query, optional): Search by monitor name, hostname, or customer.page(Query, optional): Page number (default: 1).perPage(Query, optional): Items per page (default: 50, max: 200).
cURL
curl "https://YOUR_DOMAIN/api/smtp-monitors?page=1&perPage=50" \
-H "Authorization: Bearer $TOKEN"Response
{
"items": [
{
"id": 200,
"organizationId": 1,
"customerId": 10,
"name": "Outbound SMTP",
"hostname": "smtp.example.com",
"port": 587,
"status": "active",
"checkInterval": 60,
"timeoutSeconds": 30,
"customerName": "Example Customer",
"notificationEmail": null,
"notificationPhoneNumber": null,
"lastCheckedAt": "2026-01-01T12:00:00.000Z",
"createdAt": "2026-01-01T12:00:00.000Z",
"updatedAt": "2026-01-01T12:00:00.000Z",
"config": {
"secure": false,
"ignoreTls": false,
"requireTls": false
}
}
],
"total": 1,
"page": 1,
"perPage": 50
}Errors
400InvalidorganizationIdorcustomerId401Unauthorized403Forbidden