---
title: "Read Workspace"
method: GET
path: "/organizations/{organizationId}/workspaces/{workspaceId}"
tags: ["Organization -- Workspaces"]
---

# Read Workspace

`GET /organizations/{organizationId}/workspaces/{workspaceId}`

## Request

- Base URL: `https://partner.peaka.studio/api/v1`
- URL: `https://partner.peaka.studio/api/v1/organizations/{organizationId}/workspaces/{workspaceId}`
- Auth: HTTP bearer

Returns details of a specified Workspace, which is a collaborative environment within an Organization that groups Projects together.

A Workspace facilitates team collaboration, resource management, and organization of data operations.

The hierarchical structure in Peaka is:

<code>Organization (top-level) → Workspace → Project</code>

Projects contain data catalogs and workflows that teams manage within a Workspace.

## Path parameters

- `organizationId` string, required
- `workspaceId` string, required

## Response `200`

Successful operation

- Workspace
  - `id` string, uuid: The unique identifier of the workspace
  - `name` string: The name of the workspace
  - `createdBy` string, uuid: The unique identifier of the user who created the workspace
  - `organizationId` string, uuid: The unique identifier of the organization to which the workspace belongs
  - `description` string: Descriptive text about the workspace
  - `createdAt` string: The date and time the workspace was created
  - `defaultWorkspace` boolean: Whether the workspace is the default workspace for the organization. This is a backward compatibility field in order to create projects in the default workspace if the workspace is not specified.

---

[API](https://skmtc.dev/peaka/apis/peaka-gateway-api.md) · [All operations](https://skmtc.dev/peaka/apis/peaka-gateway-api/llms.txt) · [OpenAPI document](https://skmtc.dev/peaka/apis/peaka-gateway-api/revisions/e68b033a22d5?raw)
