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).
API key access
mailboxes:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role./api/v1/deliverability/fleetAccess 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/fleet" \ -H "X-Workspace-Id: string"{
"warmup_defaults": {
"days": 0,
"start_per_day": 0
},
"domains": [
{
"domain": "string",
"shared": true,
"score": 0,
"level": "string",
"issues": [
"string"
],
"dns_status": "ok",
"dns_checked_at": "2019-08-24T14:15:22Z",
"mailbox_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"active_mailboxes": 0,
"paused_mailboxes": 0,
"daily_limit": 0,
"capacity_today": 0,
"sent_today": 0
}
],
"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"
],
"rotation_weight": 0,
"in_rotation": true,
"daily_send_cap": 0,
"today_cap": 0,
"sent_today": 0,
"warmup": {
"days": 0,
"start_per_day": 0,
"started_at": "2019-08-24T14:15:22Z",
"custom": true,
"warming_up": true,
"day": 0,
"progress_percent": 0,
"ends_at": "2019-08-24T14:15:22Z",
"schedule": [
0
]
}
}
],
"capacity": {
"active_mailboxes": 0,
"active_sequences": 0,
"today_capacity": 0,
"expected_today": 0,
"sent_today": 0,
"remaining_today": 0,
"days": [
{
"date": "2019-08-24",
"capacity": 0,
"binding": "no_active_mailboxes",
"expected": 0,
"expected_binding": "string",
"send_window_minutes": 0
}
],
"limits": {
"enabled": true,
"mailbox_per_hour": 0,
"sending_domain_per_day": 0,
"workspace_emails_per_minute": 0,
"provider_emails_per_minute": 0
}
},
"pools": [
{
"sequence_id": "7cd84c09-94f4-486c-9c49-de3b9cf3f74f",
"sequence_name": "string",
"sequence_status": "string",
"mailbox_ids": [
"497f6eca-6276-4993-bfeb-53cbbbba6f08"
],
"active_mailboxes": 0,
"today_capacity": 0,
"binding": "no_active_mailboxes",
"expected_today": 0,
"expected_binding": "string"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}