MonitorsImap pop monitors
List IMAP/POP Monitors
Lists IMAP/POP monitors in an organization.
GET /api/imap-pop-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).
Response
{
"items": [
{
"id": 500,
"organizationId": 1,
"customerId": 10,
"name": "Mailbox Access",
"hostname": "mail.example.com",
"port": 993,
"checkInterval": 30,
"timeoutSeconds": 30,
"customerName": "Example Customer",
"config": {
"protocol": "imap",
"user": "monitor@example.com",
"password": "password",
"tls": true
},
"status": "active",
"notificationPhoneNumber": null,
"notificationEmail": null,
"lastCheckedAt": null,
"createdAt": "2026-02-26T12:00:00.000Z",
"updatedAt": "2026-02-26T12:00:00.000Z"
}
],
"total": 1,
"page": 1,
"perPage": 50
}Errors
400Invalid query parameters (e.g.organizationId,customerId)401Unauthorized403Forbidden
Get IMAP/POP Monitor Details
Consolidated endpoint that returns the IMAP/POP monitor detail page payload in a single call (latest check, uptime stats, incidents, alert history, maintenance windows, chart data, etc.).
Trigger IMAP/POP Check
Triggers an immediate check from all eligible monitoring locations.