Sign in
Checklists

Get a checklist

With json or xml returns the list representation. This URL also exports the whole list as a document — opml, md or txt — controlled by the export_* parameters below.

OPML is the full-fidelity format: it keeps the whole tree with notes, tags, due dates, assignees, priority/color and open/closed status, and can be fed back to the import call. Pass export_id=true to add each item's task ID as the id attribute of its <outline> element — the way to get task IDs out of an export (they are ignored on re-import, imported items get new IDs), for example /checklists/182531.opml?export_id=true.

get/checklists/{checklist_id}.{format}

Path parameters

checklist_idinteger required
format'json' | 'xml' | 'opml' | 'md' | 'txt' required

json or xml for basic list representation. Also opml, md or txt for other export formats.

Query parameters

with_inbound_emailboolean

If true, include each list's inbound "email to list" address as the inbound_email field. Omitted by default.

export_idboolean

opml only: add the task ID as the id attribute of every <outline>.

export_notesboolean

opml, md: include item notes.

export_statusboolean

opml only: include the open/closed/invalid status of every item.

export_colorboolean

opml only: include item priority/color.

max_headinginteger

md only: turn the first N outline levels into markdown headings, 0..6.

Response

The requested checklist in corresponding format.

idinteger
namestring
publicboolean

True for a checklist that anyone can read without authentication.

role1 | 2 | 3

1 - author, 2 - writer, 3 - reader.

updated_atstring

Time of the last update (includes task updates, excludes comments). See Timestamp format in the introduction.

task_countinteger

Total number of leaf tasks.

task_completedinteger

Number of completed leaf tasks.

read_onlyboolean

True if the user's access to this list is read-only.

archivedboolean

True if the user archived this list.

inbound_emailstring

The list's inbound "email to list" address (send mail here to add tasks to the list; the same address shown in the web UI). The address embeds the user's Remote API key, so regenerating that key changes the inbound_email of every list.

tagsobject

(JSON only) Map of tag name => isPrivate.

tags_as_textstring

(JSON only) Comma-separated list of tag names.

Changes