Mailboxes
List Mailboxes
API key access
Needs the
mailboxes:read scope with an API key (ro_pat_...). A signed-in session uses the caller's role.GET
/api/v1/mailboxesAuthorizationBearer <token>
Access 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
Query Parameters
include_disconnected?boolean
Header Parameters
X-Workspace-Id?string | null
Id of the workspace to act on (must be a member).
Response Body
curl -X GET "http://localhost:8000/api/v1/mailboxes?include_disconnected=true" \ -H "X-Workspace-Id: string"{
"items": [
{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"workspace_id": "0967198e-ec7b-4c6b-b4d3-f71244cadbe9",
"provider": "unipile",
"service": "google",
"email_address": "string",
"display_name": "string",
"status": "connected",
"daily_send_cap": 0,
"connected_by_user_id": "b6d751ce-d9fb-4fe5-aed1-d42f5449f910",
"connected_at": "2019-08-24T14:15:22Z",
"disconnected_at": "2019-08-24T14:15:22Z",
"last_health_check_at": "2019-08-24T14:15:22Z",
"last_error": "string",
"last_inbound_at": "2019-08-24T14:15:22Z",
"last_sent_at": "2019-08-24T14:15:22Z",
"paused_at": "2019-08-24T14:15:22Z",
"pause_reason": "string",
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z"
}
]
}{
"detail": [
{
"loc": [
"string"
],
"msg": "string",
"type": "string",
"input": null,
"ctx": {}
}
]
}