Skip to main content
Skip to content

Read a workspace

GET /api/v1/workspaces/{workspaceId} — the fields it returns and the two ways it 404s.

GET /api/v1/workspaces/{workspaceId}

Requires workspace:read. Returns the workspace the key is bound to. The identifier must be a valid UUID and must match the key's own workspace; anything else is a 404.

200
{
  "workspace": {
    "id": "…",
    "name": "…",
    "createdAt": "…"
  }
}

Three fields, and why not more

Identifier, name, creation time. Member lists, connection lists, agent counts and billing state are all deliberately absent: each would widen a read-only key into something that discloses who works at a company, what systems they run, and what they spend. If the API grows, it grows by adding a scope, not by widening this response.

When it returns 404

  • The identifier is not a valid UUID.
  • The identifier is a valid UUID for a workspace that does not exist.
  • The identifier is a valid UUID for a workspace that exists but is not this key's workspace.