GET/paperon/projects

PaperOn プロジェクトのリストを取得する。

Authorization

oauth2

Access Token を指定します。
指定の方法や Access Token の取得方法は 共通仕様 を参照してください。

Scope

paperon
paperon.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/paperon/projects

Query Parameters

ParameterTypeDescription
orderBy string 

ソート基準。ソートフィールドと並び順を空白 (%20) で区切って指定する。
例) createdTime%20desc

  • プロジェクトリスト: createdTime, modifiedTime
  • ファイルリスト: fileName, fileStatus, uploaderName, createdTime
  • 並び順: asc (既定: 省略可能), desc

default : createdTime desc
example : createdTime desc 
count integer 

取得数


default : 100
minimum : 1
maximum : 100 
cursor string 

カーソル値


example : eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
projects array (object) 

プロジェクトリスト

 
responseMetaData object (responseMetaData) 
 

object

PropertyTypeDescription
projectId string 

プロジェクト ID

 
projectName string 

プロジェクト名

 
description string 

プロジェクトのステータス

 
ocrModelType string 

OCR モデル。
読み取り結果の取得で得られる contents 配列の構造に影響する。

  • general : 全文/表認識(General OCR)。文書の内容に応じて、テキスト（txt）とテーブル（csv/xlsx）のセグメントを返す。
  • template : テンプレート。テーブル（csv/xlsx）セグメントを 1 件返す。
  • invoice : 請求書。テーブル（csv/xlsx）セグメントを 1 件返す。
  • order_form : 注文書。テーブル（csv/xlsx）セグメントを 1 件返す。
  • receipt : レシート・領収書。テーブル（csv/xlsx）セグメントを 1 件返す。
  • ai_recommendation : AIおまかせ。AIが文書タイプを分析し、項目を自動推奨するモデル。

Allowed values : general, template, invoice, order_form, receipt, ai_recommendation 
approvalStatusCount object (approvalStatusCount) 

状態別のファイル数

 
createdTime string 

作成日時 (ISO 8601)


example : 2026-04-09T14:20:30+09:00
format : date-time 
modifiedTime string 

更新日時 (ISO 8601)


example : 2026-04-09T14:20:30+09:00
format : date-time 

approvalStatusCount

PropertyTypeDescription
extraction_processing integer 

OCR 読み取り中のファイル数

 
new integer 

新規状態のファイル数

 
extraction_failed integer 

読み取り失敗状態のファイル数

 
pending integer 

承認申請状態のファイル数

 
approved integer 

承認状態のファイル数

 
rejected integer 

差し戻し状態のファイル数

 
completed integer 

完了状態のファイル数

 

responseMetaData

PropertyTypeDescription
nextCursor string 

次のリスト取得時に使用するカーソル値


nullable : true 

Response Example

example

1{2  "projects": [3    {4      "projectId": "550e8400-e29b-41d4-a716-446655440000",5      "projectName": "プロジェクト名",6      "description": "プロジェクトの説明",7      "ocrModelType": "template",8      "approvalStatusCount": {9        "extraction_processing": 2,10        "new": 5,11        "extraction_failed": 0,12        "pending": 1,13        "approved": 3,14        "rejected": 0,15        "completed": 216      },17      "createdTime": "2026-04-09T14:20:30+09:00",18      "modifiedTime": "2026-04-09T14:20:30+09:00"19    }20  ],21  "responseMetaData": {22    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30"23  }24}