Lists

Last updated 17 days ago

Lists ​

Base path: /v1/lists · Auth: Bearer

MethodPathPurpose
GET/v1/listsList lists (pagination/filtering)
POST/v1/listsCreate a list
GET/v1/lists/{listId}Retrieve a list including its items
PATCH/v1/lists/{listId}Update a list
DELETE/v1/lists/{listId}Delete a list (soft delete)

{listId} accepts either a UUID or a SID.

Query (GET /v1/lists) ​

Pagination (page, pageSize, search) plus:

ParameterTypeDefaultDescription
statusenum open|inprogress|done|completed|closed|archived–Filter by status
lifecycleenum active|archived|trashed–Filter by lifecycle
parentUUID | null–Child lists
includeTemplatesbooleanfalseInclude templates
excludeCompletedbooleanfalseHide completed lists

Query (GET /v1/lists/{listId}) ​

ParameterTypeDefaultDescription
includeItemsbooleantrueInclude items in the response
includeArchivedbooleanfalseInclude archived items

Body — create (POST /v1/lists) ​

FieldTypeRequiredDescription
namestring (1–255)✅Name
descriptionstring–Description
typestring–Type
statusenum (see above)–Initial status
parentUUID | null–Parent list
membersUUID[]–Members
ownersUUID[]–Owners
tagsstring[]–Tags
colorstring–Color
coverstring–Cover
start_ts / end_tsdate (ISO)–Time range
all_dayboolean–All-day

Body — update (PATCH /v1/lists/{listId}) ​

Same as create (all fields optional), plus lifecycle (active/archived/trashed) and locked (boolean).

Example ​

bash