Cloud

Confluence Cloud / Reference / REST API v2

Task

Operations

GET

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.

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

read:task:confluence

Connect app scope required: READ

Request

Query parameters

body-format

PrimaryBodyRepresentation

include-blank-tasks

boolean

status

string

task-id

array<integer>

space-id

array<integer>

page-id

array<integer>

blogpost-id

array<integer>

created-by

array<string>

assigned-to

array<string>

completed-by

array<string>

Responses

Returned if the requested tasks are returned.

Headers

Link

string

application/json

MultiEntityResult<Task>

GET/tasks

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestConfluence(route`/wiki/api/v2/tasks`, {
  headers: {
    'Accept': 'application/json'
  }
});

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

200Response

{
  "results": [
    {
      "id": "<string>",
      "localId": "<string>",
      "spaceId": "<string>",
      "pageId": "<string>",
      "blogPostId": "<string>",
      "status": "complete",
      "body": {
        "storage": {},
        "atlas_doc_format": {}
      },
      "createdBy": "<string>",
      "assignedTo": "<string>",
      "completedBy": "<string>",
      "createdAt": "<string>",
      "updatedAt": "<string>",
      "dueAt": "<string>",
      "completedAt": "<string>"
    }
  ],
  "_links": {
    "next": "<string>",
    "base": "<string>"
  }
}

GET

Get task by id

Returns a specific task.

Permissions required: Permission to view the containing page or blog post and its corresponding space.

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

read:task:confluence

Connect app scope required: READ

Request

Path parameters

integer

Required

Query parameters

body-format

PrimaryBodyRepresentation

Responses

Returned if the requested task is returned.

application/json

Task

GET/tasks/{id}

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

const response = await api.asUser().requestConfluence(route`/wiki/api/v2/tasks/{id}`, {
  headers: {
    'Accept': 'application/json'
  }
});

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

200Response

{
  "id": "<string>",
  "localId": "<string>",
  "spaceId": "<string>",
  "pageId": "<string>",
  "blogPostId": "<string>",
  "status": "complete",
  "body": {
    "storage": {
      "representation": "<string>",
      "value": "<string>"
    },
    "atlas_doc_format": {
      "representation": "<string>",
      "value": "<string>"
    }
  },
  "createdBy": "<string>",
  "assignedTo": "<string>",
  "completedBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "dueAt": "<string>",
  "completedAt": "<string>"
}

PUT

Update task

Update a task by id. This endpoint currently only supports updating task status.

Permissions required: Permission to edit the containing page or blog post and view its corresponding space.

Data Security Policy: Not exempt from app access rules

Scopes

OAuth 2.0 scopes required:

write:task:confluence

Connect app scope required: WRITE

Request

Path parameters

integer

Required

Query parameters

body-format

PrimaryBodyRepresentation

Request bodyapplication/json

string

localId

string

spaceId

string

pageId

string

blogPostId

string

status

string

Required

createdBy

string

assignedTo

string

completedBy

string

createdAt

string

Responses

Returned if the requested task is updated.

application/json

Task

PUT/tasks/{id}

Forge

curl

Node.js

Java

Python

PHP

// This sample uses Atlassian Forge
// https://developer.atlassian.com/platform/forge/
import api, { route } from "@forge/api";

var bodyData = `{
  "id": "<string>",
  "localId": "<string>",
  "spaceId": "<string>",
  "pageId": "<string>",
  "blogPostId": "<string>",
  "status": "complete",
  "createdBy": "<string>",
  "assignedTo": "<string>",
  "completedBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "dueAt": "<string>",
  "completedAt": "<string>"
}`;

const response = await api.asUser().requestConfluence(route`/wiki/api/v2/tasks/{id}`, {
  method: 'PUT',
  headers: {
    'Accept': 'application/json',
    'Content-Type': 'application/json'
  },
  body: bodyData
});

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

200Response

{
  "id": "<string>",
  "localId": "<string>",
  "spaceId": "<string>",
  "pageId": "<string>",
  "blogPostId": "<string>",
  "status": "complete",
  "body": {
    "storage": {
      "representation": "<string>",
      "value": "<string>"
    },
    "atlas_doc_format": {
      "representation": "<string>",
      "value": "<string>"
    }
  },
  "createdBy": "<string>",
  "assignedTo": "<string>",
  "completedBy": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "dueAt": "<string>",
  "completedAt": "<string>"
}