Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Platform

Platform: List Users

Every user, newest first (platform staff). `q` matches the email or name; `role` filters by platform role.

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
GET/api/v1/platform/users

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

Query Parameters

q?string
role?string

none, support or superadmin

limit?integer
Formatint64
Range1 <= value <= 100
cursor?string

Response Body

curl -X GET "http://localhost:8000/api/v1/platform/users?q=string&role=string&limit=1&cursor=string"
{
  "items": [
    {
      "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
      "email": "string",
      "name": "string",
      "platform_role": "none",
      "workspaces": 0,
      "created_at": "2019-08-24T14:15:22Z"
    }
  ],
  "next_cursor": "string",
  "superadmins": 0,
  "max_superadmins": 0
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Platform: Lift Suspension

Lift a workspace's suspension (superadmin), with an optional reason. 409 if it isn't suspended. Audited.

Platform: List Workspaces

Every workspace, newest first (platform staff: `support` or `superadmin`; signed-in only, API keys get 403). `q` matches the name, slug or id; `status` is `active` or `suspended`; `cursor` pages.