workspaces

get_workspace

Read one workspace. Cost class: fast.

Args: context: Resolved workspace plus caller access predicate. session: Database session.

Returns: The workspace.

Raises: PlatformError: workspace_not_found.

get/v1/workspaces/{workspace_id}

Request

Path parameters

workspace_idstring uuid required

Workspace identifier.

Response

Successful Response

workspace_idstring uuid required
owner_user_idstring uuid nullable required

The console user who owns the workspace, or null for an organization-owned integration workspace.

share_countinteger required

Number of users explicitly granted workspace access; excludes the owner.

namestring required
domain_idstring uuid required
domain_slugstring required
domain_versioninteger required
global_contextstring

Standing background for every query in this workspace — how its journals are keyed, which entity it covers, what an auditor already knows. A je-testing or search request that omits context runs with this text; a request that sends context replaces it for that run, and "" runs with none. Empty means none. Surrounding whitespace is stripped.

config_versioninteger required
status'active' | 'deleting' required

Lifecycle states visible on the API surface.

deleted is a final internal state; a deleted workspace never appears in any list or get response — it is as if it never existed.

purpose'perception_playground'

Why the platform provisioned a workspace nobody asked for.

A purposed workspace is platform-managed: it is created on a person's behalf and it refuses deletion, so a caller can tell from a list response which row will answer 409 rather than discovering it by trying.

created_atstring date-time required
updated_atstring date-time required

Changes

No recorded changes to this operation across all 1 revision of this API.