Services / API / Methods / rtm.lists.getList

Description

Retrieves a list of lists.

Authentication

This method requires authentication with read permissions.

Arguments

api_key (Required)

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

98: Login failed / Invalid auth token

The login details or auth token passed were invalid.

100: Invalid API Key

The API key passed was not valid or has expired.

105: Service currently unavailable

The requested service is temporarily unavailable.

111: Format "xxx" not found

The requested response format was not found.

112: Method "xxx" not found

The requested method was not found.

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.