Taskade API
TaskadeChangelogDocumentation
  • Introduction
  • 👋Getting Started
    • Personal Tokens
    • OAuth 2.0 Authentication
  • 🤖TaskOS (Coming Soon)
    • Introduction
  • ⚙️API reference
    • Workspaces
      • Get Workspaces
      • Get Projects
      • Get Folders
    • Folders
      • Get Folder Projects
      • Generate Agent in Folder
      • Create Agent in Folder
      • Get Folder Agents
      • Get Folder Medias
      • Get Folder Project Templates
    • Projects
      • Get Project
      • Complete Project
      • Restore Project
      • Copy Project
      • Create Project
      • Create From Template
      • Get Project Members
      • Get Project Fields
      • Get Project Tasks
      • Get Project Block
      • Get Share Link
      • Update Share Link
    • Tasks
      • Create Task
      • Get Task
      • Update Task
      • Move Task
      • Complete Task
      • Uncomplete Task
      • Delete Task
      • Get Task Assignees
      • Update Task Assignees
      • Delete Task Assignees
      • Get Task Date
      • Update Task Date
      • Delete Task Date
      • Get Task Note
      • Update Task Note
      • Delete Task Note
      • Get Task Field
      • Update Task Field
      • Delete Task Field
    • Agents
      • Get Agent
      • Delete Agent
      • Update Agent
      • Get Public Agent
      • Update Public Agent
      • Update Agent Public Access
      • Add Project to Knowledge
      • Add Media to Knowledge
      • Remove Project from Knowledge
      • Remove Media from Knowledge
      • Get Conversations
      • Get Conversation
      • Inbound Webhooks
    • Media
      • Get Media
      • Delete Media
    • Me
      • Get Projects
    • Specifications
  • 🔗Links
    • Taskade
    • Changelog
    • Documentation
    • Community Forum
Powered by GitBook
On this page
  1. API reference

Tasks

PreviousUpdate Share LinkNextCreate Task

Last updated 5 months ago

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

⚙️
get

Get task with id

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Responses
200
Task
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/tasks/{taskId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}
delete

Delete a task in a project

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Responses
200
Successful Task deletion
application/json
4XX
Error description
application/json
delete
DELETE /api/v1/projects/{projectId}/tasks/{taskId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true
}
post

Complete a task in a project

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Responses
200
Successful complete a Task
application/json
4XX
Error description
application/json
post
POST /api/v1/projects/{projectId}/tasks/{taskId}/complete HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}
post

Mark a task as incomplete in a project

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Responses
200
Successful mark the Task as incomplete
application/json
4XX
Error description
application/json
post
POST /api/v1/projects/{projectId}/tasks/{taskId}/uncomplete HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}
get

Get the assignees of a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Responses
200
Task assignees
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/tasks/{taskId}/assignees HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "handle": "text",
      "displayName": "text"
    }
  ]
}
delete

Remove assignee from a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
assigneeHandlestringRequired
Responses
200
Successful Task Assignment deletion
application/json
4XX
Error description
application/json
delete
DELETE /api/v1/projects/{projectId}/tasks/{taskId}/assignees/{assigneeHandle} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}
get

Get the date of a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Responses
200
Task Date
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/tasks/{taskId}/date HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "start": {
      "date": "text",
      "time": "text",
      "timezone": "text"
    },
    "end": {
      "date": "text",
      "time": "text",
      "timezone": "text"
    }
  }
}
delete

Delete date of a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Responses
200
Successful Task Date deletion
application/json
4XX
Error description
application/json
delete
DELETE /api/v1/projects/{projectId}/tasks/{taskId}/date HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}
get

Get the note of a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Responses
200
Task Note
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/tasks/{taskId}/note HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "type": "text",
    "value": "text"
  }
}
delete

Delete the note of a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Responses
200
Successful Task Note deletion
application/json
4XX
Error description
application/json
delete
DELETE /api/v1/projects/{projectId}/tasks/{taskId}/note HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true
}
get

Get the field value of a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
fieldIdstringRequired
Responses
200
Task field value
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/tasks/{taskId}/fields/{fieldId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "fieldId": "text",
    "value": null
  }
}
delete

