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

# Get workspace document

> get workspace document. GET /api/v1/workspace/documents/{document_id}. Uses the same payload, validation, revision checks and response as the unified HTTP API.

ReferenceApplies to: Unified engine deployments

## Related guidance

[Addresses and access](https://docs.e6data.com/transformation/http/access.md) · [Request identity](https://docs.e6data.com/transformation/http/request-identity.md) · [Errors and recovery](https://docs.e6data.com/transformation/http/errors.md) · [Pagination and results](https://docs.e6data.com/transformation/http/results.md)


## OpenAPI

````yaml openapi/transformation.json GET /api/v1/workspace/documents/{document_id}
openapi: 3.1.0
info:
  description: >-
    HTTP contracts for the Unified engine. Requests use the connected
    deployment's access model and configured owner. Response examples are
    illustrative; inspect your engine response in your client. SQL-managed
    secrets, credentials, streaming pipelines and maintenance run through
    session operations.
  title: Laminar Unified HTTP API
  version: v1
servers:
  - url: https://engine.example.com
    description: >-
      Example engine origin. Replace it with your deployment URL and any API
      mount prefix.
security: []
paths:
  /api/v1/workspace/documents/{document_id}:
    get:
      tags:
        - Workspace documents
      summary: get workspace document
      description: >-
        get workspace document. GET /api/v1/workspace/documents/{document_id}.
        Uses the same payload, validation, revision checks and response as the
        unified HTTP API.
      operationId: get_workspace_document
      parameters:
        - in: path
          name: document_id
          required: true
          schema:
            format: uuid
            type: string
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: >-
                  #/components/schemas/app_workspace_src_models_rs_DocumentResponse
          description: Successful response.
        default:
          content:
            application/json:
              example:
                error:
                  code: invalid_request
                  message: Check the request fields
              schema:
                $ref: '#/components/schemas/ApiError'
          description: A rejected or failed request. Inspect error.code before retrying.
components:
  schemas:
    app_workspace_src_models_rs_DocumentResponse:
      properties:
        document:
          $ref: '#/components/schemas/app_workspace_src_models_rs_WorkspaceDocument'
      required:
        - document
      type: object
    ApiError:
      properties:
        error:
          properties:
            code:
              type: string
            message:
              type: string
          required:
            - code
            - message
          type: object
      required:
        - error
      type: object
    app_workspace_src_models_rs_WorkspaceDocument:
      properties:
        body:
          $ref: '#/components/schemas/app_workspace_src_models_rs_DocumentBody'
        created_at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
        document_id:
          $ref: '#/components/schemas/app_workspace_src_models_rs_DocumentId'
        name:
          type: string
        revision:
          minimum: 0
          type: integer
        updated_at:
          $ref: '#/components/schemas/shared_common_src_time_rs_WallClockTimestamp'
      required:
        - document_id
        - name
        - body
        - revision
        - created_at
        - updated_at
      type: object
    app_workspace_src_models_rs_DocumentBody:
      oneOf:
        - allOf:
            - properties:
                type:
                  const: Query
              required:
                - type
              type: object
            - properties:
                settings:
                  anyOf:
                    - $ref: >-
                        #/components/schemas/shared_common_src_lib_rs_QuerySettings
                    - type: 'null'
                sql:
                  type: string
              required:
                - sql
              type: object
        - allOf:
            - properties:
                type:
                  const: Dashboard
              required:
                - type
              type: object
            - properties:
                widgets:
                  items:
                    $ref: >-
                      #/components/schemas/app_workspace_src_models_rs_DashboardWidget
                  type: array
              required:
                - widgets
              type: object
    shared_common_src_time_rs_WallClockTimestamp:
      properties:
        unix_millis:
          type: integer
      required:
        - unix_millis
      type: object
    app_workspace_src_models_rs_DocumentId:
      format: uuid
      type: string
    shared_common_src_lib_rs_QuerySettings:
      properties:
        ansi_enabled:
          type: boolean
        case_sensitive:
          type: boolean
        current_catalog:
          type: string
        namespace:
          items:
            type: string
          type: array
        time_zone:
          type: string
      required:
        - current_catalog
        - namespace
        - time_zone
        - case_sensitive
        - ansi_enabled
      type: object
    app_workspace_src_models_rs_DashboardWidget:
      properties:
        chart:
          $ref: '#/components/schemas/app_workspace_src_models_rs_ChartConfig'
        query_id:
          $ref: '#/components/schemas/app_workspace_src_models_rs_DocumentId'
        title:
          type: string
        widget_id:
          $ref: '#/components/schemas/app_workspace_src_models_rs_WidgetId'
      required:
        - widget_id
        - title
        - query_id
        - chart
      type: object
    app_workspace_src_models_rs_ChartConfig:
      properties:
        kind:
          $ref: '#/components/schemas/app_workspace_src_models_rs_ChartKind'
        x_column:
          anyOf:
            - type: string
            - type: 'null'
        y_columns:
          items:
            type: string
          type: array
      required:
        - kind
        - x_column
        - y_columns
      type: object
    app_workspace_src_models_rs_WidgetId:
      format: uuid
      type: string
    app_workspace_src_models_rs_ChartKind:
      oneOf:
        - const: Table
          type: string
        - const: Bar
          type: string
        - const: Line
          type: string
        - const: Area
          type: string
        - const: Pie
          type: string
        - const: Stat
          type: string

````

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