Teamwork

Links

    Teamwork API

    Getting access, Developing, Testing

    Back to Teamwork

    Get a specific tasklist's tasks.

    Return multiple tasks according to the provided filter.

    Input

    type: object properties: parameters: type: object properties: updatedBefore: type: string format: date-time description: filter by updated before date updatedAfter: type: string format: date-time description: filter by updated after date today: type: string format: date-time description: filter by today taskFilter: type: string enum: - all - anytime - completed - created - overdue - today - yesterday - started - tomorrow - thisweek - within7 - within14 - within30 - within365 - nodate - noduedate - nostartdate - newTaskDefaults - hasDate description: filter by a taskFilter startDate: type: string format: date description: filter on start date searchTerm: type: string description: filter by search term reportType: type: string enum: - plannedvsactual - task description: define the type of the report reportFormat: type: string enum: - html - pdf default: pdf description: define the format of the report priority: type: string description: filter by task priority orderMode: type: string enum: - asc - desc default: asc description: order mode orderBy: type: string enum: - startdate - createdat - priority - project - flattenedtasklist - company - manual - active - completedat - duestartdate - alldates - tasklistname - tasklistdisplayorder - tasklistid - duedate - updatedat - taskname - createdby - completedby - assignedto - taskstatus - taskduedate - customfield - estimatedtime - boardcolumn - taskgroupid - taskgroupname - taskgroup - displayorder - projectmanual - stagedisplayorder default: duedate description: order by endDate: type: string format: date description: filter on end date deletedAfter: type: string format: date-time description: filter on deleted after date createdFilter: type: string enum: - anytime - today - yesterday - custom description: filter by created filter createdDateCode: type: string description: filter by created date code createdBefore: type: string format: date-time description: filter by created before date createdAfter: type: string format: date-time description: filter by created after date completedBefore: type: string format: date-time description: filter by completed before date completedAfter: type: string format: date-time description: filter by completed after date tasklistId: type: integer parentTaskId: type: integer description: filter by parent task ids pageSize: type: integer default: '50' description: number of items in a page page: type: integer default: '1' description: page number orderByCustomFieldId: type: integer description: order by custom field id when orderBy is equal to customfield includeTaskId: type: integer description: include task id filterId: type: integer description: provide a user saved filter ID completedByUserId: type: integer description: filter by completer user id useStartDatesForTodaysTasks: type: boolean description: use start dates for todays tasks useAllProjects: type: boolean description: filter on all projects showDeleted: type: boolean default: 'false' description: include deleted items showCompletedLists: type: boolean description: include tasks from completed lists searchCompaniesTeams: type: boolean description: include companies and teams in the search term searchAssignees: type: boolean description: include assignees in the search onlyUntaggedTasks: type: boolean description: only untagged tasks onlyUnplanned: type: boolean default: 'false' description: |- only return tasks that are unplanned. Not assigned, no due date or missing estimated time. onlyTasksWithUnreadComments: type: boolean description: filter by only tasks with unread comments onlyTasksWithTickets: type: boolean description: filter by only tasks with tickets onlyTasksWithEstimatedTime: type: boolean description: only return tasks with estimated time onlyStarredProjects: type: boolean description: filter by starred projects only onlyAdminProjects: type: boolean description: >- only include tasks from projects where the user is strictly a project admin. site admins have visibility to all projects. nestSubTasks: type: boolean description: nest sub tasks matchAllTags: type: boolean description: match all tags matchAllProjectTags: type: boolean description: match all project tags matchAllExcludedTags: type: boolean description: match all exclude tags isReportDownload: type: boolean default: 'false' description: generate a report export. includeUpdate: type: boolean description: include tasks latest update action includeUntaggedTasks: type: boolean description: include untagged tasks includeToday: type: boolean description: filter by include today includeTasksWithoutDueDates: type: boolean description: include tasks without due dates includeTasksWithCards: type: boolean default: 'true' description: include tasks with cards includeTasksFromDeletedLists: type: boolean description: include tasks from deleted lists includeRelatedTasks: type: boolean description: >- include ids of completed and active subtasks, dependencies, predecessors includePrivateItems: type: boolean description: include private items includeOverdueTasks: type: boolean description: include overdue tasks includeOriginalDueDate: type: boolean description: include original due date of a task includeCustomFields: type: boolean default: 'false' description: include custom fields includeCompletedTasks: type: boolean description: include completed tasks includeCommentStats: type: boolean default: 'false' description: include number of unread and read comments for each task includeBlocked: type: boolean description: filter by include blocked includeAttachmentCommentStats: type: boolean default: 'false' description: include number of unread and read comments for each file attachment includeAssigneeTeams: type: boolean description: include teams related to the responsible user ids includeAssigneeCompanies: type: boolean description: include companies related to the responsible user ids includeArchivedProjects: type: boolean description: include archived projects includeAllComments: type: boolean description: include all comments groupByTasklist: type: boolean description: group by tasklist groupByTaskgroup: type: boolean description: group by taskgroup getSubTasks: type: boolean description: get sub tasks getFiles: type: boolean description: get files fallbackToMilestoneDueDate: type: boolean description: >- set due date as milestone due date if due date is null and there's a related milestone excludeAssigneeNotOnProjectTeams: type: boolean description: exclude assignee not on project teams completedOnly: type: boolean default: 'false' description: only completed tasks checkForReminders: type: boolean description: check if task has reminders allowAssigneesOutsideProject: type: boolean default: 'true' description: |- when filtering by assigned or unassagned tasks, include assignees that are not in the project. tasklistIds: type: array items: type: integer description: filter by tasklist ids taskgroupIds: type: array items: type: integer description: filter by taskgroup ids taskIncludedSet: type: array items: enum: - overdue - nodate - nostartdate - noduedate - nostartwithfutureduedate - taskListNames - projectNames type: string description: filter by task included set tags: type: array items: type: string description: filter by tag values tagIds: type: array items: type: integer description: filter by tag ids status: type: array items: enum: - upcoming - late - all type: string description: filter by list of task status skipCRMDealIds: type: array items: type: integer description: skip crm deal ids selectedColumns: type: array items: type: string description: >- customise the report by selecting columns to be displayed for planned vs actual. responsiblePartyIds: type: array items: type: integer description: filter by responsible party ids projectTagIds: type: array items: type: integer description: filter by project tag ids projectStatuses: type: array items: enum: - active - current - late - upcoming - completed - deleted type: string description: filter by project status projectOwnerIds: type: array items: type: integer description: filter by project owner ids projectIds: type: array items: type: integer description: filter by project ids projectHealths: type: array items: enum: - '0' - '1' - '2' - '3' type: integer description: |- filter by project healths 0: not set 1: bad 2: ok 3: good projectFeaturesEnabled: type: array items: enum: - list - board - gantt - table - dashboard - milestones - messages - files - time - notebooks - risks - links - billing - comments - people - settings type: string description: filter by projects that have features enabled projectCompanyIds: type: array items: type: integer description: filter by company ids projectCategoryIds: type: array items: type: integer description: filter by project category ids include: type: array items: enum: - projects - projects.companies - projects.categories - tasklists - parentTasks - companies - teams - users - milestones - comments - comments.users - tags - cards - cards.columns - timeTotals - taskSequences - commentFollowers - changeFollowers - lockdowns - lockdowns.users - lockdowns.companies - lockdowns.teams - lockdowns.users.companies - lockdowns.companies.users - lockdowns.teams.users - attachments - attachments.users - subtaskStats - timers - predecessors - permissions type: string description: include ids: type: array items: type: integer description: filter by task ids followedByUserIds: type: array items: type: integer description: filter by followed by user ids filterBoardColumnIds: type: array items: type: integer description: filter by board column ids fields[users]: type: array items: enum: - id - firstName - lastName - title - email - companyId - company - isAdmin - isClientUser - isServiceAccount - type - deleted - avatarUrl - lengthOfDay - workingHoursId - workingHour - userRate - userCost - canAddProjects type: string fields[timers]: type: array items: enum: - id - userId - taskId - projectId - description - running - billable - deleted - dateCreated - dateDeleted - duration - lastStartedAt - serverTime - intervals type: string fields[teams]: type: array items: enum: - id - name - teamLogo - teamLogoIcon - teamLogoColor type: string fields[tasks]: type: array items: enum: - id - name - dateUpdated - parentTaskId - isPrivate - status - tasklistId - startDate - dueDate type: string fields[tasklists]: type: array items: enum: - id - name - projectId - milestoneId type: string fields[taskgroups]: type: array items: enum: - id - name - description - displayOrder - projectId - status type: string fields[taskSequences]: type: array items: enum: - id - installationId - frequency - selectedWeekDays - endDate - monthlyRepeatType - duration - rrule type: string fields[tags]: type: array items: enum: - id - name - color - count type: string fields[projects]: type: array items: enum: - id - name type: string fields[milestones]: type: array items: enum: - id - name - description - deadline - completed - projectId - createdOn - lastChangedOn - creatorUserId - reminder - private - lockdownId - status - completedOn - completerId - percentageComplete type: string fields[lockdowns]: type: array items: enum: - id - userID - updatedAt - itemType - itemID - grantAccessTo type: string fields[files]: type: array items: enum: - isPrivate - latestFileVersionNo - versionId - status - description - lockdownId - tagIds - changeFollowers - commentFollowers - originalName - displayName - isLocked - lockedByUserId - lockedDate - size - uploadedDate - uploadedByUserID - updatedAt - deletedAt - deletedBy - fileSource - projectId - numLikes - reactions - versions - downloadURL - previewURL - thumbURL - relatedItems - commentsCount - commentsCountRead - categoryId type: string fields[companies]: type: array items: enum: - id - name - logoUploadedToServer - logoImage type: string fields[comments]: type: array items: enum: - id - objectType - objectId - title type: string fields[columns]: type: array items: enum: - id - name - color - displayOrder - createdAt - updatedAt - settings - sort - sortOrder - deletedAt - project - hasTriggers - deleted - stats - defaultTasklist type: string fields[cards]: type: array items: enum: - id - displayOrder - archived - archivedAt - archivedBy - createdAt - createBy - updatedAt - visible - status - deleteBy - deletedAt type: string fields[ProjectPermissions]: type: array items: enum: - viewMessagesAndFiles - viewTasksAndMilestones - viewTime - viewNotebooks - viewRiskRegister - viewEstimatedTime - viewInvoices - addTasks - addRisks - manageCustomFields - addExpenses - editAllTasks - addMilestones - addTaskLists - addMessages - addFiles - addTime - addNotebooks - viewLinks - addLinks - canViewForms - addForms - viewAllTimeLogs - setPrivacy - projectAdministrator - viewProjectUpdate - addProjectUpdate - canViewProjectMembers - canViewProjectBudget - canManageProjectBudget - canViewRates - canManageRates - canViewSchedule - canManageSchedule - receiveEmailNotifications - isObserving - isArchived - active - canAccess - inOwnerCompany - canManagePeople - canViewProjectTemplates - canManageProjectTemplates type: string expandedIds: type: array items: type: integer description: the ids of the expanded tasks excludeTagIds: type: array items: type: integer description: filter by excluded tag ids crmDealIds: type: array items: type: integer description: filter by crm deal ids createdByUserIds: type: array items: type: integer description: filter by creator user ids assigneeTeamIds: type: array items: type: integer description: filter by assignee team ids assigneeCompanyIds: type: array items: type: integer description: filter by assignee company ids CustomFields: type: array items: type: string description: filter by custom fields required: - tasklistId title: Parameters

    Output

    type: object title: tasksResponseV205 properties: included: type: object title: Included properties: cards: type: object columns: type: object comments: type: object companies: type: object customfieldTasks: type: object customfields: type: object files: type: object lockdowns: type: object milestones: type: object projectCategories: type: object projectPermissions: type: object projects: type: object subtaskStats: type: object tags: type: object taskSequences: type: object taskgroups: type: object tasklists: type: object tasks: type: object teams: type: object timeTotals: type: object timers: type: object users: type: object meta: type: object title: Meta properties: averageSpend: type: integer limit: type: integer nextCursor: type: string page: type: object title: MetaPage properties: count: type: integer hasMore: type: boolean pageOffset: type: integer pageSize: type: integer prevCursor: type: string totalCapacity: type: integer tasks: type: array items: type: object title: TaskV205 properties: accumulatedEstimatedMinutes: type: integer assigneeCompanies: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string assigneeCompanyIds: type: array items: type: integer assigneeTeamIds: type: array items: type: integer assigneeTeams: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string assigneeUserIds: type: array items: type: integer assigneeUsers: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string assignees: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string attachments: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string capacities: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string card: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string changeFollowers: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string column: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string commentFollowers: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string completedAt: type: string completedBy: type: integer completedOn: type: string createdAt: type: string createdBy: type: integer createdByUserId: type: integer crmDealIds: type: array items: type: integer dateUpdated: type: string decimalDisplayOrder: type: number dependencyIds: type: array items: type: integer description: type: string descriptionContentType: type: string displayOrder: type: integer dueDate: type: string dueDateOffset: type: integer estimateMinutes: type: integer hasDeskTickets: type: boolean hasReminders: type: boolean id: type: integer isArchived: type: boolean isBlocked: type: boolean isPrivate: type: integer latestUpdates: type: array items: type: object title: Audit properties: after: {} before: {} field: type: string lockdown: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string meta: type: object name: type: string originalDueDate: type: object title: Date outOfSequence: type: boolean parentTask: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string parentTaskId: type: integer predecessorIds: type: array items: type: integer predecessors: type: array items: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string priority: type: string progress: type: integer sequence: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string sequenceDueDate: type: object title: Date sequenceId: type: integer sequenceRootTask: type: boolean sequenceStartDate: type: object title: Date stageTaskDisplayOrder: type: number startDate: type: string startDateOffset: type: integer status: type: string subTaskIds: type: array items: type: integer tagIds: type: array items: type: integer tasklist: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string tasklistId: type: integer timer: type: object title: Relationship properties: id: type: integer meta: type: object type: type: string updatedAt: type: string updatedBy: type: integer userPermissions: type: object title: TaskPermissions properties: canAddSubtasks: type: boolean canComplete: type: boolean canEdit: type: boolean canLogTime: type: boolean canViewEstTime: type: boolean