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

# Get workspace

> Retrieve a workspace by ID. Active and archived workspaces are returned; deleted workspaces return 404.



## OpenAPI

````yaml /api-reference/v1/workspaces-v1.yaml get /workspaces/{workspace_id}
openapi: 3.0.3
info:
  title: Coval Workspaces API
  version: 1.0.0
  description: Manage workspaces for your organization.
  contact:
    name: Coval API Support
    email: support@coval.dev
    url: https://docs.coval.ai
  license:
    name: Proprietary
    url: https://coval.dev/terms
servers:
  - url: https://api.coval.dev/v1
    description: Production API
security:
  - ApiKeyAuth: []
tags:
  - name: Workspaces
    description: Workspace lifecycle operations
paths:
  /workspaces/{workspace_id}:
    parameters:
      - $ref: '#/components/parameters/WorkspaceId'
    get:
      tags:
        - Workspaces
      summary: Get workspace
      description: >-
        Retrieve a workspace by ID. Active and archived workspaces are returned;
        deleted workspaces return 404.
      operationId: getWorkspace
      responses:
        '200':
          description: Workspace retrieved successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/PermissionDenied'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalError'
        '503':
          $ref: '#/components/responses/ServiceUnavailable'
      security:
        - ApiKeyAuth: []
components:
  parameters:
    WorkspaceId:
      name: workspace_id
      in: path
      required: true
      schema:
        type: string
        minLength: 1
        maxLength: 26
      description: Workspace resource ID
  schemas:
    WorkspaceResponse:
      type: object
      required:
        - workspace
      properties:
        workspace:
          $ref: '#/components/schemas/WorkspaceResource'
    WorkspaceResource:
      type: object
      required:
        - id
        - slug
        - display_name
        - status
        - workspace_type
        - created_at
        - last_updated_at
      properties:
        id:
          type: string
          minLength: 1
          maxLength: 26
        slug:
          type: string
          deprecated: true
          description: Deprecated compatibility identifier. Use id to identify a workspace.
        display_name:
          type: string
        status:
          type: string
          enum:
            - ACTIVE
            - ARCHIVED
            - DELETED
        workspace_type:
          type: string
          enum:
            - DEFAULT
            - CUSTOM
        created_at:
          type: string
          format: date-time
        last_updated_at:
          type: string
          format: date-time
    ErrorResponse:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
            - details
          properties:
            code:
              type: string
              enum:
                - INVALID_ARGUMENT
                - UNAUTHENTICATED
                - PERMISSION_DENIED
                - NOT_FOUND
                - ALREADY_EXISTS
                - INTERNAL
            message:
              type: string
            details:
              type: array
              items:
                type: object
                properties:
                  field:
                    type: string
                    nullable: true
                  description:
                    type: string
  responses:
    Unauthorized:
      description: Authentication failed
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    PermissionDenied:
      description: API key lacks the required permission scope
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    NotFound:
      description: Workspace not found or belongs to a different organization
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    InternalError:
      description: Internal server error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ServiceUnavailable:
      description: >-
        Service temporarily unavailable (transient organization DB routing
        outage; retryable)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: X-API-Key
      description: API key for authentication

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.