REST API Reference

Retrieve workspace subscription tier, active status, and real-time usage metrics across inboxes, active inbox storage, archive box storage, and daily inbound/outbound volume.

{
  "tier": "solo",
  "status": "active",
  "usage": {
    "inboxes": { "used": 3, "limit": 10, "resetsAt": null },
    "messages": { "used": 42, "limit": 500, "resetsAt": null },
    "archive": { "used": 120, "limit": 2500, "resetsAt": null },
    "inbound": { "used": 14, "limit": 500, "resetsAt": "daily" },
    "outbound": { "used": 5, "limit": 200, "resetsAt": "daily" }
  }
}

Instantly check whether a custom inbox address prefix or full address is available or already reserved/taken.

List all active project inboxes in your workspace.

Provision a new persistent or temporary inbox.

List messages in your active inbox storage or folder=archive for reference storage.

Move an email message to your metered Archive Box to free up active inbox storage.

Permanently delete an unneeded message to free up quota.

Send an outbound message from an inbox (internal deliveries bypass external mail relay with 0 credit consumption).