CreateSavedTaskFilterRequest

Request model for creating a new saved task filter

Properties

Name	Type	Description
name*	string	User-friendly name for this saved filter (e.g., "My Overdue Tasks", "Client ABC Tasks")
User-friendly name for this saved filter (e.g., "My Overdue Tasks", "Client ABC Tasks")
description	string	Optional description providing more details about this filter's purpose
Optional description providing more details about this filter's purpose
includeInMenu	boolean	Whether this filter should be included in the current user's menu/quick access list. This is a per-user preference — it does not affect other users of a shared filter.
Whether this filter should be included in the current user's menu/quick access list. This is a per-user preference — it does not affect other users of a shared filter.
isShared	boolean	Whether this filter is shared with all users in the tenant. Shared filters are visible (read-only) to everyone; only the owner can modify or delete them.
Whether this filter is shared with all users in the tenant. Shared filters are visible (read-only) to everyone; only the owner can modify or delete them.
dateRange	enum	ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange
ThisWeek NextWeek Last7Days Next7Days Last30Days Next30Days PreviousMonth ThisMonth NextMonth PreviousQuarter ThisQuarter NextQuarter PreviousYear ThisYear NextYear YearToDate PreviousTaxYear ThisTaxYear NextTaxYear TaxYearToDate Today PreviousWeek CustomDateRange
startDate	string	Custom start date (only used when DateRange = CustomDateRange)
Custom start date (only used when DateRange = CustomDateRange)
endDate	string	Custom end date (only used when DateRange = CustomDateRange)
Custom end date (only used when DateRange = CustomDateRange)
dateBasis	enum	Any StartDate DueDate StatutoryDate CompletedDate
Any StartDate DueDate StatutoryDate CompletedDate
clientCodes	array of string	Filter by client code(s)
Filter by client code(s)
userCodes	array of string	Filter by user code(s)
Filter by user code(s)
recurringTaskCodes	array of string	Filter by recurring task code(s)
Filter by recurring task code(s)
categoryCodes	array of string	Filter by category code(s)
Filter by category code(s)
serviceCodes	array of string	Filter by billable service code(s)
Filter by billable service code(s)
serviceStageCodes	array of string	Filter by billable service stage. Composite "serviceCode:stageCode" values, since a stage code is only unique within its parent service.
Filter by billable service stage. Composite "serviceCode:stageCode" values, since a stage code is only unique within its parent service.
teamCodes	array of string	Filter by team code(s)
Filter by team code(s)
clientManagerCodes	array of string	Filter by the primary client's manager (user codes). Clientless tasks never match.
Filter by the primary client's manager (user codes). Clientless tasks never match.
clientPartnerCodes	array of string	Filter by the primary client's partner (user codes). Clientless tasks never match.
Filter by the primary client's partner (user codes). Clientless tasks never match.
clientAssociateCodes	array of string	Filter by the primary client's associate (user codes). Clientless tasks never match.
Filter by the primary client's associate (user codes). Clientless tasks never match.
statuses	array of enum	Filter by task status(es) NotStarted InProgress Blocked Completed Skipped
Filter by task status(es) NotStarted InProgress Blocked Completed Skipped
isOverdue	boolean	Filter to only overdue tasks
Filter to only overdue tasks
isUnassigned	boolean	Include tasks with no assigned user. Can be combined with UserCodes to show tasks that are either unassigned OR assigned to specific users.
Include tasks with no assigned user. Can be combined with UserCodes to show tasks that are either unassigned OR assigned to specific users.
isAutomationDisabled	boolean	Filter by the automation switch: true for tasks with automation off, false for those with it on, null for both. Task previews are excluded whenever this is set.
Filter by the automation switch: true for tasks with automation off, false for those with it on, null for both. Task previews are excluded whenever this is set.
includeProjected	boolean	Include projected (virtual) tasks in the results
Include projected (virtual) tasks in the results
includeWorkflowSteps	boolean	Include workflow steps in the results (Agenda mode)
Include workflow steps in the results (Agenda mode)
defaultSortField	enum	Name DueDate StartDate Category ClientName AssignedUser StatutoryDueDate Stage TimeInStage ClientManager ClientPartner ClientAssociate
Name DueDate StartDate Category ClientName AssignedUser StatutoryDueDate Stage TimeInStage ClientManager ClientPartner ClientAssociate
defaultSortDesc	boolean	Sort in descending order (true) or ascending order (false)
Sort in descending order (true) or ascending order (false)
iconName	string	Optional Lucide icon name for visual identification (e.g., "Calendar", "Users", "Star")
Optional Lucide icon name for visual identification (e.g., "Calendar", "Users", "Star")
color	string	Optional hex color for visual identification (e.g., "#FF5733")
Optional hex color for visual identification (e.g., "#FF5733")
columnConfigJson	string	Optional JSON column configuration for the saved view. When set, overrides the user's default task column preferences.
Optional JSON column configuration for the saved view. When set, overrides the user's default task column preferences.

JSON Example

{
  "name": "string",
  "description": "string",
  "includeInMenu": false,
  "isShared": false,
  "dateRange": "ThisWeek"
}

Used By Operations

POST Create SavedTaskFilter
/tenants/{tenant}/saved-task-filters