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

Projects

PreviousGet Folder Project TemplatesNextGet Project

Last updated 5 months ago

Summary of Endpoints

Get Project

Complete Project

Restore Project

Copy Project

Create Project

Create From Template

Get Project Members

Get Project Fields

Get Share Link

Update Share Link

Get Project Blocks

Get Project Tasks

鈿欙笍
get

Get project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Project
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId} HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text"
  }
}
post

Mark the project as completed

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Completed project
application/json
4XX
Error description
application/json
post
POST /api/v1/projects/{projectId}/complete HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text"
  }
}
post

Restore project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Restored project
application/json
4XX
Error description
application/json
post
POST /api/v1/projects/{projectId}/restore HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text"
  }
}
get

Get members of a project

Authorizations
Path parameters
projectIdstringRequired
Query parameters
limitnumberOptionalDefault: 20
pagenumberOptionalDefault: 1
Responses
200
Project members.
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/members HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "handle": "text",
      "displayName": "text"
    }
  ]
}
get

Get all fields for a project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Project fields
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/fields HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "id": "text",
      "data": {
        "type": "boolean"
      }
    }
  ]
}
get

Get share link for the project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Share link
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/shareLink HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "checkUrl": "https://example.com",
    "editUrl": "https://example.com",
    "viewUrl": "https://example.com"
  }
}
put

Enable share link in the project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Share link successfully created
application/json
4XX
Error description
application/json
put
PUT /api/v1/projects/{projectId}/shareLink HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "item": {
    "checkUrl": "https://example.com",
    "editUrl": "https://example.com",
    "viewUrl": "https://example.com"
  }
}
get

Get all blocks for a project

Authorizations
Path parameters
projectIdstringRequired
Query parameters
limitnumberOptionalDefault: 100
afterstring 路 uuidOptional

Parameter for cursor-based pagination. Specify task ID to get blocks after it. Do not specify both before and after.

beforestring 路 uuidOptional

Parameter for cursor-based pagination. Specify task ID to get blocks before it. Do not specify both before and after.

Responses
200
Blocks
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/blocks HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "text": "text",
      "completed": false
    }
  ]
}
get

Get all tasks for a project

Authorizations
Path parameters
projectIdstringRequired
Query parameters
limitnumberOptionalDefault: 100
afterstring 路 uuidOptional

Parameter for cursor-based pagination. Specify task ID to get tasks after it. Do not specify both before and after.

beforestring 路 uuidOptional

Parameter for cursor-based pagination. Specify task ID to get tasks before it. Do not specify both before and after.

Responses
200
Tasks
application/json
4XX
Error description
application/json
get
GET /api/v1/projects/{projectId}/tasks HTTP/1.1
Host: www.taskade.com
Accept: */*
{
  "ok": true,
  "items": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "text": "text",
      "parentId": "123e4567-e89b-12d3-a456-426614174000",
      "completed": false
    }
  ]
}
  • Summary of Endpoints
  • Get Project
  • GET/projects/{projectId}
  • Complete Project
  • POST/projects/{projectId}/complete
  • Restore Project
  • POST/projects/{projectId}/restore
  • Copy Project
  • POST/projects/{projectId}/copy
  • Create Project
  • POST/projects
  • Create From Template
  • POST/projects/from-template
  • Get Project Members
  • GET/projects/{projectId}/members
  • Get Project Fields
  • GET/projects/{projectId}/fields
  • Get Share Link
  • GET/projects/{projectId}/shareLink
  • Update Share Link
  • PUT/projects/{projectId}/shareLink
  • Get Project Blocks
  • GET/projects/{projectId}/blocks
  • Get Project Tasks
  • GET/projects/{projectId}/tasks
post

Copy a project to a folder

Authorizations
Path parameters
projectIdstringRequired
Body
folderIdstring 路 min: 1Required
projectTitlestring 路 min: 1Optional
Responses
200
Successful Project Copied
application/json
4XX
Error description
application/json
post
POST /api/v1/projects/{projectId}/copy HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 41

{
  "folderId": "text",
  "projectTitle": "text"
}
{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text"
  }
}
post

Create a project in a folder

Authorizations
Body
folderIdstring 路 min: 1Required
contentTypestring 路 enumRequiredPossible values:
contentstringRequired
Responses
200
Successful Project creation
application/json
4XX
Error description
application/json
post
POST /api/v1/projects HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 66

{
  "folderId": "text",
  "contentType": "text/markdown",
  "content": "text"
}
{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text"
  }
}
post

Create a project from a custom template

Authorizations
Body
folderIdstring 路 min: 1Required
templateIdstring 路 min: 1Required
Responses
200
Successful Project creation from template
application/json
4XX
Error description
application/json
post
POST /api/v1/projects/from-template HTTP/1.1
Host: www.taskade.com
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "folderId": "text",
  "templateId": "text"
}
{
  "ok": true,
  "item": {
    "id": "text",
    "name": "text"
  }
}