Welcome to the Todo.ly API wiki
Todo.ly exposes its data via an Application Programming Interface (API). This document is the official reference for that functionality. This API is inspired by the Twitter API.
The API is entirely HTTP-based
Methods to retrieve data from the this API require a GET request. Methods that submit, change, or destroy data require a POST. A DELETE request is also accepted for methods that destroy data. API Methods that require a particular HTTP method will return an error if you do not make your request with the correct method. HTTP Response Codes are meaningful.
The API is a RESTful resource
REST (Representational State Transfer) is a programming concept in which you build your web application to only process basic CRUD (Create Read Update and Delete) operations. The API presently supports the following data formats: XML, JSON.
To try the API for the first time we suggest to use curl
Here are some examples to use curl:
- Check if you are authenticated: curl https://todo.ly/api/authentication/IsAuthenticated.xml
- Get your UserObject in XML format: curl -u username:password https://todo.ly/api/user.xml
- Get all your projects in JSON format: curl -u username:password https://todo.ly/api/projects.json
Objects of the API
Todo.ly API has 4 main Objects.
Each Object has a separate URL representation on the API. The naming rule is the following:
For details please see the separate sections describing the Objects of this Wiki.