Get Deliverability
Sender health: a 0-100 score per mailbox (hard-bounce and complaint rates over the deliverability guard's window, pause, connection) and per sending domain (its mailboxes plus its last SPF / DKIM / DMARC / MX check), today's sends against the (warmup) cap.
API key access
mailboxes:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/deliverabilityAccess token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).
In: header
Header Parameters
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/deliverability" \ -H "X-Workspace-Id: string"{
"window_hours": 0,
"dns_checks_enabled": true,
"mailboxes": [
{
"mailbox_id": "4d23d1af-2eef-4598-a5e0-1f19ae0b0c14",
"email_address": "string",
"domain": "string",
"status": "connected",
"paused_at": "2019-08-24T14:15:22Z",
"pause_reason": "string",
"score": 0,
"level": "healthy",
"issues": [
"string"
],
"sent": 0,
"hard_bounces": 0,
"complaints": 0,
"sent_today": 0,
"daily_cap": 0,
"warming_up": true
}
],
"domains": [
{
"domain": "string",
"mailboxes": 0,
"score": 0,
"level": "string",
"issues": [
"string"
],
"sent": 0,
"hard_bounces": 0,
"complaints": 0,
"shared": true,
"dns": {},
"dns_checked_at": "2019-08-24T14:15:22Z"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}Disconnect Mailbox
Disconnect the mailbox at the provider; it stays listed with ``include_disconnected``.
Get Mailbox Fleet
Sending domains and mailboxes: every sending domain with its mailboxes, health score, DNS check status and paused mailboxes; each mailbox's rotation weight and warmup schedule (with progress and the ramp's daily caps); and a capacity planner: how many emails a day the connected, unpaused mailboxes can send today and for the next 14 days (warmup caps, the per-mailbox hourly, per-domain daily, workspace and provider limits), naming the limit that decides each day; next to it, `expected`: what the active sequences can send inside their sending windows, daily caps and the per-person contact-pressure rule (RO-272); and `pools`: each sequence's mailbox pool with its capacity (RO-271).