List and filter items
List, filter and search items. Omit listId for the Tasks set — every item on a list that keeps a status and a due date (the Tasks list and every list made for tasks), ordered by due date then creation, completed tasks left out by default. Pass listId for one list's items, whatever its shape: a notes list's prose, a reading list's rows. Each row carries the item's title, body as Markdown, status and due date where its list keeps them, values keyed by property id, and its list. get_item reads one item in full with handles for editing, and is the call when the person asks to see, open or show one item; query_items filters, counts and sums by property. A read that repeats on a schedule passes changedSince, the nextChangedSince of its previous read: only what moved since comes back on the person's own lists, deletions included, one call per cycle instead of the whole list.
Request
- Base URLhttps://api.roma.app
- URLhttps://api.roma.app/api/v1/items
- AuthHTTP bearer
Query parameters
One list's items: a list id (from list_lists or get_context), or the word "tasks" (the Tasks list, the unsorted pool) or "notes" (the Notes list, made afresh when the user deleted theirs). Omit for the Tasks set.
An ISO 8601 instant (exclusive), or the nextChangedSince of the previous read verbatim. The changes feed for a worker that polls: every item of the list (or of the person's own lists that keep the task columns, trashed and archived ones included) whose record moved after it — edits, completions, archives, restores, deletions — oldest change first, the deleted ones as deleted tombstones, then hasMore and nextChangedSince to pass next time. Items shared with the person are not in the feed (list_items without changedSince reads them). query is refused beside it; the other filters and sort do not apply.
Specific item ids to fetch (the other filters still apply).
Only the items assigned to one of the person's agents: "me" for the agent this call is made under (register_agent), else the agent's name or id. The work handed to an agent, for one that reads on its own schedule.
Free-text search across title and body.
Filter to these statuses, on lists that keep one — each a status id of the list's Status property (todo, inProgress, completed on every list that keeps one; backlog, inReview, canceled and the list's own ids where list_lists shows them). A done-stage status completes the item. A stage word (open, active, done) stands for every status of that stage on every list. Omit for the default: every status that is not done.
ISO 8601 instant — only items due on/after this (inclusive).
ISO 8601 instant — only items due before this (exclusive). Today = dueAfter today 00:00 local, dueBefore tomorrow 00:00 local; overdue = dueBefore today 00:00 alone.
ISO 8601 instant — only items created on/after this.
ISO 8601 instant — only items created before this (exclusive).
ISO 8601 instant — only items last edited on/after this. A poll that wants deletions too uses changedSince instead.
ISO 8601 instant — only items last edited before this (exclusive).
ISO 8601 instant — only items completed on/after this. Implies completed items unless taskStatus says otherwise.
ISO 8601 instant — only items completed before this (exclusive).
Row order. Default 'due' (due date, then creation); a timestamp sort returns newest first.
Max results (default 50).
true additionally returns a short-lived signed url per attachment so the images can be viewed. Off by default.
Response
The tool's result.
Changes
No recorded changes to this operation across all 1 revision of this API.