Get Tasks (Space)

Search among tasks in space.

Scopes: Default, wsReadOnly, wsReadWrite

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
Query Params
boolean

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

string

Title filter, contains match

status
array of objects

Status filter, match with any of specified constants

  • Active - Active
  • Deferred - Deferred
  • Completed - Completed
  • Cancelled - Cancelled
status
string
enum

Importance filter, exact match

  • High
  • Low
  • Normal
Allowed:
startDate
object

Start date filter, date match or range

dueDate
object

Due date filter, date match or range

scheduledDate
object

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

createdDate
object

Created date filter, range

updatedDate
object

Updated date filter, range

completedDate
object

Completed date filter, range

authors
array of objects

Authors filter, match of any

authors
responsibles
array of strings

Assignees filter with specified users or invitations, match of any

responsibles
responsiblePlaceholders
array of objects

Assignee Placeholders filter, match of any

responsiblePlaceholders
string
string
enum

Task type

  • Milestone
  • Backlog
  • Planned
Allowed:
number

Limit on number of returned tasks

string
enum

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
string
enum

Sort order

  • Asc - Ascending sort order
  • Desc - Descending sort order
Allowed:
boolean

Adds subtasks to search scope

number

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

string

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

metadata
object

Task metadata filter

customField
object

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

customFields
array of objects

Custom field filters, exact match

customFields
customStatuses
array of objects

Custom statuses filter

customStatuses
boolean

Include invitations in sharedIds & responsibleIds lists

billingTypes
array of objects

Timelog billing types filter

  • Billable - Billable
  • NonBillable - Non-Billable
billingTypes
boolean

Strip HTML tags from custom fields

customItemTypes
array of objects
length ≤ 1000

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

customItemTypes
fields
array of strings

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
fields
Responses

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json