PlanewardPlaneward Docs
PlanewardPlaneward Docs
Welcome

Developers

REST APIAuthenticationWebhooksMCPEmbedded projectsTask description contentDeveloper hub

API

List labels in a project GETList roles that can be assigned in a project GETList tasks in a project GETCreate a task POSTGet a task GETUpdate a task PATCHDelete a task DELETE
Tasks

Get a task

GET
/tasks/{taskId}

Authorization

x-api-key<token>

In: header

Path Parameters

taskId*string

Response Body

application/json

curl -X GET "https://example.com/tasks/string"
{  "data": {    "id": "string",    "workspaceId": "string",    "projectId": "string",    "title": "string",    "description": "string",    "descriptionContent": [      {}    ],    "statusId": "string",    "parentId": "string",    "priority": "NO_PRIORITY",    "startDate": "2019-08-24T14:15:22Z",    "dueDate": "2019-08-24T14:15:22Z",    "completedAt": "2019-08-24T14:15:22Z",    "version": 0,    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "assignees": [      {        "membershipId": "string",        "displayName": "string",        "image": "string"      }    ],    "assigneeRoles": [      {        "roleId": "string",        "name": "string"      }    ],    "label": {      "id": "string",      "name": "string",      "color": "string",      "icon": "string",      "description": "string"    }  }}

Create a task POST

Creating a task directly in a Done status sets `completedAt` and schedules auto-archive. A status at its blocking WIP limit answers 409. A task created with `parentId` also sends a `task.created` webhook.

Update a task PATCH

All fields are applied in one write with one `version` bump. Moving the task to a Done status sets `completedAt` and schedules auto-archive (an archived task then answers 404); moving it out clears `completedAt`. A status change puts the task at the end of the new column. A status at its blocking WIP limit answers 409. Send `expectedVersion` to reject the write with 409 when someone else changed the task first; omit it and the last write wins.