Skip to main content
Fetch Workspace
Returns a single Workspace, filtered by the caller’s reach-visibility — a caller never sees a node their authority doesn’t reach.

Path Parameters

string
required
The workspace UUID.

Query Parameters

string
Comma-separated include flags. memberCount adds the workspace’s direct member count as memberCount on the object.
string
Service/master keys only — the user to act as. Enforced: visibility resolves against the named user, so a key acting as someone with no relation to this workspace gets the same 404 that user would. Omit it to read as the app itself (unbounded) — where “omit” means absent: actingUserId: "" or null is a 400, not a fall-through to that mode. See Acting on behalf of a user.

Response

Returns the Workspace object.

Error Responses

Every path id on the workspaces bundle is checked for UUID shape before the route runs, so a malformed one is a plain 400 rather than a 500 from the database.
See also: useFetchWorkspace