API

Build cool stuff that works with Remember The Milk.

menu

rtm.lists.getList

Description

Retrieves a list of lists.

Availability

Available in versions 1 and 2.

Authentication

This method requires authentication with read permissions.

Arguments

api_key (Required) 1 2
Your API application key. See here for more details.

Example Response

<lists>
  <list id="100653" name="Inbox"
       deleted="0" locked="1" archived="0" position="-1" smart="0" />
  <list id="387549" name="High Priority"
       deleted="0" locked="0" archived="0" position="0" smart="1">
    <filter>(priority:1)</filter>
  </list>
  <list id="387546" name="New List"
       deleted="0" locked="0" archived="0" position="0" smart="0" />
  <list id="100654" name="Personal"
       deleted="0" locked="0" archived="0" position="0" smart="0" />
  <list id="100655" name="Study"
       deleted="0" locked="0" archived="0" position="0" smart="0" />
  <list id="100656" name="Work"
       deleted="0" locked="0" archived="0" position="0" smart="0" />
  <list id="100657" name="Sent"
       deleted="0" locked="1" archived="0" position="1" smart="0" />
</lists>

Error Codes

96 Invalid signature
The passed signature was invalid.
97 Missing signature
The call required signing but no signature was sent.
98 Login failed / Invalid auth token
The login details or auth token passed were invalid.
99 User not logged in / Insufficient permissions
The method requires user authentication but the user was not logged in, or the authenticated method call did not have the required permissions.
100 Invalid API Key
The API key passed was not valid or has expired.
105 Service currently unavailable
The requested service is temporarily unavailable.
114 Invalid SOAP envelope
The SOAP envelope sent in the request could not be parsed.
115 Invalid XML-RPC Method Call
The XML-RPC request document could not be parsed.
120 Method not valid for requested version
The requested method is not compatible with the requested version.