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

# Get Workspace By ID

> Fetches detailed information about a specific security workspace using its unique identifier, including all associated metadata and configuration.



## OpenAPI

````yaml /api-reference/openapi.json get /api/workspaces/{id}
openapi: 3.0.0
info:
  title: Open Attack Surface Management
  description: Open-source platform for cybersecurity Attack Surface Management (ASM)
  version: '1.0'
  contact: {}
servers:
  - url: https://{baseUrl}/api/v1
    variables:
      baseUrl:
        default: localhost:3000
        description: API server hostname with port (e.g. localhost:3000, api.example.com)
security: []
tags: []
externalDocs:
  description: Authentication Docs
  url: auth/docs
paths:
  /api/workspaces/{id}:
    get:
      tags:
        - Workspaces
      summary: Get Workspace By ID
      description: >-
        Fetches detailed information about a specific security workspace using
        its unique identifier, including all associated metadata and
        configuration.
      operationId: WorkspacesController_getWorkspaceById
      parameters:
        - name: id
          required: true
          in: path
          description: The id of the resource
          schema:
            type: string
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Workspace'
                allOf:
                  - $ref: '#/components/schemas/AppResponseSerialization'
components:
  schemas:
    Workspace:
      type: object
      properties:
        id:
          type: string
        createdAt:
          format: date-time
          type: string
        updatedAt:
          format: date-time
          type: string
        name:
          type: string
          example: My Workspace
          description: The name of the workspace
        description:
          type: string
          example: This is my workspace
          description: The description of the workspace
        archivedAt:
          type: object
        isAssetsDiscovery:
          type: boolean
          example: true
          default: true
          title: Asset discovery
          description: >-
            Automatically scan and detect internet-facing assets (domains, IPs)
            in workspace networks
        isAutoEnableAssetAfterDiscovered:
          type: boolean
          example: true
          default: true
          title: Auto enable assets
          description: >-
            Newly discovered assets become active immediately without manual
            review
        dek:
          type: object
          description: >-
            Encrypted Data Encryption Key (DEK) for this workspace. Encrypted
            with system KEK. Null for workspaces created before envelope
            encryption.
          nullable: true
        dekAt:
          type: object
          description: Timestamp when DEK was generated
          nullable: true
      required:
        - id
        - createdAt
        - updatedAt
        - name
        - description
        - isAssetsDiscovery
        - isAutoEnableAssetAfterDiscovered

````