One task. The identity is (workspace, document, node), carried together - never a node id on its own - and [task](Self::task) is the same triple as the one string that is also its pagination key and its activity subject.
API reference sections
Schema
TaskRow
Type object
Shape
| Field | Type | Description |
|---|---|---|
| workspacerequired | WorkspaceId | |
| documentrequired | DocumentId | DocumentId - a client-minted v4 UUID, hyphenated and lowercase. Immutable, and never derived from a name or a path. |
| noderequired | string | The node id, meaningful only inside |
| taskrequired | string |
|
| node_kindrequired | string | The node's kind token - one of the task-capable kinds |
| lifecyclerequired | string |
|
| document_trashedrequired | boolean | Whether the document sits in the trash, inherited down the document tree. Flagged, never hidden. |
| in_trashrequired | boolean | Whether the node sits in its document's own hidden trash root. Rows like this come back only under [ |
| breadcrumbrequired | string | Where the task lives: the workspace, then the document path, then the ancestor rows, joined by |
| titlerequired | string | The task's own title: its text, else its authored name, else "Untitled" - |
| attributesrequired | array of AttributeRowValue | Every attribute on the node - not only the ones the filter named, so a row can be drawn without a second request. |
{
"workspace": "00000000-0000-4000-8000-000000000000",
"document": "00000000-0000-4000-8000-000000000000",
"node": "string",
"task": "string",
"node_kind": "string",
"lifecycle": "string",
"document_trashed": false,
"in_trash": false,
"breadcrumb": "string",
"title": "string",
"attributes": [
{
"id": "string",
"role": "string",
"kind": "string",
"value": "string",
"zone": "string",
"label": "string"
}
]
}The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.
Generated from contract version 1. Last updated .
