> ## 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.

# カテゴリサンプル一覧を取得

> 指定したファイルカテゴリのサンプル一覧を取得します



## OpenAPI

````yaml /docflow-global/ja/rest-api/openapi.bundle.yaml get /api/app-api/sip/platform/v2/category/sample/list
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/category/sample/list:
    get:
      tags:
        - ファイルカテゴリサンプル
      summary: カテゴリサンプル一覧を取得
      description: 指定したファイルカテゴリのサンプル一覧を取得します
      operationId: listCategorySamples
      parameters:
        - name: workspace_id
          in: query
          description: ワークスペース ID
          required: true
          schema:
            type: string
            example: '1234567890'
        - name: category_id
          in: query
          description: ファイルカテゴリ ID
          required: true
          schema:
            type: string
            example: '1234567890'
        - name: page
          in: query
          description: ページ番号
          required: false
          schema:
            type: integer
            default: 1
        - name: page_size
          in: query
          description: ページサイズ
          required: false
          schema:
            type: integer
            default: 20
      responses:
        '200':
          description: カテゴリサンプル一覧の取得に成功
          content:
            application/json:
              schema:
                allOf:
                  - $ref: '#/components/schemas/CodeMessage'
                  - type: object
                    properties:
                      result:
                        type: object
                        properties:
                          total:
                            type: integer
                            description: サンプル総数
                            example: 10
                          page:
                            type: integer
                            description: 現在のページ番号
                            example: 1
                          page_size:
                            type: integer
                            description: ページサイズ
                            example: 20
                          samples:
                            type: array
                            items:
                              $ref: '#/components/schemas/CategorySample'
components:
  schemas:
    CodeMessage:
      type: object
      properties:
        code:
          type: integer
          description: ステータスコード
          example: 200
        msg:
          type: string
          description: ステータス説明
      required:
        - code
        - msg
    CategorySample:
      type: object
      description: ファイルカテゴリサンプル
      properties:
        sample_id:
          type: string
          description: サンプル ID
          example: '1234567890'
        file_name:
          type: string
          description: ファイル名
          example: invoice_sample.pdf
      required:
        - sample_id
        - file_name
  securitySchemes:
    ApiId:
      type: apiKey
      in: header
      name: x-ti-app-id
    SecretCode:
      type: apiKey
      in: header
      name: x-ti-secret-code

````