API Docs / Operations / Tasks / List TaskItems

List TaskItems

GET /tenants/{tenant}/tasks

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)
  • 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

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

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

NameTypeDescription
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)

Filter by task status(es)
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)
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
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.
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.
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.

Name DueDate StartDate Category

Field to sort by.

Name DueDate StartDate Category
sortDesc query boolean

Sort in descending order (true) or ascending order (false, default)

Sort in descending order (true) or ascending order (false, default)

Responses

200 OK
400 Bad Request
401 Unauthorized - Invalid or missing API key

Try it

Related Schemas

TaskItemDtoPagedResult