List IMAP/POP Monitors

GET /api/imap-pop-monitors

AuthenticationCopy Anchor Link

Requires a valid session.

• Header: Authorization: Bearer <token>

ParametersCopy Anchor Link

• 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).

ResponseCopy Anchor Link

{
  "items": [
    {
      "id": 500,
      "organizationId": 1,
      "customerId": 10,
      "name": "Mailbox Access",
      "hostname": "mail.deinkunde.com",
      "port": 993,
      "checkInterval": 30,
      "timeoutSeconds": 30,
      "customerName": "Example Customer",
      "config": {
        "protocol": "imap",
        "user": "monitor@deinkunde.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
}

Inline metricsCopy Anchor Link

Every item carries the same rolled-up metrics the other monitor list endpoints return. They are computed per monitor over the calendar day, month and year in UTC.

The day figures are read from the raw check data, the month and year from continuous aggregates, so a value may lag the newest check by a few minutes in the month and year windows.

ErrorsCopy Anchor Link

• 400 Invalid query parameters (e.g. organizationId, customerId)
• 401 Unauthorized
• 403 Forbidden