Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Platform

Platform: Suspend Workspace

Suspend a workspace (superadmin), with a reason: nothing is sent or dialled, members and admins get 403 `workspace_suspended`, owners can only read (and export or delete their data). 409 if already suspended. Audited.

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
POST/api/v1/platform/workspaces/{workspace_id}/suspend

Authorization

AuthorizationBearer <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

Path Parameters

workspace_idstring
Formatuuid

Request Body

reasonstring

Shown to the workspace's owners and recorded in the platform audit log.

Length3 <= length <= 500

Response Body

curl -X POST "http://localhost:8000/api/v1/platform/workspaces/497f6eca-6276-4993-bfeb-53cbbbba6f08/suspend" \  -H "Content-Type: application/json" \  -d '{    "reason": "string"  }'
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "name": "string",
  "slug": "string",
  "plan": "string",
  "country": "string",
  "members": 0,
  "owner_email": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "suspended_at": "2019-08-24T14:15:22Z",
  "suspended_reason": "string",
  "emails_sent_30d": 0,
  "calls_30d": 0,
  "ai_calls_30d": 0
}
Empty
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Platform: Set Platform Role

Set a user's platform role (superadmin): grant or remove `superadmin` / `support`. Your own role can't be changed (409). At most `PLATFORM_MAX_SUPERADMINS` (default and maximum 10) superadmins: 409 `{code: superadmin_limit}` when full; the last superadmin can't be removed (409 `last_superadmin`). A demotion applies on the user's next request. Audited.

Platform: System Health

Version, deployed commit, database size, user/workspace counts and the job queue's stats (platform staff). AI provider budgets are on `GET /ai/usage`.