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

# Get a Workspace

`GET /workspaces/{workspace}`

Show details of a specific workspace.

## Path parameters

- `workspace` string, required

## Query parameters

- `include` string[]
- `fields` object
  - `agent-pools` string — The comma-separated list of fields to return in response for AgentPool resource.
  - `configuration-versions` string — The comma-separated list of fields to return in response for ConfigurationVersion resource.
  - `container-image-versions` string — The comma-separated list of fields to return in response for ContainerImageVersion resource.
  - `drift-reports` string — The comma-separated list of fields to return in response for DriftReport resource.
  - `environments` string — The comma-separated list of fields to return in response for Environment resource.
  - `module-versions` string — The comma-separated list of fields to return in response for ModuleVersion resource.
  - `modules` string — The comma-separated list of fields to return in response for Module resource.
  - `runs` string — The comma-separated list of fields to return in response for Run resource.
  - `tags` string — The comma-separated list of fields to return in response for Tag resource.
  - `users` string — The comma-separated list of fields to return in response for User resource.
  - `vcs-providers` string — The comma-separated list of fields to return in response for VcsProvider resource.
  - `workspace-readme` string — The comma-separated list of fields to return in response for WorkspaceReadme resource.
  - `workspaces` string — The comma-separated list of fields to return in response for Workspace resource.

## Response `200`

Success.

## Other responses

- `404` — Workspace not found, or user unauthorized to perform action.
- `4XX` — Client error.
- `5XX` — Server error.

---

[API](https://skmtc.net/scalr/apis/scalr-iacp-api.md) · [All operations](https://skmtc.net/scalr/apis/scalr-iacp-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/scalr/scalr-iacp-api/versions/fc927526ad12/schema)