List Items

Last updated About 4 hours ago

List Items ​

Two equivalent entry points: the flat resource /v1/list-items and the nested path under a specific list.

MethodPathPurpose
GET/v1/list-itemsList items (pagination/filters)
POST/v1/list-itemsCreate item
GET/v1/list-items/{itemId}Fetch item
PATCH/v1/list-items/{itemId}Update item
DELETE/v1/list-items/{itemId}Delete item (soft delete)
GET/v1/lists/{listId}/itemsItems of a list
POST/v1/lists/{listId}/itemsCreate item in a list

Query (GET /v1/list-items) ​

Pagination (page, pageSize, search) plus:

ParameterTypeDescription
listUUIDby list
statusstringexact status
prioritynumber (1–10)by priority
assigned_toUUIDby assigned user
includeArchivedboolean (default false)include archived
includeTrashedboolean (default false)include trash

REST vs. MCP

The convenience filters state, assigned_to_me, due_within_days, sort, and compact are only available on the MCP toollist_list_items — not in the REST API.

Body — create (POST /v1/list-items or /v1/lists/{listId}/items) ​

FieldTypeRequiredDescription
listUUID✅*Target list (*omitted on the nested path)
textstring (1–500)✅Title
descriptionstring–Description
statusstring–Status (see below)
stagestring–Workflow stage
progressnumber (0–100)–Progress
prioritynumber (1–10)–Priority
typestring–Type
scopeenum public|private|shared–Visibility
assigned_toUUID[]–Assignments
responsibleUUID | null–Responsible person
tagsstring[]–Tags
target_date / start_date / end_datedate (ISO) | null–Dates
time_allocatednumber ≥ 0–Time budget
fieldsobject–Custom fields
parentUUID | null–Parent item
sort_keystring–Sort key
num / levelinteger–Numbering / level
anchorUUID | null–Item this item docks onto (info-/detail-column mechanism). Only controls which display layer the item appears in — parent remains the real hierarchy. Set both when creating a child item of such a column.
layerinteger ≥ 0–Display layer for the anchor mechanism (0 = main list). Only meaningful together with anchor.
contentobject | array | string–Structured content payload (e.g. box-type-specific data). Objects/arrays are stored as JSON.

Body — update (PATCH /v1/list-items/{itemId}) ​

Same as create (all optional, without list), plus archived (boolean).

Status: open = ""/todo/open/in_progress; done = done/completed.

Example ​

bash