Lists
Base path: /v1/lists · Auth: Bearer
| Method | Path | Purpose |
|---|---|---|
GET | /v1/lists | List lists (pagination/filtering) |
POST | /v1/lists | Create 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:
| Parameter | Type | Default | Description |
|---|---|---|---|
status | enum open|inprogress|done|completed|closed|archived | – | Filter by status |
lifecycle | enum active|archived|trashed | – | Filter by lifecycle |
parent | UUID | null | – | Child lists |
includeTemplates | boolean | false | Include templates |
excludeCompleted | boolean | false | Hide completed lists |
Query (GET /v1/lists/{listId})
| Parameter | Type | Default | Description |
|---|---|---|---|
includeItems | boolean | true | Include items in the response |
includeArchived | boolean | false | Include archived items |
Body — create (POST /v1/lists)
| Field | Type | Required | Description |
|---|---|---|---|
name | string (1–255) | ✅ | Name |
description | string | – | Description |
type | string | – | Type |
status | enum (see above) | – | Initial status |
parent | UUID | null | – | Parent list |
members | UUID[] | – | Members |
owners | UUID[] | – | Owners |
tags | string[] | – | Tags |
color | string | – | Color |
cover | string | – | Cover |
start_ts / end_ts | date (ISO) | – | Time range |
all_day | boolean | – | All-day |
Body — update (PATCH /v1/lists/{listId})
Same as create (all fields optional), plus lifecycle (active/archived/trashed) and locked (boolean).
Example
bash
curl -X POST https://api.eu.liza.app/api/v1/lists \
-H "Authorization: Bearer DEIN_TOKEN" \
-H "Content-Type: application/json" \
-d '{"name":"Sprint 42","description":"Backlog"}'