Get all Tasks on a given Task List
Get all Tasks on a given Task List
-
When getting tasks associated with a task list the responsible-party-ids is only returned if the task is assigned to one or more people. If it is not returned then the task is considered assigned to Anyone.
-
DLM is a time stamp and stands for Date Last Modified. We use this internally for our caching system to make sure we can return data to the API calls quickly. Its not guaranteed to be in the response and can be safely ignored if you see it.
-
Status is the current status of the task and could be one of the following: deleted, completed, reopened, new
-
Private will return a 0, 1 or 2. An open task will be '0', A private task will be '1' and a task which is in a private list will be a '2' as it will inherit the privacy from the parent task list (or parent task)
-
A flag canEdit is returned with each task.
-
This call uses pagination. 250 tasks per page.
Path Params
- Name
id- Type
- string
- required
- Description
Query Params
- Name
filter- Type
- string
- Description
Tasks can be filtered by due dates using the following options: all anytime overdue today tomorrow thisweek within7 within14 within30 within365 nodate nostartdate completed Additionally, you can choose to include the start dates in this critera by setting ignore-start-dates to false.
- Name
page- Type
- integer
- Description
Optionally, you can set the page from which to start retrieving results. This is usually used in conjunction with the parameter pageSize.
See How does paging work for more detailed documentation on pagination. For example: ?page=2&pageSize=10 will retrieve results 10-20.
- Name
pageSize- Type
- integer
- Description
The amount of tasks returned can be limited using this parameter. Normally used in conjunction with the page parameter.
Minimum: 1 Maximum: 250
- Default
250
- Name
startDate- Type
- string
- Description
Tasks within a range of dates can be returned by setting a startdate and enddate. The format should be YYYYMMDD. For example: ?startdate=20140512&enddate=20140513 will get all of the tasks from the 12th of May 2014 till the 13th of May 2014.
By default ignore-start-dates=false and that means we list:
- tasks started before or on specified startDate AND due before/on specified endDate
- OR no start date but due date between specified dates
- OR no duedate set but startdate has passed/is specified startDate
- OR milestone due date set and its between specified dates
- Name
endDate- Type
- string
- Description
Must be used in conjunction with startdate, see above.
- Name
updatedAfterDate- Type
- string
- Description
Will only return tasks that have been updated after a specified date. Timestamp must be in the following format: YYYYMMDDHHMMSS. For example: ?updatedAfterDate=20131123201022 will only return tasks updated after 23rd of November 2013 at 20:10:22. (UTC)
- Name
completedAfterDate- Type
- string
- Description
Will only return tasks that have been completed after a specified date. Timestamp must be in the following format: YYYYMMDDHHMMSS For example: ?completedAfterDate=20141123201022 will only return tasks completed after 23rd of November 2014 at 20:10:22. (UTC)
- Name
completedBeforeDate- Type
- string
- Description
Will only return tasks that have been completed before a specified date. Timestamp must be in the following format: YYYYMMDDHHMMSS For example: ?completedBeforeDate=20150101235959 will only return tasks completed before 1st January 2015 at 23:59:59. (UTC)
- Name
showDeleted- Type
- string
- Description
Tasks that have been deleted can be shown by setting this parameter to yes.
- Name
includeCompletedTasks- Type
- boolean
- Description
Tasks that have been marked as completed can be shown by setting this parameter to true.
- Default
false
- Name
includeCompletedSubtasks- Type
- boolean
- Description
Sub-tasks that have been marked as completed can be shown by setting this parameter to true if you have requested to include sub-tasks
- Default
false
- Name
creator-ids- Type
- string
- Description
For requesting tasks made by a specific person or people. For example: 44 would return tasks made by user 44. 44,45 would return tasks made by users 44 and/or 45 etc.
- Name
include- Type
- string
- Description
Extra tasks that can be included with the filter option. nodate nostartdate noduedate overdue
- Name
responsible-party-ids- Type
- string
- Description
Tasks can be filtered by the person/people a task is assigned to. For example: -1 would return all tasks with an assigned person. 0 would return all tasks with no assignment. 32 would return tasks assigned to user 32. 32,55 would return tasks assigned to users 32 and/or 55 etc.
- Name
sort- Type
- string
- Description
Sort tasks by a parameter
- Allowed values
duedateduedateDESCstartdatedateaddedpriorityprojectmanualduestartdateduestartdatedescalldatesalldatesdesccompletedDateDESCflattenedtasklistcompanydateupdated
- Name
getSubTasks- Type
- string
- Description
Subtasks can be excluded from the results by adding this parameter with no as the value.
- Name
nestSubTasks- Type
- string
- Description
no Subtasks can be nested within the parent task object by adding this paramter with yes as the value.
- Name
getFiles- Type
- boolean
- Description
Files attached to tasks can be returned within the task object by setting this parameter to true.
- Default
false
- Name
includeToday- Type
- boolean
- Description
When using the filter option with any of the following options; within7,within14,within30,within365. You can choose to exclude deadlines for today by passing this parameter as false.
- Default
false
- Name
ignore-start-dates- Type
- boolean
- Description
When using the filter option, you can choose to include start dates matching the filtering critera by passing this parameter as true. By default, only due dates are checked against the filter.
- Default
false
- Name
tag-ids- Type
- string
- Description
A comma separated list of tag ids to filter tasks on
- Name
dateupdatedASC- Type
- string
- Description
Sort tasks by a parameter
- Allowed values
duedateduedateDESCstartdatedateaddedpriorityprojectmanualduestartdateduestartdatedescalldatesalldatesdesccompletedDateDESCflattenedtasklistcompanydateupdated
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 Response
200 Response
{
"STATUS": "OK",
"todo-items": [
{
"id": 1,
"canComplete": true,
"comments-count": 0,
"description": "Test Task Sub Item",
"has-reminders": false,
"has-unread-comments": false,
"private": 0,
"content": "Test Task",
"order": 1995,
"project-id": 223699,
"project-name": "New hires",
"todo-list-id": 667675,
"todo-list-name": "Testing default list",
"tasklist-private": false,
"tasklist-isTemplate": false,
"status": "new",
"company-name": "Teamwork",
"company-id": 78494,
"creator-id": 157140,
"creator-firstname": "Holly",
"creator-lastname": "Smith",
"completed": false,
"start-date": "",
"due-date-base": "",
"due-date": "",
"created-on": "2018-01-29T11:49:00Z",
"last-changed-on": "2018-02-06T08:37:28Z",
"position": 1995,
"estimated-minutes": 0,
"priority": "",
"progress": 0,
"harvest-enabled": false,
"parentTaskId": "",
"lockdownId": "",
"tasklist-lockdownId": "",
"has-dependencies": 0,
"has-predecessors": 0,
"hasTickets": false,
"tags": [
{
"id": 17062,
"name": "API",
"color": "#2f8de4"
},
{
"id": 17102,
"name": "documentation",
"color": "#2f8de4"
},
{
"id": 17097,
"name": "bugs",
"color": "#2f8de4"
}
],
"timeIsLogged": "0",
"attachments-count": 0,
"responsible-party-ids": "157302",
"responsible-party-id": "157302",
"responsible-party-names": "Roisin M.",
"responsible-party-type": "Person",
"responsible-party-firstname": "Roisin",
"responsible-party-lastname": "Smith",
"responsible-party-summary": "Roisin M.",
"predecessors": [],
"canEdit": true,
"viewEstimatedTime": true,
"creator-avatar-url": "https://s3-eu-west-1.amazonaws.com/tw-eu-files/437949/userAvatar/twia_48d6f52851b177a01334bd95b32c49fb.png",
"canLogTime": true,
"userFollowingComments": false,
"userFollowingChanges": false,
"DLM": 0
}
]
}