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

# Get a workspace

> Retrieve a single Workspace by its ID or key



## OpenAPI

````yaml https://api.qlty.sh/openapi.json get /workspaces/{keyOrId}
openapi: 3.1.0
info:
  title: Qlty API
  version: 1.0.0
  description: >-
    The Qlty API is organized around REST. It provides predictable,
    resource-oriented URLs, accepts JSON-encoded request bodies, and returns
    JSON-encoded responses.
servers:
  - url: https://api.qlty.sh
security:
  - Bearer: []
tags:
  - name: Service
    description: Service status and API discovery operations
  - name: User
    description: Operations for the authenticated user
  - name: Workspaces
    description: Operations for managing workspaces
  - name: Projects
    description: Operations for managing projects
  - name: Issues
    description: Operations for managing issues
  - name: Metrics
    description: Operations for retrieving metrics
  - name: Components
    description: Operations for retrieving components
  - name: Coverage
    description: Operations for retrieving code coverage data
paths:
  /workspaces/{keyOrId}:
    get:
      tags:
        - Workspaces
      summary: Get a workspace
      description: Retrieve a single Workspace by its ID or key
      operationId: getWorkspace
      parameters:
        - schema:
            type: string
            minLength: 3
            example: my-workspace
            description: Workspace key or ID
          required: true
          description: Workspace key or ID
          name: keyOrId
          in: path
      responses:
        '200':
          description: Retrieve the workspace
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
              example:
                id: 1c47b6fd-db56-4fbd-9cf0-4d88f9631050
                key: acmeco
                avatarUrl: https://assets.github.com/acmeco.png
                providerUrl: https://github.com/acmeco
                createdAt: '2023-01-15T08:30:00Z'
                updatedAt: '2023-02-20T14:45:00Z'
        '400':
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not Found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '429':
          description: Rate Limit Exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '500':
          description: Internal Server Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: string
          example: ws_abc123
        key:
          type: string
          example: my-workspace
        avatarUrl:
          type: string
          example: https://example.com/avatar.png
        providerUrl:
          type: string
          example: https://github.com/my-workspace
        createdAt:
          type: string
          format: date-time
          example: '2024-01-01T00:00:00.000Z'
        updatedAt:
          type: string
          format: date-time
          example: '2024-01-01T00:00:00.000Z'
      required:
        - id
        - key
        - avatarUrl
        - providerUrl
        - createdAt
        - updatedAt
    Error:
      type: object
      properties:
        errors:
          type: array
          items:
            type: object
            properties:
              status:
                type: string
                example: '400'
              title:
                type: string
                example: Bad Request
              detail:
                type: string
                example: The request was invalid.
            required:
              - status
              - title
              - detail
      required:
        - errors
  securitySchemes:
    Bearer:
      type: http
      scheme: bearer
      description: Generate an API token at https://qlty.sh/user/settings/tokens

````