Workspaces
Workspace Overview
The organisation overview (admin+): seats, this UTC month's usage (emails sent, calls and minutes, AI requests, new leads), totals, mailbox health, which providers run on the workspace's own configuration, and the compliance setup checklist.
API key access
Needs the
admin scope with an API key (ro_pat_...). A signed-in session uses the caller's role.GET
/api/v1/workspaces/current/overviewAuthorizationBearer <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
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/workspaces/current/overview" \ -H "X-Workspace-Id: string"{
"workspace": {
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"name": "string",
"slug": "string",
"plan": "free",
"timezone": "string",
"country": "string",
"default_language": "string",
"suspended_at": "2019-08-24T14:15:22Z",
"suspended_reason": "string",
"role": "owner"
},
"created_at": "2019-08-24T14:15:22Z",
"seats": {
"members": 0,
"owners": 0,
"admins": 0,
"pending_invites": 0
},
"period_start": "2019-08-24T14:15:22Z",
"usage": {
"emails_sent": 0,
"calls": 0,
"call_minutes": 0,
"ai_calls": 0,
"leads_created": 0
},
"totals": {
"leads": 0,
"companies": 0,
"active_campaigns": 0,
"kb_documents": 0
},
"mailboxes": {
"total": 0,
"connected": 0,
"paused": 0,
"needs_attention": 0,
"sending_domains": 0
},
"providers": [
{
"kind": "string",
"label": "string",
"source": "string",
"provider": "string"
}
],
"compliance": [
{
"key": "string",
"label": "string",
"done": true,
"required": true,
"href": "string"
}
]
}Empty