Skip to content
MailBench SMTP
Start free
Menu
Documentation menu

API reference

Workspace

The workspace your key belongs to.

Get the current workspace

GET/v1/workspace

Returns

  • idstringrequired
  • namestringrequired
  • rolestring
    Only set for dashboard sessions.
    One of owner, admin, member.

Errors

401Missing or invalid API key.
429Too many requests. Wait `Retry-After` seconds.
curl / JavaScript / Python
curl "https://app.mailbench.dev/v1/workspace" \
  -H "Authorization: Bearer $API_KEY"
const res = await fetch("https://app.mailbench.dev/v1/workspace", {
  headers: {
    Authorization: `Bearer ${process.env.API_KEY}`,
  },
});
const { data } = await res.json();
import os, requests

res = requests.get(
    "https://app.mailbench.dev/v1/workspace",
    headers={"Authorization": f"Bearer {os.environ['API_KEY']}"},
)
data = res.json()["data"]
Response 200
{
  "success": true,
  "data": {
    "id": "ws_k3m9x2p7qa4d8fbn",
    "name": "Acme",
    "role": "owner"
  }
}

Emails used this month against your plan

GET/v1/usage

The quota period is the calendar month in UTC.

Returns

  • period_startstring (date-time)required
  • usedintegerrequired
    Emails received this month.
  • monthly_limitinteger or nullrequired
    null means unlimited.
  • retention_daysintegerrequired
  • membersintegerrequired
  • member_limitinteger or nullrequired
  • inboxesintegerrequired

Errors

401Missing or invalid API key.
429Too many requests. Wait `Retry-After` seconds.
curl / JavaScript / Python
curl "https://app.mailbench.dev/v1/usage" \
  -H "Authorization: Bearer $API_KEY"
const res = await fetch("https://app.mailbench.dev/v1/usage", {
  headers: {
    Authorization: `Bearer ${process.env.API_KEY}`,
  },
});
const { data } = await res.json();
import os, requests

res = requests.get(
    "https://app.mailbench.dev/v1/usage",
    headers={"Authorization": f"Bearer {os.environ['API_KEY']}"},
)
data = res.json()["data"]
Response 200
{
  "success": true,
  "data": {
    "period_start": "2026-10-12T10:00:00Z",
    "used": 2210,
    "monthly_limit": 2500,
    "retention_days": 7,
    "members": 3,
    "member_limit": 5,
    "inboxes": 2
  }
}