v1

latestOpenAPI 3.0.12026-07-24241275527.9 KB
Tasks

Get Tasks (Space)

Search among tasks in space.

<b>Scopes:</b> Default, wsReadOnly, wsReadWrite

get/spaces/{spaceId}/tasks

Path parameters

spaceIdstring required

Query parameters

descendantsboolean

Adds all descendant folders to search scope. Applicable only for GET/folders/{folderId}/tasks and GET/spaces/{spaceId}/tasks endpoints

Adds all descendant folders to search scope. Applicable only for GET/folders/{folderId}/tasks and GET/spaces/{spaceId}/tasks endpoints

titlestring

Title filter, contains match

Title filter, contains match

Status filter, match with any of specified constants

  • Active - Active
  • Deferred - Deferred
  • Completed - Completed
  • Cancelled - Cancelled
importance'High' | 'Low' | 'Normal'
  • High
  • Low
  • Normal

Importance filter, exact match

  • High
  • Low
  • Normal

Start date filter, date match or range

Due date filter, date match or range

Scheduled date filter. Both dates should be set in ranged version. Returns all tasks that have schedule intersecting with specified interval, date match or range

Created date filter, range

Updated date filter, range

Completed date filter, range

Authors filter, match of any

Assignees filter with specified users or invitations, match of any

Assignee Placeholders filter, match of any

permalinkstring

Task permalink, exact match

Task permalink, exact match

type'Milestone' | 'Backlog' | 'Planned'
  • Milestone
  • Backlog
  • Planned

Task type

  • Milestone
  • Backlog
  • Planned
limitnumber

Limit on number of returned tasks

Limit on number of returned tasks

sortField'Status' | 'Importance' | 'UpdatedDate' | 'CreatedDate' | 'Title' | 'StartFinishInterval' | 'DueDate' | 'LastAccessDate' | 'CompletedDate'

Sort field

  • Status - Sort by status
  • Importance - Sort by importance
  • UpdatedDate - Sort by updated date
  • CreatedDate - Sort by created date
  • Title - Lexicographic sorting by title
  • StartFinishInterval - Sort by start-finish interval
  • DueDate - Sort by due date
  • LastAccessDate - Sort by last access date
  • CompletedDate - Sort by completed date
sortOrder'Asc' | 'Desc'
  • Asc - Ascending sort order
  • Desc - Descending sort order

Sort order

  • Asc - Ascending sort order
  • Desc - Descending sort order
subTasksboolean

Adds subtasks to search scope

Adds subtasks to search scope

pageSizenumber

The number of tasks to return (max 1000 items per page)

The number of tasks to return (max 1000 items per page)

nextPageTokenstring

A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call

A pagination request will return a token that applies an offset to the next page. The returned value should be used as an input parameter in the next request. Parameter pageSize can be omitted in this case. If you included optional fields to the first request, you will need to include those in each new call

Task metadata filter

[Deprecated] It is recommended to use 'customFields' parameter. Custom field filter

Custom field filters, exact match

Custom statuses filter

withInvitationsboolean

Include invitations in sharedIds & responsibleIds lists

Include invitations in sharedIds & responsibleIds lists

Timelog billing types filter

  • Billable - Billable
  • NonBillable - Non-Billable
plainTextCustomFieldsboolean

Strip HTML tags from custom fields

Strip HTML tags from custom fields

Custom item types filter. Standard type (task) ID is not allowed. Filtering by deleted custom item types is not supported. Limit : 1000

Json string array of optional fields to be included in the response model

  • metadata - Task metadata entries
  • responsibleIds - List of assignee user IDs
  • customItemTypeId - Work Item custom item type Id
  • customFields - Custom fields
  • followerIds - List of user IDs, who follows task, and the additional flag "followedByMe", that indicates if a task is followed by user
  • parentIds - List of task parent folder
  • sharedIds - List of user IDs, who have task share
  • description - Description
  • superTaskIds - List of supertask IDs
  • responsiblePlaceholderIds - List of placeholder assignee IDs
  • superParentIds - List of folder IDs inherited from parent task
  • dependencyIds - Dependency IDs
  • billingType - Billing type
  • attachmentCount - Attachment count
  • workScheduleId - Id of work schedule assigned to task
  • effortAllocation - Effort Allocation
  • hasAttachments - Has attachments
  • subTaskIds - List of subtask IDs
  • recurrent - Is a task recurrent
  • authorIds - Author IDs
  • briefDescription - Brief description

Response

success response

kind'accounts' | 'users' | 'contacts' | 'assets' | 'eDiscoveryReport' | 'folders' | 'folderTree' | 'tasks' | 'taskIds' | 'timelogs' | 'timelogCategories' | 'timelogLockPeriods' | 'timetrackerTimers' | 'comments' | 'attachments' | 'url' | 'version' | 'dataExport' | 'dataExportSchema' | 'auditLog' | 'accessRoles' | 'stream' | 'changes' | 'posts' | 'mailSettings' | 'integrationInfo' | 'gmailIntegrationSettings' | 'workTypesForIntegrations' | 'ids' | 'backups' | 'domains' | 'dependencies' | 'workflows' | 'workschedules' | 'workscheduleExclusions' | 'workscheduleUserExclusions' | 'customfields' | 'customfieldIds' | 'customstatuses' | 'invitations' | 'notifications' | 'jobroles' | 'placeholders' | 'groups' | 'session' | 'dashboards' | 'widgets' | 'taskCreationSettings' | 'colors' | 'experiments' | 'topics' | 'topicComments' | 'webhooks' | 'reviews' | 'boards' | 'textSearch' | 'chatChannels' | 'chatMessages' | 'forms' | 'requestForms' | 'request' | 'report' | 'platformWidgets' | 'platformWidgetInstances' | 'spaces' | 'pdf' | 'customerSatisfaction' | 'asyncJob' | 'approvals' | 'highlights' | 'highlightsList' | 'highlightsSettings' | 'highlightsCard' | 'timesheet' | 'timesheetRow' | 'timesheetSubmissionRule' | 'mobileFeatures' | 'mobileSettings' | 'folderBlueprintTree' | 'taskBlueprintTree' | 'feedback' | 'timeline_snapshot' | 'contactIds' | 'bookings' | 'integrateThreshold' | 'hourlyRatesProvision' | 'hourlyRates' | 'projectTeamMembers' | 'contactsHistory' | 'tasksHistory' | 'foldersHistory' | 'activityDigest' | 'workItemTemplates' | 'workTemplates' | 'workItemMetadata' | 'workItem' | 'customItemTypes' | 'verificationCode' | 'views' | 'listView' | 'tableView' | 'userTypes' | 'reactions' | 'externalRequesters' | 'workscheduleCapacityOverrides' | 'userCapacityOverrides' | 'userCapacityExclusions' | 'rollups' | 'requestFormPrefill' | 'userAggregatedCapacity' | 'cascadingFieldSettings'