Lists

The lists with their properties and counts

The user's lists: every live list with its id, name, icon, standing instructions, item count, layout and PROPERTIES with their stable ids — the ids create_items and update_items key values on. A list whose statusPropertyId is "status" and dueDatePropertyId is "dueDate" keeps a status and a due date on its items, which makes them tasks; the Tasks list and the Notes list are named by id. Use it to resolve a list's name to its id before writing to it, or to read a list's properties you have not seen yet. Pass suppressOptions: true when you only need names and counts; a select property can carry hundreds of options (a select value may be sent as its label). sections are the sidebar's sections in order (the default section, id "lists", and the ones the user made) and each list names its section; create_list and update_list take section to place a list.

get/api/v1/lists

Request

  • Base URL
    https://api.roma.app
  • URL
    https://api.roma.app/api/v1/lists
  • Auth
    HTTP bearer

Query parameters

suppressOptionsboolean

true replaces each select property's option list with an optionCount — much smaller payload.

Response

The tool's result.

totalnumber required
tasksListIdstring nullable required
notesListIdstring nullable required

Changes

No recorded changes to this operation across all 1 revision of this API.