---
title: "Get workspace details"
method: GET
path: "/workspaces/{workspaceName}"
tags: ["workspaces"]
---

# Get workspace details

`GET /workspaces/{workspaceName}`

Returns detailed information about a workspace including its display name, account ID, status, and runtime configuration.

## Path parameters

- `workspaceName` string, required

## Query parameters

- `countResources` boolean

## Response `200`

successful operation

- Workspace — Owner fields for Persistence
  - `createdAt` string — The date and time when the resource was created
  - `updatedAt` string — The date and time when the resource was updated
  - `createdBy` string — The user or service account who created the resource
  - `updatedBy` string — The user or service account who updated the resource
  - `accountId` string — Workspace account id
  - `displayName` string — Workspace display name
  - `groupMappings` GroupWorkspaceMapping[] — Group-to-role mappings for directory sync (SCIM) group membership
    - `groupName` string — Name of the IdP group (e.g. "Engineering", "Platform")
    - `role` 'admin' | 'member' — Role to assign in this workspace (admin or member)
  - `hipaaInfo` WorkspaceHipaaInfo — HIPAA compliance state for a workspace. `accountEnabled` mirrors the account-level `hipaa_compliance` addon (set server-side from operator tooling and Stripe billing events). `unsafe` records a per-workspace opt-out toggled from workspace settings; absent when the account does not have the addon.
    - `accountEnabled` boolean — True when the parent account has the HIPAA compliance addon active. Set server-side from operator tooling and Stripe billing events; cannot be changed from workspace settings.
    - `unsafe` WorkspaceHipaaUnsafe — Per-workspace HIPAA opt-out record. Toggled from workspace settings; the backend stamps `updatedBy` and `updatedAt`.
      - `enabled` boolean — True marks this workspace as HIPAA-unsafe (NOT compliant), overriding the account-level addon. False marks the workspace as HIPAA compliant.
      - `updatedAt` string — RFC3339 timestamp when the opt-out was last toggled. Stamped server-side.
      - `updatedBy` string — User id (sub) of the actor that last toggled this opt-out. Stamped server-side.
  - `id` string — Autogenerated unique workspace id
  - `labels` MetadataLabels — Key-value pairs for organizing and filtering resources. Labels can be used to categorize resources by environment, project, team, or any custom taxonomy.
  - `name` string — Workspace name
  - `region` string — Workspace write region
  - `resourceCounts` object — Per-resource counts (agents, functions, models, sandboxes, policies, jobs, volumes, drives, volumetemplates, integrationconnections, previews, customdomains, serviceaccounts, images). Only populated when GetWorkspace is called with ?countResources=true.
  - `runtime` WorkspaceRuntime — Runtime configuration for the workspace infrastructure
    - `generation` string — Infrastructure generation version for the workspace (affects available features and deployment behavior)
    - `sandbox` WorkspaceSandboxSettings — Workspace-wide sandbox configuration that applies to all sandbox deployments in the workspace.
      - `disableProcessLogging` boolean — When true, sandbox deployments in this workspace set SANDBOX_DISABLE_PROCESS_LOGGING=true to disable per-process stdout/stderr logging. Requires sandbox-api v0.2.28+.
  - `status` 'created' | 'account_binded' | 'account_configured' | 'workspace_configured' | 'ready' | 'error' — Workspace status (created, account_binded, account_configured, workspace_configured, ready, error)
  - `statusReason` string — Reason for current status (only set for error status)

## Other responses

- `401` — Unauthorized - Invalid or missing authentication credentials
- `403` — Forbidden - You do not have access to this workspace
- `404` — Not found - Workspace does not exist
- `500` — Internal server error

---

[API](https://skmtc.net/blaxel/apis/blaxel-control-plane.md) · [All operations](https://skmtc.net/blaxel/apis/blaxel-control-plane/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/blaxel/blaxel-control-plane/versions/dfa264bc72ee/schema)