Audit
Analytics
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
Experimental
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 requiredREAD

OAuth scopes requiredread:inlinetask:confluence
DEPRECATED OAuth scopesread:confluence-content.all
Learn more about deprecated scopes

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
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/inlinetasks/search`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.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 requiredREAD

OAuth scopes requiredread:inlinetask:confluence

Request

Path parameters
inlineTaskId Required

string

Global ID of the inline task

Example

1
2
3
4
5
6
7
8
9
10
11
12
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/inlinetasks/{inlineTaskId}`, {
  headers: {
    'Accept': 'application/json'
  }
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.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 requiredWRITE

OAuth scopes requiredread:inlinetask:confluence, write:inlinetask:confluence

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
8
9
10
11
12
13
14
15
16
17
18
19
// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `{
  "status": "complete"
}`;

const response = await api.asApp().requestConfluence(route`/wiki/rest/api/inlinetasks/{inlineTaskId}`, {
  method: 'PUT',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: bodyData
});

console.log(`Response: ${response.status} ${response.statusText}`);
console.log(await response.json());

Responses

Returned if the inline task was successfully updated.

Content typeValue
application/json

Task

Rate this page: