GET/users/{userId}/tasks

특정 개인 카테고리에 소속된 내 할 일 목록을 조회한다.

Authorization

oauth2

OAuth 2.0 인증.
자세한 인증 방식은 인가·인증를 참고한다.

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 

목록 커서값

 
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: 미완료 상태

참고

  • 추가되는 담당자의 status는 항상 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: 미완료 상태

참고

  • 추가되는 담당자의 status는 항상 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": "홍길동",8          "status": "TODO"9        },10        {11          "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c756x",12          "assigneeName": "김철수",13          "status": "TODO"14        }15      ],16      "assignorId": "userf7da-f82c-4284-13e7-030f3b4c756x",17      "assignorName": "김철수",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}