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

# Get a workspace

`GET /v2/workspaces/{workspaceId}`

## Request

- Base URL: `https://api.sigmacomputing.com`
- URL: `https://api.sigmacomputing.com/v2/workspaces/{workspaceId}`
- Auth: HTTP bearer

This endpoint retrieves the details of a specific workspace by its workspaceId.

### Usage notes
- Retrieve the **workspaceId** by calling the [/v2/workspaces](https://help.sigmacomputing.com/reference/list-workspaces) endpoint.

### Usage scenarios
- **Workspace management**: Useful for administrators or users who need to view the details of a specific workspace.
- **Integration checks**: Can be used by external systems to verify the existence and status of a workspace as part of integration workflows.

### Best practices
- **Validate workspaceId**: Ensure the workspaceId provided is valid and corresponds to an existing workspace. Handle any errors gracefully.
- **Access controls**: Implement proper authorization checks to ensure that only entitled users can access workspace details.

## Path parameters

- `workspaceId` string, required

## Response `200`

The response body.

- WorkspacesGetWorkspaceResponse200
  - `workspaceId` string, required
  - `workspaceUrlId` string, required: Base62-encoded identifier used in Sigma workspace URLs.
  - `name` string, required
  - `createdBy` string, required
  - `updatedBy` string, required
  - `createdAt` string, date-time, required
  - `updatedAt` string, date-time, required

---

[API](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api.md) - [All operations](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/llms.txt) - [OpenAPI document](https://skmtc.dev/sigmacomputing/apis/sigma-rest-api/revisions/fb6036208c49?raw)