The saved views
tasks.view.list
GET/api/v1/households/{household_id}/queries/tasks.view.list
- Query
- Rigel runs it
Every saved view, by name, with its mode and filters. The built-in Queue, Blocked and Browse views aren't listed.
Parameters#
| Field | Description |
|---|---|
household_idpathstringrequired | The household's ID. |
Response#
200 The answer.
| Field | Description |
|---|---|
itemsarray of objectsrequired | |
items[].idstringrequired | A task view ID, such as tvw_01JC0000000000000000000000. |
items[].namestringrequired | No description. |
items[].modeone of: queue, browserequired | queue: ready work by priority, leaving out done and (unless show_blocked) blocked tasks. browse: everything, done included. |
items[].filtersobjectrequired | The view's filters, as |
items[].filters.textstringoptional | Words that must all appear in the title or description, ignoring case. |
items[].filters.statesarray, each one of: todo, doing, blocked, doneoptional | Only tasks in one of these states. |
items[].filters.assignee_person_idstringoptional | Only tasks assigned to this person. |
items[].filters.prioritiesarray of numbers or nulloptional | Only tasks with one of these priorities. |
items[].filters.include_tag_idsarray of stringsoptional | Only tasks with at least one of these tags. |
items[].filters.exclude_tag_idsarray of stringsoptional | Leave out tasks with any of these tags. |
items[].filters.due_fromstring (date)optional | Only tasks due on or after this date. |
items[].filters.due_tostring (date)optional | Only tasks due on or before this date. |
items[].filters.root_task_idstringoptional | Only this task's subtasks, at any depth (a project's work). |
items[].filters.show_blockedboolean or stringoptional | In a queue view, include blocked work too. Defaults to false. |
Errors#
Every error has the same envelope: error.code, error.message, error.details, error.recovery and error.request_id.
| Status | Code | When |
|---|---|---|
400 | validation_failed | A field is missing, misspelled or out of range. details.fields lists each problem. |
401 | unauthenticated | The request has no valid session. |
404 | not_found | The household doesn't exist, or you aren't a member of it. |
Examples#
These are real. Each was recorded from a sample household, the Okafors, running through the whole API when this site was built.
List the saved views
curl 'https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/tasks.view.list' \
-H "Cookie: rigel_session=$RIGEL_SESSION"const response = await fetch("https://rigel.house/api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/tasks.view.list", {
headers: {
Cookie: `rigel_session=${process.env.RIGEL_SESSION}`,
},
});
const data = await response.json();GET /api/v1/households/hh_01M6V9CS6GGVFCY7NAS8ZTQV95/queries/tasks.view.list HTTP/1.1
Host: rigel.house
Cookie: rigel_session=<your session>HTTP/1.1 200 OK
Content-Type: application/json
X-Request-Id: req_01M6V9CT5DS6NMADQM5TZG4JHK
{
"items": [
{
"id": "tvw_01M6V9CT5BYG5MVM4XWVSYHNH2",
"name": "Errands this month",
"mode": "queue",
"filters": {
"include_tag_ids": [
"tag_01M6V9CT2HYP2JXTPT7T98VN41"
],
"due_to": "2026-12-07"
}
}
]
}For Rigel#
Rigel's tool for this query is tasks_view_list. Rigel runs this on its own, then says what it did. The agent guide has the rest.