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

# Get workspace

`GET /workspaces/{namespace}/{name}`

Returns the current state of a specific workspace identified by namespace and workspace name, including the revision for optimistic locking. This endpoint is intended for retrieving the workspace state before updating it.

## Path parameters

- `namespace` string, required
- `name` string, required

## Response `200`

Successful operation. Returns the requested workspace details with new revision.

- ApiWorkspaceEnvelope
  - `data` WorkspacesWorkspaceUpdate, required
    - `paused` boolean, required — TODO: remove `paused` once we have an "actions" api for pausing workspaces
    - `podTemplate` WorkspacesPodTemplateMutate, required
      - `options` WorkspacesPodTemplateOptionsMutate, required
        - `imageConfig` string, required
        - `podConfig` string, required
      - `podMetadata` WorkspacesPodMetadataMutate, required
        - `annotations` object, required
        - `labels` object, required
      - `volumes` WorkspacesPodVolumesMutate, required
        - `data` WorkspacesPodVolumeMount[], required
          - `mountPath` string, required
          - `pvcName` string, required
          - `readOnly` boolean
        - `home` string
        - `secrets` WorkspacesPodSecretMount[]
          - `defaultMode` integer
          - `mountPath` string, required
          - `secretName` string, required
    - `revision` string, required — RevisionString is an opaque token that can be treated like an etag. - Clients receive this value from GET requests and must include it in update requests to ensure they are updating the expected version. - Clients must not parse, interpret, or compare revision values other than for equality, as the format is not guaranteed to be stable.

## Other responses

- `401` — Unauthorized. Authentication is required.
- `403` — Forbidden. User does not have permission to access the workspace.
- `404` — Not Found. Workspace does not exist.
- `422` — Unprocessable Entity. Validation error.
- `500` — Internal server error. An unexpected error occurred on the server.

---

[API](https://skmtc.net/opendatahub-io/apis/kubeflow-notebooks-api.md) · [All operations](https://skmtc.net/opendatahub-io/apis/kubeflow-notebooks-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/opendatahub-io/kubeflow-notebooks-api/versions/257ea068094f/schema)