This page documents the canonical HTTP contract for this endpoint.
Body parameters
filter· optionalobject
Optional FilterDescriptor tree for task filtering.
search· optionalstring
Optional free-text search.
scope· optionalstring
Legacy org or user scope toggle; prefer a descriptor rule on field scope.
sort· optionalarray<object>
Sort specs; each item is { field, direction }. Defaults to due_date ascending.
pagination· optionalobject
Pagination object { limit, cursor }. Default limit is 50.
include_skipped· optionalboolean
Include skipped/deleted tasks. Defaults to false.
include_total_count· optionalboolean
Include total count in response. Defaults to true.
include_research_values· optionalboolean
Hydrate live research values. Defaults to true.
research_field_ids· optionalarray<string>
Restrict research hydration to these field IDs. Empty array skips hydration entirely.
| Name | Type | Description |
|---|---|---|
| filter | object | Optional FilterDescriptor tree for task filtering. |
| search | string | Optional free-text search. |
| scope | string | Legacy org or user scope toggle; prefer a descriptor rule on field scope. |
| sort | array<object> | Sort specs; each item is { field, direction }. Defaults to due_date ascending. |
| pagination | object | Pagination object { limit, cursor }. Default limit is 50. |
| include_skipped | boolean | Include skipped/deleted tasks. Defaults to false. |
| include_total_count | boolean | Include total count in response. Defaults to true. |
| include_research_values | boolean | Hydrate live research values. Defaults to true. |
| research_field_ids | array<string> | Restrict research hydration to these field IDs. Empty array skips hydration entirely. |
Errors
| Status | Meaning |
|---|---|
| 400 | Invalid descriptor payload. |
| 401 | Invalid API key or missing auth. |
| 403 | Missing tasks:read scope. |
