GET/workflow/users/{userId}/documents

メンバーとして決裁文書のリストを取得する。
作成日フィルタは、最大で 1ヶ月の範囲まで指定できる。
ユーザーアカウントで取得した Access Token を利用してアクセスしてください。

Authorization

oauth2

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

Scope

workflow
workflow.read

HTTP Request

GEThttps://www.worksapis.com/v1.0/workflow/users/{userId}/documents

Path Parameters

ParameterTypeDescription
userId string 

ユーザー ID またはログイン ID


required 

Query Parameters

ParameterTypeDescription
fromDateTime string 

作成日フィルタの開始日（形式:YYYY-MM-DD）


required
example : 2026-01-01 
untilDateTime string 

作成日フィルタの終了日（形式:YYYY-MM-DD）


required
example : 2026-01-20 
documentFormId string 

申請フォーマット ID

 
type string 

決裁文書のタイプ。入力しなければ全体文書を照会する。

  • pending: 承認待ち
  • upcoming: 予定されている進行中文書
  • approved: 対応済みの進行中文書
  • completed: 完了

Allowed values : pending, upcoming, approved, completed 
orderBy string 

並べ替え方法。並べ替え項目と順序を空白（%20）で区切って入力する。

  • ソート項目: createdTime, documentNumber
  • 順序: asc(昇順), desc(降順)

example : createdTime%20desc 
count integer 

取得数


default : 10
minimum : 10
maximum : 50
example : 10
format : int32 
cursor string 

リストのカーソル値 (URL エンコードする)


example : JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA== 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
documents array (ApprovalDocument) 
 
responseMetaData object (responseMetaData) 

レスポンスのメタデータ

 

ApprovalDocument

PropertyTypeDescription
domainId integer 

ドメインID


required 
approvalDocumentId integer 

決裁文書ID


required 
documentFormId string 

申請フォーマット ID


required 
categoryId integer 

カテゴリー ID


required 
documentNumber string 

文書番号

 
title string 

タイトル

 
userId string 

申請者 ID

 
userName string 

申請者

 
status string 

決裁文書のステータス

  • IN-PROGRESS: 進行中
  • APPROVED: 完了
  • REJECTED: 却下
  • CANCELED: 引き戻し
 
createdTime string 

作成日時（形式：YYYY-MM-DDThh:mm:ssTZD）


required 
completedTime string 

完了日時（形式：YYYY-MM-DDThh:mm:ssTZD）

 
visible boolean 

文書の公開フラグ

 

responseMetaData

PropertyTypeDescription
nextCursor string 

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

 

Response Example

example

1{2  "documents": [3    {4      "domainId": 10000001,5      "approvalDocumentId": 10001,6      "documentFormId": "16d11974-1234-1234-1234-52322ff286ee",7      "categoryId": 10,8      "documentNumber": "2026-CUS001-00001",9      "title": "休暇使用計画書",10      "userId": "userf7da-1234-1234-1234-030f3b4c756x",11      "userName": "ワークス太郎",12      "status": "APPROVED",13      "createdTime": "2026-01-01T10:00:00+09:00",14      "completedTime": "2026-01-02T11:30:00+09:00",15      "visible": true16    }17  ],18  "responseMetaData": {19    "nextCursor": "JlIBsfJogXpzDGY8OscZziqZpYqCAu3RbZbaFzBb1od6lWQtSdPUd2FIdCuaGgu8DA=="20  }21}