GET/users/{userId}/tasks

Gets a list of my tasks that belong to a specified user's category.

Authorization

oauth2

OAuth 2.0 authentication.
For more information, see Authentication and Authorization.

Scope

task
task.read

HTTP Request

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

Path Parameters

ParameterTypeDescription
userId string 

User ID


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

Query Parameters

ParameterTypeDescription
categoryId string 

Task category ID


required 
count integer 

Number of tasks to get at once


default : 50
minimum : 0
maximum : 100 
cursor string 

Cursor value

 
status string 

Task status

  • TODO: Incomplete
  • ALL: All

default : TODO
Allowed values : TODO, ALL 
searchFilterType string 

Search filter type

  • ALL: All tasks
  • ASSIGNEE: Tasks assigned to me
  • ASSIGNOR: Tasks I assigned

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) 

Assignee information

 
assignorId string 

Assignor ID

  • If the member has been deleted, respond with an empty value.
 
assignorName string 

Assignor name

 
completionCondition string 

Completion options

  • ANY_ONE: A task that any one assignee can complete
  • MUST_ALL: A task that all assignees must complete.

Note

  • When updating a task, it is available only if there are two or more assignees.

Allowed values : ANY_ONE, MUST_ALL 
content string 

Content

 
createdTime string 

Creation time (YYYY-MM-DDThh:mm:ssTZD)


readOnly : true 
dueDate string 

Due date (YYYY-MM-DD)


nullable : true 
modifiedTime string 

Update time (YYYY-MM-DDThh:mm:ssTZD)


readOnly : true 
resourceLocation integer 

The instance where the original task is located


readOnly : true 
status string 

Task status

  • DONE: Complete
  • TODO: Incomplete

Note

  • The status of an assignee's new task is always set to TODO.
  • You can change the status of a task using the the following API operations.
  • Mark a task as complete
  • Mark a task as incomplete
  • Mark an assignee task as complete
  • Mark an assignee task as incomplete

Allowed values : DONE, TODO 
taskId string 

Task ID

 
title string 

Title

 

Assignee

PropertyTypeDescription
assigneeId string 

Assignee ID

  • If the member has been deleted, respond with an empty value.

required 
assigneeName string 

Assignee name


readOnly : true 
status string 

Task status

  • DONE: Complete
  • TODO: Incomplete

Note

  • The status of an assignee's new task is always set to TODO.
  • You can change the status of a task using the the following API operations.
  • Mark a task as complete
  • Mark a task as incomplete
  • Mark an assignee task as complete
  • Mark an assignee task as incomplete

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": "John Doe",8          "status": "TODO"9        },10        {11          "assigneeId": "userf7da-f82c-4284-13e7-030f3b4c756x",12          "assigneeName": "Jane Doe",13          "status": "TODO"14        }15      ],16      "assignorId": "userf7da-f82c-4284-13e7-030f3b4c756x",17      "assignorName": "Jane Doe",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": "Task content"27    }28  ],29  "responseMetaData": {30    "nextCursor": "H4sIAAAAAAAA_6tWSk4sSU3PL6r0TFGyUkopTda1MDAwM7UwN1LSUUouLS7Jz_UvSkktUrKqVsqHMJRyc3NzKpRqawHgjprNPQAAAA"31  }32}