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

# ワークスペース詳細を取得

> ワークスペース ID を指定してワークスペースの詳細情報を取得します



## OpenAPI

````yaml /docflow-global/ja/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。ファイルアップロードとファイル処理結果の取得機能を提供します。
  version: 2.8.4
  contact:
    name: TextIn
    url: https://www.textin.ai/contact?type=27&sub_type=1
servers:
  - url: https://docflow.textin.ai
security:
  - ApiId: []
    SecretCode: []
tags:
  - name: ワークスペース管理
    description: ワークスペース関連 API
  - name: ファイルカテゴリ
    description: ファイルカテゴリ関連 API
  - name: ファイルカテゴリサンプル
    description: ファイルカテゴリサンプル関連 API
  - name: スマートレビュー
    description: スマートレビュー関連 API
  - name: 廃止済み
    description: 廃止済み API
paths:
  /api/app-api/sip/platform/v2/workspace/get:
    get:
      tags:
        - ワークスペース管理
      summary: ワークスペース詳細を取得
      description: ワークスペース ID を指定してワークスペースの詳細情報を取得します
      operationId: getWorkspace
      parameters:
        - name: workspace_id
          in: query
          description: ワークスペース ID
          required: true
          schema:
            type: string
            example: '1234567890'
      responses:
        '200':
          description: ワークスペース詳細の取得に成功
          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: ステータスコード
          example: 200
        msg:
          type: string
          description: ステータス説明
      required:
        - code
        - msg
    Workspace:
      type: object
      description: ワークスペース
      properties:
        workspace_id:
          type: string
          description: ワークスペース ID（システム生成）
          example: '1234567890'
        name:
          type: string
          description: ワークスペース名
          example: My ワークスペース
        description:
          type: string
          description: ワークスペースの説明
          example: 請求書処理用のワークスペースです
        auth_scope:
          type: integer
          description: '共同利用範囲 0: 自分のみ表示 1: エンタープライズメンバーに表示'
          example: 1
          enum:
            - 0
            - 1
        manage_account_id:
          type: string
          description: ワークスペース管理者 ID
          example: admin_123456
        manage_account_name:
          type: string
          description: ワークスペース管理者名
          example: 山田太郎
        callback_url:
          type: string
          description: コールバック URL
          example: https://example.com/callback
        callback_retry_time:
          type: integer
          description: コールバック再試行回数
          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

````