getTasks
Retrieve and filter tasks from Teamwork projects, customize reports, and manage task details based on specific criteria, including dates, priorities, statuses, and custom fields.
Instructions
Get tasks, Return multiple tasks according to the optional provided filter.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| CustomFields | No | filter by custom fields | |
| allowAssigneesOutsideProject | No | when filtering by assigned or unassigned tasks, include assignees that are not in the project. | |
| assigneeCompanyIds | No | filter by assignee company ids | |
| assigneeTeamIds | No | filter by assignee team ids | |
| checkForReminders | No | check if task has reminders | |
| completedAfter | No | filter by completed after date | |
| completedBefore | No | filter by completed before date | |
| completedByUserId | No | filter by completed user id | |
| completedOnly | No | only completed tasks | |
| createdAfter | No | filter by created after date | |
| createdBefore | No | filter by created before date | |
| createdByUserIds | No | filter by creator user ids | |
| createdDateCode | No | filter by created date code | |
| createdFilter | No | filter by created filter | |
| crmDealIds | No | filter by crm deal ids | |
| deletedAfter | No | filter on deleted after date | |
| dueAfter | No | filter after a due date | |
| dueBefore | No | filter before a due date | |
| endDate | No | filter on end date | |
| excludeAssigneeNotOnProjectTeams | No | exclude assignee not on project teams | |
| excludeTagIds | No | filter by excluded tag ids | |
| expandedIds | No | the ids of the expanded tasks | |
| extractTemplateRoleName | No | For tasks created in a project template it's possible to assign a role instead of people, companies or teams. This role is then stored with the task name as a prefix. When this flag is enabled it will extract the role name and return it inside a special field. | |
| fallbackToMilestoneDueDate | No | set due date as milestone due date if due date is null and there's a related milestone | |
| fieldsCards | No | Query parameter: fields[cards] | |
| fieldsColumns | No | Query parameter: fields[columns] | |
| fieldsComments | No | Query parameter: fields[comments] | |
| fieldsCompanies | No | Query parameter: fields[companies] | |
| fieldsCustomfieldTasks | No | Query parameter: fields[customfieldTasks] | |
| fieldsCustomfields | No | Query parameter: fields[customfields] | |
| fieldsFiles | No | Query parameter: fields[files] | |
| fieldsGroups | No | Query parameter: fields[groups] | |
| fieldsLockdowns | No | Query parameter: fields[lockdowns] | |
| fieldsMilestones | No | Query parameter: fields[milestones] | |
| fieldsProjectPermissions | No | Query parameter: fields[ProjectPermissions] | |
| fieldsProjects | No | Query parameter: fields[projects] | |
| fieldsTags | No | Query parameter: fields[tags] | |
| fieldsTaskSequences | No | Query parameter: fields[taskSequences] | |
| fieldsTaskgroups | No | Query parameter: fields[taskgroups] | |
| fieldsTasklists | No | Query parameter: fields[tasklists] | |
| fieldsTasks | No | Query parameter: fields[tasks] | |
| fieldsTeams | No | Query parameter: fields[teams] | |
| fieldsTimers | No | Query parameter: fields[timers] | |
| fieldsUsers | No | Query parameter: fields[users] | |
| filterBoardColumnIds | No | filter by board column ids | |
| filterId | No | provide a user saved filter ID | |
| followedByUserIds | No | filter by followed by user ids | |
| getFiles | No | get files | |
| getSubTasks | No | get sub tasks | |
| groupByTaskgroup | No | group by taskgroup | |
| groupByTasklist | No | group by tasklist | |
| ids | No | filter by task ids | |
| include | No | include | |
| includeAllComments | No | include all comments | |
| includeArchivedProjects | No | include archived projects | |
| includeAssigneeCompanies | No | include companies related to the responsible user ids | |
| includeAssigneeTeams | No | include teams related to the responsible user ids | |
| includeAttachmentCommentStats | No | include number of unread and read comments for each file attachment | |
| includeBlocked | No | filter by include blocked | |
| includeCommentStats | No | include number of unread and read comments for each task | |
| includeCompanyUserIds | No | include members of the given companies | |
| includeCompletedPredecessors | No | include ids of completed predecessors. It must be provided with includeRelatedTasks flag or with the predecessors sideload. | |
| includeCompletedTasks | No | include completed tasks | |
| includeCustomFieldIds | No | include specific custom fields | |
| includeCustomFields | No | include custom fields | |
| includeOriginalDueDate | No | include original due date of a task | |
| includeOverdueTasks | No | include overdue tasks | |
| includePrivateItems | No | include private items | |
| includeRelatedTasks | No | include ids of active subtasks, dependencies, predecessors | |
| includeTaskId | No | include task id | |
| includeTasksCount | No | include total count of tasks for given filter | |
| includeTasksFromDeletedLists | No | include tasks from deleted lists | |
| includeTasksWithCards | No | include tasks with cards | |
| includeTasksWithoutDueDates | No | include tasks without due dates | |
| includeTeamUserIds | No | include members of the given teams | |
| includeToday | No | filter by include today | |
| includeTomorrow | No | filter by include tomorrow | |
| includeUntaggedTasks | No | include untagged tasks | |
| includeUpdate | No | include tasks latest update action | |
| isReportDownload | No | generate a report export. | |
| matchAllExcludedTags | No | match all exclude tags | |
| matchAllProjectTags | No | match all project tags | |
| matchAllTags | No | match all tags | |
| nestSubTasks | No | nest sub tasks | |
| notCompletedBefore | No | filter by projects that have not been completed before the given date | |
| onlyAdminProjects | No | only include tasks from projects where the user is strictly a project admin. site admins have visibility to all projects. | |
| onlyStarredProjects | No | filter by starred projects only | |
| onlyTasksWithEstimatedTime | No | only return tasks with estimated time | |
| onlyTasksWithTickets | No | filter by only tasks with tickets | |
| onlyTasksWithUnreadComments | No | filter by only tasks with unread comments | |
| onlyUnplanned | No | only return tasks that are unplanned. Not assigned, no due date or missing estimated time. | |
| onlyUntaggedTasks | No | only untagged tasks | |
| orderBy | No | order by | |
| orderByCustomFieldId | No | order by custom field id when orderBy is equal to custom field | |
| orderMode | No | order mode | |
| page | No | page number | |
| pageSize | No | number of items in a page | |
| parentTaskId | No | filter by parent task ids | |
| priority | No | filter by task priority | |
| projectCategoryIds | No | filter by project category ids | |
| projectCompanyIds | No | filter by company ids | |
| projectFeaturesEnabled | No | filter by projects that have features enabled | |
| projectHealths | No | filter by project healths 0: not set 1: bad 2: ok 3: good | |
| projectIds | No | filter by project ids | |
| projectOwnerIds | No | filter by project owner ids | |
| projectStatuses | No | filter by project status | |
| projectTagIds | No | filter by project tag ids | |
| reportFormat | No | define the format of the report | |
| reportType | No | define the type of the report | |
| responsiblePartyIds | No | filter by responsible party ids | |
| searchAssignees | No | include assignees in the search | |
| searchCompaniesTeams | No | include companies and teams in the search term | |
| searchTerm | No | filter by search term | |
| selectedColumns | No | customize the report by selecting columns to be displayed for planned vs actual. | |
| showCompletedLists | No | include tasks from completed lists | |
| showDeleted | No | include deleted items | |
| skipCRMDealIds | No | skip crm deal ids | |
| skipCounts | No | Skip counts allows you to skip doing counts on a list API endpoint for performance reasons. | |
| sortActiveFirst | No | sort active tasks first | |
| startDate | No | filter on start date | |
| status | No | filter by list of task status | |
| tagIds | No | filter by tag ids | |
| tags | No | filter by tag values | |
| taskFilter | No | filter by a taskFilter | |
| taskIncludedSet | No | filter by task included set | |
| taskgroupIds | No | filter by taskgroup ids | |
| tasklistIds | No | filter by tasklist ids | |
| tasksSelectedColumns | No | customize the report by selecting columns to be displayed for tasks report | |
| today | No | filter by today | |
| updatedAfter | No | filter by updated after date | |
| updatedBefore | No | filter by updated before date | |
| updatedByUserId | No | filter by updated user id | |
| useAllProjects | No | filter on all projects | |
| useFormulaFields | No | use formula fields | |
| useStartDatesForTodaysTasks | No | use start dates for todays tasks | |
| useTaskDateRange | No | use date range logic from table when getting the tasks |