This API is depreciated. Please upgrade to our new improved 3.0 API. This API will continue to work for some time, but it is no longer supported and it will eventually go away.

Developer's API Documentation - Notebook

The Toodledo API makes it easy for developers to interact with their tasks and make new and interesting applications.

The Toodledo API uses a REST interface. REST is a simple format that allows you to make queries by constructing a URL and making an HTTP GET or POST. The server responds with an XML document containing the information that you requested.

The API documentation is split between these three pages:

Authentication and General API Tasks API Notebook API

Retrieving Notebooks

The "getNotes" API call will return a list of the notebooks that match your search parameters. The following search parameters may be set.

modbefore : A date-time formated as YYYY-MM-DD HH:MM:SS. Used to find notebooks with a modified date and time before this date and time.
modafter : A date-time formated as YYYY-MM-DD HH:MM:SS. Used to find notebooks with a modified date and time after this date and time.
id : The id number of the notebook that you want to fetch. This is useful if you already know the id number and only need to fetch the one notebook.

http://api.toodledo.com/api.php?method=getNotes;key=YourKey;modafter=2009-01-01
14:30:00

This returns a list of notebooks that might look something like this.

<notes>
	<note>
		<id>1234</id>
		<folder>123</folder>
		<added seconds="1249925490">2009-08-10 12:32:00</added>
		<modified seconds="1249955490">2009-08-09 20:51:00</modified>
		<title>My Notebook Entry</title>
		<text>This is my note</text>
		<private>1</private>
	</note>
	<note>
		<id>1235</id>
		<folder>125</folder>
		<added seconds="1249925490">2009-08-10 12:32:00</added>
		<modified seconds="1249955490">2009-08-09 20:51:00</modified>
		<title>My Second Notebook Entry</title>
		<text>This is my other note</text>
		<private>0</private>
	</note>
</notes>

The "folder" field will reference a folder ID number, which you can use with the "getFolders" general API call to get the folder's name. The "private" field is a boolean field (0 or 1) that indicates if the user has marked this notebook as private (Toodledo.com does not currently distinguish private/public notebook entries on this website.

Adding Notebooks

You can easily add a notebook to your list with the "addNote" API call. To avoid truncating long notes, you should submit this query using an HTTP POST instead of a GET.

title : A text string up to 255 characters. Please encode the & character as %26 and the ; character as %3B.
folder : The id number of the folder as returned from the "getFolders" API call. Omit this field or set it to 0 to leave the notebook unassigned to a folder.
private : A boolean (0 or 1) that indicates if the notebook has been marked as private.
addedon : A date formated as YYYY-MM-DD that indicates when the notebook was added. The default value is the current day.
note : A text string. Please encode the & character as %26 and the ; character as %3B.

http://api.toodledo.com/api.php?method=addNote;key=YourKey;
title=grocery list;note=buy eggs and cheese

If the add was successful the id number of the new notebook will be returned.

<added>12345</added>

Editing Notebooks

Edit a notebook using the "editNote" API call. The notebook id is required and can be found from the getNotes or addNote API calls. Omit any fields that you do not wish to set. To avoid truncating long notes, you should submit this query using an HTTP POST instead of a GET.

id : The id number of the notebook to edit.
title : A text string up to 255 characters. Please encode the & character as %26 and the ; character as %3B.
folder : The id number of the folder as returned from the "getFolders" API call. Omit this field or set it to 0 to leave the notebook unassigned to a folder.
private : A boolean (0 or 1) that indicates if the notebook has been marked as private.
note : A text string. Please encode the & character as %26 and the ; character as %3B.

http://api.toodledo.com/api.php?method=editNote;key=YourKey;
id=12345;title=MyNotebook;note=This is my new note

If the edit was successful you will get the following message.

<success>1</success>

Deleting Notebooks

The "deleteNote" API call will allow you to permanently delete a notebook. This is permanent. There is no undelete.

id : The id number of the notebook to delete.

http://api.toodledo.com/api.php?method=deleteNote;key=YourKey;id=12345

If the delete was successful you will get the following message.

<success>1</success>

Get Deleted Notebooks

The "getDeletedNotes" API call will enable you to detect when a notebook was deleted on Toodledo, so you can also delete the notebook from your application.

after : A date-time formated as YYYY-MM-DD HH:MM:SS. Used to find notebooks that were deleted after this date and time.

http://api.toodledo.com/api.php?method=getDeletedNotes;key=YourKey;
after=2008-01-25 05:12:45

This returns a list of id numbers and datetime stamps.

<deleted>
	<note>
	<id>12345</id>
	<stamp>2008-02-25 07:46:42</stamp>
	</note>
	<note>
	<id>67890</id>
	<stamp>2008-03-12 14:11:12</stamp>
	</note>
</deleted>