Skip to main content

Admin

The Admin section is for workspace admins to monitor health, connectors, audit logs, and the background job queue. It is not required for day-to-day use of the inbox.

Health​

  • Health — Overview of mailbox connection status, last sync times, and provider status. Use it to see if mailboxes are connected and syncing.
  • Connectors — More detail on connector state (e.g. IMAP, Microsoft, Gmail). API: GET .../admin/connectors/imap-health (and similar for other providers if exposed).

Audit logs​

  • Audit logs — Append-only log of security-relevant and critical actions (e.g. role changes, member removal, connector config). List via API: GET .../audit-logs with optional limit. Creating entries is typically internal or restricted.

Jobs​

  • Jobs — List of background jobs (e.g. ingestion, sync, outbound). You can retry failed jobs. API: GET .../admin/jobs, POST .../admin/jobs/:jobId/retry. Useful for recovering from transient failures.

Queue metrics​

  • Queue metrics — API: GET .../admin/queue-metrics for queue depth and related metrics. Used for operational visibility.

These endpoints are admin-only. See API — Admin endpoints for request/response details.