Delete the field value of a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
fieldIdstringRequired
Responses
200
Successful field value deletion
application/json
4XX
Error description
application/json
delete
DELETE /api/v1/projects/{projectId}/tasks/{taskId}/fields/{fieldId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true
}
  • Summary of Endpoints
  • Get Task
  • GET/projects/{projectId}/tasks/{taskId}
  • Delete Task
  • DELETE/projects/{projectId}/tasks/{taskId}
  • Update Task
  • PUT/projects/{projectId}/tasks/{taskId}
  • Complete Task
  • POST/projects/{projectId}/tasks/{taskId}/complete
  • Uncomplete Task
  • POST/projects/{projectId}/tasks/{taskId}/uncomplete
  • Create Task
  • POST/projects/{projectId}/tasks/
  • Move Task
  • PUT/projects/{projectId}/tasks/{taskId}/move
  • Get Task Assignees
  • GET/projects/{projectId}/tasks/{taskId}/assignees
  • Update Task Assignees
  • PUT/projects/{projectId}/tasks/{taskId}/assignees
  • Delete Task Assignee
  • DELETE/projects/{projectId}/tasks/{taskId}/assignees/{assigneeHandle}
  • Get Task Date
  • GET/projects/{projectId}/tasks/{taskId}/date
  • Delete Task Date
  • DELETE/projects/{projectId}/tasks/{taskId}/date
  • Update Task Date
  • PUT/projects/{projectId}/tasks/{taskId}/date
  • Get Task Note
  • GET/projects/{projectId}/tasks/{taskId}/note
  • Update Task Note
  • PUT/projects/{projectId}/tasks/{taskId}/note
  • Delete Task Note
  • DELETE/projects/{projectId}/tasks/{taskId}/note
  • Get Task Field
  • GET/projects/{projectId}/tasks/{taskId}/fields/{fieldId}
  • Delete Task Field
  • DELETE/projects/{projectId}/tasks/{taskId}/fields/{fieldId}
  • Update Task Field
  • PUT/projects/{projectId}/tasks/{taskId}/fields/{fieldId}
put

Update task.

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Body
contentTypestring · enumRequiredPossible values:
contentstring · max: 2000RequiredPattern: ^[^\r\n]*$
Responses
200
Updated task
application/json
4XX
Error description
application/json
put
PUT /api/v1/projects/{projectId}/tasks/{taskId} HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 48

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

Create a task in a project

Authorizations
Path parameters
projectIdstringRequired
Body
Responses
200
Successful Tasks creation
application/json
4XX
Error description
application/json
post
POST /api/v1/projects/{projectId}/tasks/ HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 101

{
  "tasks": [
    {
      "contentType": "text/markdown",
      "content": "text",
      "taskId": "null",
      "placement": "afterbegin"
    }
  ]
}
{
  "ok": true,
  "item": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "text": "text",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "completed": false
    }
  ]
}
put

Move a task within the project

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Body
Responses
200
Successful move Task
application/json
4XX
Error description
application/json
put
PUT /api/v1/projects/{projectId}/tasks/{taskId}/move HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 53

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

Task assignment

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Body
handlesstring[]Required
Responses
200
Successful Task assignment
application/json
4XX
Error description
application/json
put
PUT /api/v1/projects/{projectId}/tasks/{taskId}/assignees HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 20

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

Create or update date for a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Body
Responses
200
Successful Task Date create or update
application/json
4XX
Error description
application/json
put
PUT /api/v1/projects/{projectId}/tasks/{taskId}/date HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 111

{
  "start": {
    "date": "text",
    "time": "text",
    "timezone": "text"
  },
  "end": {
    "date": "text",
    "time": "text",
    "timezone": "text"
  }
}
{
  "ok": true,
  "item": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "text": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "completed": false
  }
}
put

Add/update a note to the task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
Body
typestring · enumRequiredPossible values:
valuestring · min: 1RequiredPattern: ^[^\r\n]*$
Responses
200
Successful Task Note creation/update
application/json
4XX
Error description
application/json
put
PUT /api/v1/projects/{projectId}/tasks/{taskId}/note HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 36

{
  "type": "text/plain",
  "value": "text"
}
{
  "ok": true,
  "item": {
    "type": "text",
    "value": "text"
  }
}
put

Update/create the field value of a task

Authorizations
Path parameters
projectIdstringRequired
taskIdstringRequired
fieldIdstringRequired
Body
valueany ofRequired
numberOptional
or
string · min: 1Optional
Responses
200
Successful field value create/update
application/json
4XX
Error description
application/json
put
PUT /api/v1/projects/{projectId}/tasks/{taskId}/fields/{fieldId} HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 11

{
  "value": 1
}
{
  "ok": true
}