GET/users/{userId}/tasks/search

사용자의 할 일을 검색한다.

Authorization

oauth2

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

Scope

task
task.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

사용자 ID


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

Query Parameters

ParameterTypeDescription
query string 

검색어(최소 1자, 최대 100자)

  • 제목, 내용, 담당자/요청자 이름을 통합 검색한다.
  • 미입력 시 assignorId, assigneeId, 기간(startTime/endTime) 중 하나 이상 필요하다.
  • 대소문자를 구분하지 않는다.
  • URL 인코딩이 필요하다.

minLength : 1
maxLength : 100
example : 주간 회의 
assignorId string 

요청자 ID

 
assigneeId string 

담당자 ID

 
startTime string 

기간 조회 시작 시각

  • ISO-8601 형식(YYYY-MM-DDThh:mm:ssTZD)으로 입력해야 한다.
  • startTime, endTime 미입력 시 전체 기간을 검색한다.
  • 최대 검색 기간 제한은 없다.

format : date-time 
endTime string 

기간 조회 종료 시각

  • ISO-8601 형식(YYYY-MM-DDThh:mm:ssTZD)으로 입력해야 한다.
  • startTime, endTime 미입력 시 전체 기간을 검색한다.
  • 최대 검색 기간 제한은 없다.

format : date-time 
status string 

완료 상태


Allowed values : DONE, TODO 
hasDueDate boolean 

기한 존재 여부

  • 미지정 시 기한이 있는 할 일과 없는 할 일을 모두 포함한다.
  • true: 기한이 있는 할 일만 검색한다.
  • false: 기한이 없는 할 일만 검색한다.
 
hasAttachment boolean 

첨부 파일 존재 여부

  • true: 첨부파일이 있는 task만 조회
  • false (기본값): 첨부파일 유무와 무관하게 모두 조회

default : false 
orderBy string 

정렬 기준

  • createdTime: 등록순
  • dueDate: 기한순

정렬 대상과 방식은 공백(URL 인코딩값: %20)으로 구분한다. 방식을 지정하지 않으면 기본값은 오름차순(asc)이며, 내림차순으로 조회하려면 desc로 지정한다. 단일 필드 정렬만 지원하며, 여러 필드를 쉼표(,)로 이어 전달할 수 없다.


default : createdTime
example : createdTime desc 
count integer 

한 번에 조회할 할 일 개수


default : 50
maximum : 100 
cursor string 

목록 커서값

 

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      "taskId": "95e426f5-9c85-4d28-9c41-f22950398c9c",5      "assignorId": "userf7da-f82c-4284-13e7-030f3b4c756x",6      "assignorName": "김철수",7      "assignees": [8        {9          "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c754x",10          "assigneeName": "홍길동",11          "status": "TODO"12        }13      ],14      "completionCondition": "MUST_ALL",15      "title": "주간 회의 준비",16      "content": "회의실 예약하기",17      "status": "TODO",18      "dueDate": "2024-05-25",19      "resourceLocation": 14101,20      "createdTime": "2024-04-04T04:52:06.405Z",21      "modifiedTime": "2024-04-04T05:41:52.624Z"22    }23  ],24  "responseMetaData": {25    "nextCursor": "H4sIAAAAAAAA_6tWSk4sSU3PL6r0TFGyUkopTda1MDAwM7UwN1LSUUouLS7Jz_UvSkktUrKqVsqHMJRyc3NzKpRqawHgjprNPQAAAA"26  }27}