GET/users/{userId}/tasks

ユーザーのマイタスクのリストを取得する。

Authorization

oauth2

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

Scope

task
task.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

ユーザー ID


required
example : userf7da-f82c-4284-13e7-030f3b4c756x 

Query Parameters

ParameterTypeDescription
categoryId string 

ユーザーのタスクカテゴリー ID


required 
count integer 

取得数


default : 50
minimum : 0
maximum : 100 
cursor string 

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

 
status string 

タスクの状態のフィルター条件

  • TODO: 未完了のタスクのみを取得
  • ALL: すべてのタスクを取得

default : TODO
Allowed values : TODO, ALL 
searchFilterType string 

タスクの検索範囲

  • ALL: すべてのタスク
  • ASSIGNEE: 自分のタスク
  • ASSIGNOR: 依頼したタスク

default : ALL
Allowed values : ALL, ASSIGNEE, ASSIGNOR 

Header Parameters

HeadertypeDescription
Authorization string 

Bearer {token}


required 

Response

HTTP 200

OK

PropertyTypeDescription
tasks array (Task) 
 
responseMetaData object (responseMetaData) 
 

Task

PropertyTypeDescription
assignees array (Assignee) 

担当者リスト

 
assignorId string 

依頼者 ID
削除されたアカウントは空白で表示される。

 
assignorName string 

依頼者名

 
completionCondition string 

完了条件

  • ANY_ONE: 担当者のうち誰か 1 人が完了
  • MUST_ALL: 担当者全員の完了が必要

注意

  • タスクの部分更新では、担当者が 2 人以上の場合にのみ指定できる。

Allowed values : ANY_ONE, MUST_ALL 
content string 

タスク内容

 
createdTime string 

登録日時 (YYYY-MM-DDThh:mm:ssTZD)


readOnly : true 
dueDate string 

期限 (YYYY-MM-DD)


nullable : true 
modifiedTime string 

更新日時 (YYYY-MM-DDThh:mm:ssTZD)


readOnly : true 
resourceLocation integer 

リソースロケーションコード


readOnly : true 
status string 

タスクの完了ステータス

  • DONE: 完了
  • TODO: 未完了

参考

  • 担当者を追加する場合には、常に TODO に設定する。
  • タスクの完了ステータスは、以下の API で変更する。
  • タスクの完了
  • タスクの完了取り消し
  • 自分のタスクの完了
  • 自分のタスクの完了取り消し

Allowed values : DONE, TODO 
taskId string 

タスク ID

 
title string 

件名

 

Assignee

PropertyTypeDescription
assigneeId string 

担当者 ID
削除されたアカウントは空白で表示される。


required 
assigneeName string 

担当者名


readOnly : true 
status string 

タスクの完了ステータス

  • DONE: 完了
  • TODO: 未完了

参考

  • 担当者を追加する場合には、常に TODO に設定する。
  • タスクの完了ステータスは、以下の API で変更する。
  • タスクの完了
  • タスクの完了取り消し
  • 自分のタスクの完了
  • 自分のタスクの完了取り消し

required
Allowed values : DONE, TODO 

responseMetaData

PropertyTypeDescription
nextCursor string 
 

Response Example

example

1{2  "tasks": [3    {4      "assignees": [5        {6          "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c754x",7          "assigneeName": "Susan Nielsen",8          "status": "TODO"9        },10        {11          "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c756x",12          "assigneeName": "Assignee Name",13          "status": "TODO"14        }15      ],16      "assignorId": "userf7da-f82c-4284-13e7-030f3b4c756x",17      "assignorName": "Assignor Name",18      "completionCondition": "MUST_ALL",19      "content": "タスク内容",20      "createdTime": "2024-04-04T04:52:06.405Z",21      "dueDate": null,22      "modifiedTime": "2024-04-04T05:41:52.624Z",23      "resourceLocation": 14101,24      "status": "TODO",25      "taskId": "95e426f5-9c85-4d28-9c41-f22950398c9c",26      "title": "タスク"27    }28  ],29  "responseMetaData": {30    "nextCursor": "H4sIAAAAAAAA_6tWSk4sSU3PL6r0TFGyUkopTda1MDAwM7UwN1LSUUouLS7Jz_UvSkktUrKqVsqHMJRyc3NzKpRqawHgjprNPQAAAA"31  }32}