Audit
Content
Content - attachments
Content body
Content - children and descendants
Content - macro body
Content comments
Content labels
Content permissions
Content properties
Content restrictions
Content versions
Content watches
Dynamic modules
Group
Inline tasks
Label info
Long-running task
Relation
Search
Settings
Space
Space permissions
Space properties
Space settings
Template
Themes
Users

Rate this page:

Inline tasks

Get inline tasks based on search parameters

GET /wiki/rest/api/inlinetasks/search

Returns inline tasks based on the search query.

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

Connect app scope required: READ

OAuth scopes required: 
read:confluence-content.all

Request

Query parameters
start

integer

The starting offset for the results.

Default: 0, Format: int32
limit

integer

The number of results to be returned.

Default: 20, Format: int32
spaceKey

string

The space key of a space. Multiple space keys can be specified.

pageId

string

The page id of a page. Multiple page ids can be specified.

assignee

string

Account ID of a user to whom a task is assigned. Multiple users can be specified.

creator

string

Account ID of a user to who created a task. Multiple users can be specified.

completedUser

string

Account ID of a user who completed a task. Multiple users can be specified.

duedateFrom

integer

Start of date range based on due dates (inclusive).

Format: int64
duedateTo

integer

End of date range based on due dates (inclusive).

Format: int64
createdateFrom

integer

Start of date range based on create dates (inclusive).

Format: int64
createdateTo

integer

End of date range based on create dates (inclusive).

Format: int64
completedateFrom

integer

Start of date range based on complete dates (inclusive).

Format: int64
completedateTo

integer

End of date range based on complete dates (inclusive).

Format: int64
status

string

The status of the task. (checked/unchecked)

Valid values: complete, incomplete

Example

1
2
3
4
curl --request GET \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/inlinetasks/search' \
  --header 'Authorization: Bearer <access_token>' \
  --header 'Accept: application/json'

Responses

Returned if the query fetches zero or more results.

Content typeValue
application/json

TaskPageResponse

Get inline task based on global ID

GET /wiki/rest/api/inlinetasks/{inlineTaskId}

Returns inline task based on the global ID.

Permissions required: Permission to view the content associated with the task.

Connect app scope required: READ

Request

Path parameters
inlineTaskId Required

string

Global ID of the inline task

Example

1
2
3
curl --request GET \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/inlinetasks/{inlineTaskId}' \
  --header 'Accept: application/json'

Responses

Returned if the inline task was found given the global ID

Content typeValue
application/json

Task

Update inline task given global ID

PUT /wiki/rest/api/inlinetasks/{inlineTaskId}

Updates an inline tasks status given its global ID

Permissions required: Permission to update the content associated with the task.

Connect app scope required: WRITE

Request

Path parameters
inlineTaskId Required

string

Global ID of the inline task to update

Body parameters
status Required

string

Valid values: complete, incomplete

Example

1
2
3
4
5
6
7
curl --request PUT \
  --url 'https://api.atlassian.com/ex/confluence/:cloudId:/wiki/rest/api/inlinetasks/{inlineTaskId}' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '{
  "status": "complete"
}'

Responses

Returned if the inline task was successfully updated.

Content typeValue
application/json

Task

Rate this page: