GET/paperon/projects/{projectId}/files

PaperOn のファイルリストを取得します。

Authorization

oauth2

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

Scope

paperon
paperon.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/paperon/projects/{projectId}/files

Path Parameters

ParameterTypeDescription
projectId string 

プロジェクト ID


required
example : 550e8400-e29b-41d4-a716-446655440000 

Query Parameters

ParameterTypeDescription
approvalStatus string 

ファイルステータス

  • extraction_processing : OCR 読み取り中の状態。この状態のファイルは、ファイルの取得、部分更新、原本ファイルのダウンロード、読み取り結果の取得はできません。
  • new : 新規。ファイルが登録され、OCR 読み取りが完了した状態。
  • extraction_failed : 失敗。(読み取り失敗や読み取り回数の不足)
  • pending : 承認申請。ユーザーが読み取り結果を修正し、承認をリクエストした状態。
  • approved : 承認。
  • rejected : 差し戻し。承認リクエストされたファイルについて再確認が求められている状態、
  • completed : 完了。

Allowed values : extraction_processing, new, extraction_failed, pending, approved, rejected, completed 
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
files array (object) 

ファイルリスト

 
responseMetaData object (responseMetaData) 
 

object

PropertyTypeDescription
fileId string 

ファイル ID

 
fileName string 

ファイル名

 
approvalStatus string 

ファイルステータス

  • extraction_processing : OCR 読み取り中の状態。この状態のファイルは、ファイルの取得、部分更新、原本ファイルのダウンロード、読み取り結果の取得はできません。
  • new : 新規。ファイルが登録され、OCR 読み取りが完了した状態。
  • extraction_failed : 失敗。(読み取り失敗や読み取り回数の不足)
  • pending : 承認申請。ユーザーが読み取り結果を修正し、承認をリクエストした状態。
  • approved : 承認。
  • rejected : 差し戻し。承認リクエストされたファイルについて再確認が求められている状態、
  • completed : 完了。

Allowed values : extraction_processing, new, extraction_failed, pending, approved, rejected, completed 
uploaderId string 

アップロード ユーザー ID
削除されたユーザーや、外部からのメールによるアップロードなど、アップロード ユーザー情報が特定できない場合には null


nullable : true 
uploaderName string 

アップロード ユーザー名。メールによるアップロードの場合には 'Upload by email' と記載される。

 
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 

responseMetaData

PropertyTypeDescription
nextCursor string 

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


nullable : true 

Response Example

example

1{2  "files": [3    {4      "fileId": "550e8400-e29b-41d4-a716-446655440000",5      "fileName": "example.pdf",6      "approvalStatus": "approved",7      "uploaderId": "userf7da-f82c-4284-13e7-030f3b4c756x",8      "uploaderName": "ワークス太郎",9      "createdTime": "2026-04-09T14:20:30+09:00",10      "modifiedTime": "2026-04-09T14:20:30+09:00"11    }12  ],13  "responseMetaData": {14    "nextCursor": "eyJjcmVhdGVkVGltZSI6MTY2NzM3MzQ0MCwib2Zmc2V0IjozLCJsaW1pdCI6M30"15  }16}