Sign in

v1

latestOpenAPI 3.0.32026-08-0621531.1 KB
List items

List items of a checklist

List items are sorted by parent_id, position.

get/checklists/{checklist_id}/tasks.{format}

Path parameters

checklist_idinteger required
format'json' | 'xml' required

Response representation.

Query parameters

with_notesboolean

If set, the result includes information about notes added to the items.

order'id:asc' | 'id:desc' | 'updated_at:asc'

Override the sort order.

Response

Array of list items.

idinteger
contentstring

Task content.

status0 | 1 | 2

0 - open, 1 - closed, 2 - invalidated.

checklist_idinteger

Containing checklist ID.

parent_idinteger

Parent task ID. Empty for root-level items in XML, or 0 in JSON.

comments_countinteger

Number of notes for this item.

positioninteger

1-based position under its parent.

priorityinteger

(JSON only) Optional task priority, 1..9.

duestring

Due date, when set.

deletedboolean

Present (and true) only in the representation of a just-deleted item.

assignee_idsinteger[]

(JSON only) IDs of the item's assignees.

tasksinteger[]

(JSON only) Child task IDs.

tagsobject

(JSON only) Map of tag name => isPrivate. When modifying an item, both a map and a comma-separated string of tag names are accepted.

tags_as_textstring

(JSON only) Comma-separated list of tag names. Also accepted when modifying an item.

update_linestring

(JSON only) Text describing the last change, e.g. 'updated by kir'.

updated_atstring

(JSON only) Time of the last change. See Timestamp format in the introduction.

created_atstring

(JSON only) When the item was created. See Timestamp format in the introduction.