nooks
GitHubInstall
Lists and items

List lists

ListLists returns one page of the Lists the signed-in Member can reach, filtered and ordered as asked. What a page holds is the server's own promise about how much work one read is, so a caller asking for more than the ceiling gets the ceiling.

GET
/api/v1/lists

Query Parameters

status?string
Formatenum

Value in

  • "LIST_STATUS_UNSPECIFIED"
  • "LIST_STATUS_ACTIVE"
  • "LIST_STATUS_COMPLETED"
  • "LIST_STATUS_ARCHIVED"
order?string
Formatenum

Value in

  • "LIST_ORDER_UNSPECIFIED"
  • "LIST_ORDER_UPDATED"
  • "LIST_ORDER_NAME"
  • "LIST_ORDER_OPEN"
page?integer

1-based. Zero reads as the first page.

Formatint32
pageSize?integer

How many rows a page holds. Zero takes the server's own, and anything above it is clamped: the page size is the server's promise about how much work one read is.

Formatint32

Response Body

application/json

application/json

curl -X GET "https://example.com/api/v1/lists"
{  "lists": [    {      "uid": "string",      "name": "string",      "sharing": "SHARING_UNSPECIFIED",      "canEdit": true,      "isOwner": true,      "isPinned": true,      "openCount": 0,      "doneCount": 0,      "createdAt": "string",      "updatedAt": "string",      "archivedAt": "string",      "archivedByName": "string"    }  ],  "total": 0,  "atLeast": true,  "page": 0,  "pageSize": 0}

List dated items

ListDatedItems returns unticked Items with a due date, across every List the Member can reach. Today, Upcoming and the calendar are all views over this: a calendar is a lens on dates, not a second home for Lists.

Move item

MoveItem places an Item after another one, or at the top when after_item_uid is empty.