List TaskItems
Lists TaskItems for the given tenant. Supports two modes based on includeWorkflowSteps parameter:
**Standard Mode (includeWorkflowSteps=false, default):**
- Returns only tasks (materialised and optionally projected)
- When startDate not provided: uses Today for projected tasks, or a wide range (-1 year to +1 year) for filtered queries
- When endDate not provided: uses +7 days from startDate
**Agenda Mode (includeWorkflowSteps=true):**
- Returns both tasks AND workflow steps as TaskItemDto objects
- Tasks: Returned with all standard TaskItem properties, WorkflowStepDetails = null
- Workflow Steps: Returned with parent task properties populated, WorkflowStepDetails contains step-specific information
- When startDate not provided: defaults to Today
- When endDate not provided: defaults to +30 days from startDate
Supports filtering by user(s), client(s), recurring task(s), date range, and status.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| client | query array | Filter by client code(s) - can specify multiple |
Filter by client code(s) - can specify multiple |
||
| startDate | query string | Filter tasks starting from this date. Only valid when dateRange=CustomDateRange |
Filter tasks starting from this date. Only valid when dateRange=CustomDateRange |
||
| endDate | query string | Filter tasks ending on this date. Only valid when dateRange=CustomDateRange |
Filter tasks ending on this date. Only valid when dateRange=CustomDateRange |
||
| status | query array | Filter by task status(es). Projected tasks only included for NotStarted. |
Filter by task status(es). Projected tasks only included for NotStarted. |
||
| category | query array | Filter by task category code(s) - can specify multiple |
Filter by task category code(s) - can specify multiple |
||
| user | query array | Filter by user code(s) - can specify multiple |
Filter by user code(s) - can specify multiple |
||
| recurringTask | query array | Filter by recurring task code(s) - can specify multiple |
Filter by recurring task code(s) - can specify multiple |
||
| includeProjected | query boolean | Include projected (virtual) tasks in the results (default: false) |
Include projected (virtual) tasks in the results (default: false) |
||
| dateRange | query string | Preset date range. If CustomDateRange, startDate and endDate are required. |
Preset date range. If CustomDateRange, startDate and endDate are required. |
||
| includeWorkflowSteps | query boolean | Include workflow steps in the results (default: false). When true, uses Agenda mode. |
Include workflow steps in the results (default: false). When true, uses Agenda mode. |
||
| savedFilter | query string | Code of a saved filter to apply. When provided, all filter parameters from the saved filter are used unless explicitly overridden by query parameters. |
Code of a saved filter to apply. When provided, all filter parameters from the saved filter are used unless explicitly overridden by query parameters. |
||
| offset | query integer (int32) | Number of records to skip (default: 0). Use with limit for pagination. |
Number of records to skip (default: 0). Use with limit for pagination. |
||
| limit | query integer (int32) | Maximum number of records to return (default: 10, max: 50) |
Maximum number of records to return (default: 10, max: 50) |
||
| sortBy | query enum | Field to sort by. |
Field to sort by. |
||
| sortDesc | query boolean | Sort in descending order (true) or ascending order (false, default) |
Sort in descending order (true) or ascending order (false, default) |
||