List TaskItems
Lists TaskItems for the given tenant.
Date Range Options:
- Use dateRange for preset ranges (ThisWeek, ThisMonth, Today, etc.)
- Use startDate/endDate for custom ranges
- Date range is required when querying NotStarted tasks (or no status filter) with includeProjected=true — the engine needs a window to project recurrences into
- Date range is NOT required when includeProjected=false (materialised tasks only)
- Date range is NOT required when filtering by non-NotStarted statuses only (e.g., InProgress, Completed)
- Date range is NOT required when using isOverdue=true
Projection Without a Date Range (projectUntil):
- Set projectUntil (with includeProjected=true and no date range) to get every existing task
plus projected recurrences from today up to that date - Only the projected half is bounded — the materialised half stays unbounded, so nothing drops
out of the list that a windowless includeProjected=false query would have returned - Cannot be combined with a date range (the range already bounds projection) or with isOverdue=true;
must be today or later and no more than 2 years ahead - A savedFilter that asks for projected tasks but stores no date range gets a 12-month horizon
automatically, since a saved view has nowhere to store one
Overdue Mode (isOverdue=true):
- Returns only tasks where DueDate < today
- Automatically excludes Completed and Skipped statuses unless you specify a status filter
- No date range required
Search (search):
- Matches the task name, the task code and the primary client's name; minimum 3 characters
- Secondary client links are not searched — a hit there would return a row whose displayed
client does not contain the term - Projected tasks are excluded whenever search is set. Projected occurrences are generated
in memory from a recurrence, so the search cannot be applied to them; leaving projection on
would merge unfiltered rows into a searched result. A search therefore needs no date range,
whatever includeProjected or projectUntil ask for.
Standard Mode (includeWorkflowSteps=false, default):
- Returns only tasks (materialised and optionally projected)
- Use dateBasis to specify which date field to use for filtering: StartDate (default) or DueDate
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
Supports filtering by user(s), client(s), recurring task(s), category, date range, status, and isOverdue.
Parameters
| Name | Type | Description |
|---|---|---|
| tenant* | path string | The Tenant.Code |
The Tenant.Code |
||
| 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) |
||
| client | query array | Filter by client code(s) - can specify multiple |
Filter by client 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 |
||
| service | query array | Filter by billable service code(s) - can specify multiple |
Filter by billable service code(s) - can specify multiple |
||
| serviceStage | query array | Filter by billable service stage - composite "serviceCode:stageCode" values, can specify multiple |
Filter by billable service stage - composite "serviceCode:stageCode" values, can specify multiple |
||
| category | query array | Filter by task category code(s) - can specify multiple |
Filter by task category code(s) - can specify multiple |
||
| team | query array | Filter by team code(s) - can specify multiple |
Filter by team code(s) - can specify multiple |
||
| clientManager | query array | Filter by the primary client's manager (user codes) - can specify multiple. Clientless tasks are excluded. |
Filter by the primary client's manager (user codes) - can specify multiple. Clientless tasks are excluded. |
||
| clientPartner | query array | Filter by the primary client's partner (user codes) - can specify multiple. Clientless tasks are excluded. |
Filter by the primary client's partner (user codes) - can specify multiple. Clientless tasks are excluded. |
||
| clientAssociate | query array | Filter by the primary client's associate (user codes) - can specify multiple. Clientless tasks are excluded. |
Filter by the primary client's associate (user codes) - can specify multiple. Clientless tasks are excluded. |
||
| workflow | query array | Filter by workflow code(s) - can specify multiple |
Filter by workflow code(s) - can specify multiple |
||
| stepType | query array | Filter by workflow step type(s) - matches tasks with at least one step of these types |
Filter by workflow step type(s) - matches tasks with at least one step of these types |
||
| currentStep | query array | Filter by current workflow step name(s) - can specify multiple |
Filter by current workflow step name(s) - can specify multiple |
||
| status | query array | Filter by task status(es) |
Filter by task status(es) |
||
| 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. |
||
| dateRange | query string | Preset date range. If CustomDateRange, startDate and endDate are required. |
Preset date range. If CustomDateRange, startDate and endDate are required. |
||
| 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 |
||
| includeProjected | query boolean | Include projected (virtual) tasks in the results (default: false) |
Include projected (virtual) tasks in the results (default: false) |
||
| projectUntil | query string | Projection horizon for a query with no date range. Requires includeProjected=true and no date range; projects from today to this date while the materialised query stays unbounded. |
Projection horizon for a query with no date range. Requires includeProjected=true and no date range; projects from today to this date while the materialised query stays unbounded. |
||
| dateBasis | query string | Which date field to use as the basis for filtering: StartDate (default) or DueDate |
Which date field to use as the basis for filtering: StartDate (default) or DueDate |
||
| isOverdue | query boolean | Filter to only include overdue tasks (DueDate < today). No date range required when true. |
Filter to only include overdue tasks (DueDate < today). No date range required when true. |
||
| isUnassigned | query boolean | Include unassigned tasks. Can be combined with user filter to show unassigned OR assigned to specific users. |
Include unassigned tasks. Can be combined with user filter to show unassigned OR assigned to specific users. |
||
| isAutomationDisabled | query boolean | True returns only tasks with automation switched off; false only those with it on. Task previews are excluded either way. |
True returns only tasks with automation switched off; false only those with it on. Task previews are excluded either way. |
||
| search | query string | Search across task name, task code and primary client name (minimum 3 characters). Projected tasks are excluded when set. |
Search across task name, task code and primary client name (minimum 3 characters). Projected tasks are excluded when set. |
||