v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Task

Get tasks

Returns all tasks. The number of results is limited by the limit parameter and additional results (if available) will be available through the next URL present in the Link response header.

Permissions required: Permission to access the Confluence site ('Can use' global permission). Only tasks that the user has permission to view will be returned.

get/tasks

Query parameters

body-format'storage' | 'atlas_doc_format'

The primary formats a body can be represented as. A subset of BodyRepresentation. These formats are the only allowed formats in certain use cases.

The content format types to be returned in the body field of the response. If available, the representation will be available under a response field of the same name under the body field.

include-blank-tasksboolean

Specifies whether to include blank tasks in the response. Defaults to true.

status'complete' | 'incomplete'

Filters on the status of the task.

task-idinteger[]

Filters on task ID. Multiple IDs can be specified.

space-idinteger[]

Filters on the space ID of the task. Multiple IDs can be specified.

page-idinteger[]

Filters on the page ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.

blogpost-idinteger[]

Filters on the blog post ID of the task. Multiple IDs can be specified. Note - page and blog post filters can be used in conjunction.

created-bystring[]

Filters on the Account ID of the user who created this task. Multiple IDs can be specified.

assigned-tostring[]

Filters on the Account ID of the user to whom this task is assigned. Multiple IDs can be specified.

completed-bystring[]

Filters on the Account ID of the user who completed this task. Multiple IDs can be specified.

created-at-frominteger

Filters on start of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.

created-at-tointeger

Filters on end of date-time range of task based on creation date (inclusive). Input is epoch time in milliseconds.

due-at-frominteger

Filters on start of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.

due-at-tointeger

Filters on end of date-time range of task based on due date (inclusive). Input is epoch time in milliseconds.

completed-at-frominteger

Filters on start of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.

completed-at-tointeger

Filters on end of date-time range of task based on completion date (inclusive). Input is epoch time in milliseconds.

cursorstring

Used for pagination, this opaque cursor will be returned in the next URL in the Link response header. Use the relative URL in the Link header to retrieve the next set of results.

limitinteger

Maximum number of tasks per result to return. If more results exist, use the Link header to retrieve a relative URL that will return the next set of results.

Response

Returned if the requested tasks are returned.