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

# Get Workspace Details

> Get detailed information of a workspace by workspace ID



## OpenAPI

````yaml /docflow/en/rest-api/openapi.bundle.yaml get /api/app-api/sip/platform/v2/workspace/get
openapi: 3.0.0
info:
  title: DocFlow API
  description: >-
    DocFlow REST API, providing file upload and file processing result retrieval
    capabilities
  version: 2.8.4
servers:
  - url: https://docflow.textin.com
security:
  - ApiId: []
    SecretCode: []
paths:
  /api/app-api/sip/platform/v2/workspace/get:
    get:
      tags:
        - Workspace Management
      summary: Get Workspace Details
      description: Get detailed information of a workspace by workspace ID
      operationId: getWorkspace
      parameters:
        - name: workspace_id
          in: query
          description: Workspace ID
          required: true
          schema:
            type: string
            example: '1234567890'
      responses:
        '200':
          description: Successfully retrieved workspace details
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CodeMessage'
                  - type: object
                    properties:
                      result:
                        $ref: '#/components/schemas/Workspace'
components:
  schemas:
    CodeMessage:
      type: object
      properties:
        code:
          type: integer
          description: Status code
          example: 200
        msg:
          type: string
          description: Status description
      required:
        - code
        - msg
    Workspace:
      type: object
      description: Workspace
      properties:
        workspace_id:
          type: string
          description: Workspace ID (system generated)
          example: '1234567890'
        name:
          type: string
          description: Workspace name
          example: My Workspace
        description:
          type: string
          description: Workspace description
          example: This is a workspace for invoice processing
        auth_scope:
          type: integer
          description: >-
            Collaboration scope 0: Visible only to self 1: Visible to enterprise
            members
          example: 1
          enum:
            - 0
            - 1
        manage_account_id:
          type: string
          description: Workspace administrator ID
          example: admin_123456
        manage_account_name:
          type: string
          description: Workspace administrator name
          example: John Doe
        callback_url:
          type: string
          description: Callback URL
          example: https://example.com/callback
        callback_retry_time:
          type: integer
          description: Callback retry count
          example: 3
      required:
        - workspace_id
        - name
  securitySchemes:
    ApiId:
      type: apiKey
      in: header
      name: x-ti-app-id
    SecretCode:
      type: apiKey
      in: header
      name: x-ti-secret-code

````