v1

latestOpenAPI 3.0.32026-08-0621531.1 KB

Checklists

Get a checklist

get/checklists/{checklist_id}.{format}

Path parameters

checklist_idinteger required

format'json' | 'xml' required

Response representation.

Query parameters

with_inbound_emailboolean

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

Response

The requested checklist.

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.