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

# Retrieve instance workspace

> ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to breaking changes. Use with caution in production environments.

Retrieve the information of a given workspace. This endpoint can only be used by instance level admins.
To retrieve one of your workspaces, please use the GET /api/v3/workspaces/{id} endpoint.



## OpenAPI

````yaml /api-reference/openapi-v3-instance.yaml get /api/v3/instance/workspaces/{id}
openapi: 3.0.3
info:
  title: Paradigm API
  version: xenial-xerus (v3-instance)
  description: >-
    A versatile and adaptable tool designed to integrate Generative AI into your
    applications
servers:
  - url: https://paradigm.lighton.ai
security: []
tags:
  - name: Workspaces
    description: Operations about workspaces
paths:
  /api/v3/instance/workspaces/{id}:
    get:
      tags:
        - Workspaces
      summary: Retrieve instance workspace
      description: >-
        ⚠️ **ALPHA ENDPOINT** - This endpoint is in alpha and subject to
        breaking changes. Use with caution in production environments.


        Retrieve the information of a given workspace. This endpoint can only be
        used by instance level admins.

        To retrieve one of your workspaces, please use the GET
        /api/v3/workspaces/{id} endpoint.
      operationId: api_v3_instance_workspaces_retrieve
      parameters:
        - in: path
          name: id
          schema:
            type: integer
          description: The unique identifier of the workspace.
          required: true
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InstanceWorkspaceV3DetailsResponse'
          description: Workspace updated successfully
        '400':
          description: >-
            Bad Request - Invalid input parameters (empty name, name too long,
            unsupported fields, etc.)
        '401':
          description: Unauthenticated - Missing or invalid API key/session cookie
        '403':
          description: Unauthorized - User does not have instance-level permissions
        '404':
          description: Not Found - Workspace does not exist
      security:
        - bearerAuth: []
components:
  schemas:
    InstanceWorkspaceV3DetailsResponse:
      type: object
      description: V3 Response serializer for instance-level workspace operations.
      properties:
        id:
          type: integer
        name:
          type: string
        workspace_type:
          type: string
        document_upload_method:
          type: string
        description:
          type: string
        created_at:
          type: string
          format: date-time
        updated_at:
          type: string
          format: date-time
        user_role:
          type: string
          readOnly: true
        used_storage:
          type: number
          format: double
        files_count:
          type: integer
        company:
          $ref: '#/components/schemas/WorkspaceCompany'
      required:
        - company
        - created_at
        - description
        - document_upload_method
        - files_count
        - id
        - name
        - updated_at
        - used_storage
        - user_role
        - workspace_type
    WorkspaceCompany:
      type: object
      properties:
        id:
          type: integer
        name:
          type: string
      required:
        - id
        - name
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Bearer authentication header of the form `Bearer <token>`, where
        `<token>` is your auth token.

````