> ## Documentation Index
> Fetch the complete documentation index at: https://docs.peaka.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Read Workspace

> 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.


<span style={{display: "flex", gap: "10px", flexDirection: "row", alignItems: "center"}}>
  <img src="https://cdn.peaka.com/badges/partner-api-key-badge.png" />
</span>


## OpenAPI

````yaml get /organizations/{organizationId}/workspaces/{workspaceId}
openapi: 3.0.1
info:
  title: Peaka Gateway API
  description: Peaka Gateway API Documentation
  version: '1.0'
servers:
  - url: https://partner.peaka.studio/api/v1
    description: Default Server URL (US Zone)
  - url: https://partner.eu.peaka.studio/api/v1
    description: EU Zone
security:
  - bearerAuth: []
paths:
  /organizations/{organizationId}/workspaces/{workspaceId}:
    get:
      tags:
        - Organization -- Workspaces
      summary: Read Workspace
      description: >
        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.
      operationId: getWorkspace
      parameters:
        - name: organizationId
          in: path
          description: Organization ID
          required: true
          schema:
            type: string
          example: d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef
        - name: workspaceId
          in: path
          description: Workspace ID
          required: true
          schema:
            type: string
          example: 56d43968-e31d-4010-9b75-018a79a51b17
      responses:
        '200':
          description: Successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
              examples:
                Read Workspace example:
                  description: Read Workspace example
                  value:
                    id: 8eefb5a9-59f7-43cc-bacb-f0b0e0d1b0ea
                    name: workspace 1
                    createdBy: 1673d60f-a0ea-41f4-9420-c91dbc2864f5
                    organizationId: d0d3c83f-29ed-4f2e-899d-1bfa00eb3cef
                    description: workspace description
                    createdAt: null
                    defaultWorkspace: false
components:
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: string
          description: The unique identifier of the workspace
          format: uuid
        name:
          type: string
          description: The name of the workspace
        createdBy:
          type: string
          description: The unique identifier of the user who created the workspace
          format: uuid
        organizationId:
          type: string
          description: >-
            The unique identifier of the organization to which the workspace
            belongs
          format: uuid
        description:
          type: string
          description: Descriptive text about the workspace
        createdAt:
          type: string
          description: The date and time the workspace was created
        defaultWorkspace:
          type: boolean
          description: |-
            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.
  securitySchemes:
    bearerAuth:
      type: http
      description: >-
        Use the Authorization header with the value 'Bearer <apiKey>' to
        authenticate. Partner API Keys have full access; Project API Keys are
        limited to their project scope. Learn more:
        https://docs.peaka.com/api-reference/authentication
      scheme: bearer
      bearerFormat: Api Key

````