GET/projects/{id}/tasklists.json
Get all Task Lists for a Project
Retrieves all project task lists.
Additional notes:
Pagination:By default we'll send back 250 task list/todo list records per page. Inspect the Response Headers for the following values:
- X-Page (The current page being returned)
- X-Pages (The total number of pages available)
- X-Records (The total number of items available) You can request a specific page by calling the same API call and adding the parameter &page=n where n is the page you want. e.g: &page=2 for page 2, &page=5 for page 5.
Path Params
- Name
id
- Type
- string
- required
- Description
Query Params
- Name
responsible-party-id
- Type
- string
- Description
- Name
getOverdueCount
- Type
- boolean
- Description
Passing getOverdueCount will return the number of overdue tasks overdue-count for each task list.
- Default
false
- Name
status
- Type
- string
- Description
You can use the status option to restrict the Task Lists returned
- Default
active
- Allowed values
all
active
completed
- Name
showMilestones
- Type
- boolean
- Description
Passing showMilestones=1 will add Milestone information in to the response, if a Milestone is attached to the Task List
- Default
false
- Name
getCompletedCount
- Type
- boolean
- Description
- Default
false
- Name
filter
- Type
- string
- Description
anytime, today, tomorrow, overdue, yesterday
- Name
updatedAfterDate
- Type
- string
- Description
Get all tasklists updated after a certain date.
- Name
sortby
- Type
- string
- Description
Sort tasks by a parameter
- Default
displayOrder
- Allowed values
name
status
duedateDESC
dateCreatedASC
dateCreatedDESC
dateUpdatedASC
dateUpdatedDESC
projectNameASC
projectNameDESC
displayOrder
- Name
searchTerm
- Type
- string
- Description
- Name
projectStatus
- Type
- string
- Description
- Name
showCompleted
- Type
- boolean
- Description
Return completed tasklists.
- Default
false
- Name
showDeleted
- Type
- boolean
- Description
Return deleted tasklists.
- Default
false
Responses
- Code
- 200
- Type
- object
- Schema
- Description
- 200 Response
200 Response
application/json
{
"STATUS": "OK",
"tasklists": [
{
"name": "Offering Checklist",
"pinned": false,
"milestone-id": "",
"description": "",
"uncompleted-count": 0,
"id": "671263",
"complete": false,
"private": false,
"isTemplate": false,
"position": 4048,
"status": "new",
"projectId": "223699",
"projectName": "New hires",
"DLM": 0
}
]
}