Task lists API calls

---

Get all lists (across projects)

GET /taskLists?responsible=#{id}

Returns a list of task list records, with task records that are assigned to the given “responsible”. If no responsible is given, the current user is assumed to be the responsible. The responsible may be changed by setting the “responsible” parameter to a blank string (for unassigned items), a person-id, or a company-id.

Response

{
	"task-lists":[
		{
			"id":"39401801",
			"name":"List",
			"description":"",
			...
		},
		{
			"id":"88331743",
			"name":"Another list",
			"description":"",
			...
		},
		...
	]
}

---

Get all lists (within project)

GET /projects/#{project_id}/taskLists/#{filter}

Returns a list of task list records that are in the given project. By default, all lists are returned, but you can filter the result by giving the “filter” query parameter, set to “all” (the default), “pending” (for lists with uncompleted items), and “finished” (for lists that have no uncompleted items). The lists will be returned in priority order, as determined by their ordering. (See the “reorder lists” action.)

Response

{
	"task-lists":[
		{
			"id":"39401801",
			"name":"List",
			"description":"",
			...
		},
		{
			"id":"88331743",
			"name":"Another list",
			"description":"",
			...
		},
		...
	]
}

---

Get list

GET /taskLists/#{task_list_id}

Returns a single task list record identified by its integer ID.

Response

{
	"task-list":{
		"id":"39401801",
		"name":"List",
		"description":"",
		...
	}
}

---

Create list

POST /projects/#{project_id}/taskLists

Creates a new task list based on the submitted JSON data.

Request

{
	"task-list":{
		"milestone-id":"9876532",
		"name":"List",
		"description":"Description of the list",
		"is-private":"1", // 0 = public, 1 = private
	}
}

Response

Returns HTTP status code 201 (“Created”) on success. The response contain the new task list ID. On failure, a non-200 status code will be returned, possibly with error information in JSON format as the response's content.

{
	"task-list-id":"51730393"
}

---

Update list

PUT /taskLists/#{id}

Updates the specified task list record with the changes indicated by the submitted JSON data.

Request

{
	"task-list":{
		"name":"Updated list",
		"is-private":"0", // 0 = public, 1 = private
		"hidden":"1", // 0 = visible, 1 = hidden
		"position":"5"
	}
}

Response

Returns HTTP status code 200 on success, or any other code (and possibly error information in JSON format) on error.

---

Destroy list

DELETE /taskLists/#{id}

Destroys the given task list and all of its associated task items.

Response

Returns HTTP status code 200 on success, or any other code (and possibly error information in JSON format) on error.

---

Reorder lists

POST /projects/#{project_id}/taskLists/reorder

Reorders the lists in the project according to the ordering given. Any lists that are not explicitly specified will be positioned after the lists that are specified.

Request

{
	"task-lists":[
		"90818577",
		"34917854",
		"33146642",
		"1531984"
	]
}

Response

Returns HTTP status code 200 on success, or any other code (and possibly error information in JSON format) on error.