The API described in this document is obsolete. It is documented here only for the support of legacy applications that might be using it. New applications are encouraged to use the newer, REST-based API. Older applications, too, are encouraged to switch to the newer API.
This will return the metadata for all of the lists in a given project. You can further constrain the query to only return those lists that are “complete” (have no uncompleted items) or “uncomplete” (have uncompleted items remaining).
<request>
<complete>#{true|false}</complete> <!-- optional -->
</request>
<todo-lists>
<todo-list>
...
</todo-list>
<todo-list>
...
</todo-list>
...
</todo-lists>
This will return the metadata and items for a specific list.
<todo-list>
...
<todo-items>
...
</todo-items>
</todo-list>
This will create a new, empty list. You can create the list explicitly, or by giving it a list template id to base the new list off of.
<request>
<milestone-id>#{milestone_id}</milestone-id> <!-- optional -->
<private>#{true|false}</private> <!-- optional -->
<tracked>#{true|false}</tracked> <!-- enable/disable time tracking -->
<!-- if created from explicit metadata -->
<name>#{name}</name>
<description>#{description}</description>
<!-- if created by a template id -->
<use-template>true</use-template>
<template-id>#{template_id}</template-id>
</request>
<todo-list>
...
</todo-list>
This allows you to reposition a list relative to the other lists in the project. A list with position 1 will show up at the top of the page. Moving lists around lets you prioritize. Moving a list to a position less than 1, or more than the number of lists in a project, will force the position to be between 1 and the number of lists (inclusive).
<request>
<to>#{to}</to>
</request>
<todo-list>
...
</todo-list>
With this call you can alter the metadata for a list.
<request>
<list>
<name>#{name}</name>
<description>#{description}</description>
<milestone-id>#{milestone_id}</milestone-id>
<private>#{true|false}</private>
<tracked>#{true|false}</tracked> <!-- enable/disable time tracking -->
</list>
<request>
<todo-list>
...
</todo-list>
This call will delete the entire referenced list and all items associated with it. Use it with caution, because a deleted list cannot be restored!
<todo-list>
...
</todo-list>