Tasks

PreviousUpdate Share Link NextCreate Task

Last updated 2 months ago

Get task with id

GEThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}

Authorization

Path parameters

projectId*string

taskId*string

Response

Task

Body

ok*boolean

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}

Delete a task in a project

DELETEhttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}

Authorization

Path parameters

projectId*string

taskId*string

Response

Successful Task deletion

Body

ok*enum

true

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true
}

Update task.

PUThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}

Authorization

Path parameters

projectId*string

taskId*string

Body

contentType*enum

text/markdowntext/plain

content*string

Pattern: ^[^\r\n]*$

Response

Updated task

Body

ok*boolean

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "contentType": "text/markdown",
      "content": "text"
    }),
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}

Complete a task in a project

POSThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/complete

Authorization

Path parameters

projectId*string

taskId*string

Response

Successful complete a Task

Body

ok*enum

true

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/complete', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}

Mark a task as incomplete in a project

POSThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/uncomplete

Authorization

Path parameters

projectId*string

taskId*string

Response

Successful mark the Task as incomplete

Body

ok*enum

true

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/uncomplete', {
    method: 'POST',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}

Create a task in a project

POSThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/

Authorization

Path parameters

projectId*string

Body

tasks*array of all of

Response

Successful Tasks creation

Body

ok*enum

true

item*array of object

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "tasks": [
        {
          "contentType": "text/markdown",
          "content": "text",
          "taskId": "null",
          "placement": "afterbegin"
        }
      ]
    }),
});
const data = await response.json();

Response

{
  "ok": true,
  "item": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "text": "text",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "completed": false
    }
  ]
}

Move a task within the project

PUThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/move

Authorization

Path parameters

projectId*string

taskId*string

Body

target*object

Response

Successful move Task

Body

ok*enum

true

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/move', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "target": {
        "taskId": "text",
        "position": "beforebegin"
      }
    }),
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}

Get the assignees of a task

GEThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/assignees

Authorization

Path parameters

projectId*string

taskId*string

Response

Task assignees

Body

ok*boolean

items*array of object

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/assignees', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true,
  "items": [
    {
      "handle": "text",
      "displayName": "text"
    }
  ]
}

Task assignment

PUThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/assignees

Authorization

Path parameters

projectId*string

taskId*string

Body

handles*array of string

Response

Successful Task assignment

Body

ok*enum

true

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/assignees', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "handles": [
        null
      ]
    }),
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}

Remove assignee from a task

DELETEhttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/assignees/{assigneeHandle}

Authorization

Path parameters

projectId*string

taskId*string

assigneeHandle*string

Response

Successful Task Assignment deletion

Body

ok*enum

true

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/assignees/{assigneeHandle}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}

Get the date of a task

GEThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/date

Authorization

Path parameters

projectId*string

taskId*string

Response

Task Date

Body

ok*enum

true

item*object

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/date', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "start": {
      "date": "text",
      "time": "text",
      "timezone": "text"
    },
    "end": {
      "date": "text",
      "time": "text",
      "timezone": "text"
    }
  }
}

Delete date of a task

DELETEhttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/date

Authorization

Path parameters

projectId*string

taskId*string

Response

Successful Task Date deletion

Body

ok*enum

true

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/date', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}

Create or update date for a task

PUThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/date

Authorization

Path parameters

projectId*string

taskId*string

Body

start*object

endobject

Response

Successful Task Date create or update

Body

ok*enum

true

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/date', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "start": {
        "date": "text"
      },
      "end": {
        "date": "text"
      }
    }),
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}

Get the note of a task

GEThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/note

Authorization

Path parameters

projectId*string

taskId*string

Response

Task Note

Body

ok*boolean

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/note', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "type": "text",
    "value": "text"
  }
}

Add/update a note to the task

PUThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/note

Authorization

Path parameters

projectId*string

taskId*string

Body

type*enum

text/plaintext/markdown

value*string

Pattern: ^[^\r\n]*$

Response

Successful Task Note creation/update

Body

ok*boolean

item*nullable all of

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/note', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "type": "text/plain",
      "value": "text"
    }),
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "type": "text",
    "value": "text"
  }
}

Delete the note of a task

DELETEhttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/note

Authorization

Path parameters

projectId*string

taskId*string

Response

Successful Task Note deletion

Body

ok*boolean

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/note', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true
}

Get the field value of a task

GEThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/fields/{fieldId}

Authorization

Path parameters

projectId*string

taskId*string

fieldId*string

Response

Task field value

Body

ok*boolean

item*object

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/fields/{fieldId}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true,
  "item": {
    "fieldId": "text",
    "value": null
  }
}

Delete the field value of a task

DELETEhttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/fields/{fieldId}

Authorization

Path parameters

projectId*string

taskId*string

fieldId*string

Response

Successful field value deletion

Body

ok*boolean

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/fields/{fieldId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

{
  "ok": true
}

Update/create the field value of a task

PUThttps://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/fields/{fieldId}

Authorization

Path parameters

projectId*string

taskId*string

fieldId*string

Body

value*any of

Response

Successful field value create/update

Body

ok*boolean

Request

const response = await fetch('https://www.taskade.com/api/v1/projects/{projectId}/tasks/{taskId}/fields/{fieldId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

{
  "ok": true
}

Summary of Endpoints

Get Task

Delete Task

Update Task

Complete Task

Uncomplete Task

Create Task

Move Task

Get Task Assignees

Update Task Assignees

Delete Task Assignee

Get Task Date

Delete Task Date

Update Task Date

Get Task Note

Update Task Note

Delete Task Note

Get Task Field

Delete Task Field

Update Task Field

Summary of Endpoints

Get Task

Delete Task

Update Task

Complete Task

Uncomplete Task

Create Task

Move Task

Get Task Assignees

Update Task Assignees

Delete Task Assignee

Get Task Date

Delete Task Date

Update Task Date

Get Task Note

Update Task Note

Delete Task Note

Get Task Field

Delete Task Field

Update Task Field