Projects

Summary of Endpoints

Get Project

Get project

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

Path parameters

projectId*string

Response

2004XX

Project

Body

application/json

ok*enum

true

item*Project (object)

Request

JavaScriptCurlPython

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

Response

2004XX

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

Complete Project

Mark the project as completed

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

Path parameters

projectId*string

Response

2004XX

Completed project

Body

application/json

ok*boolean

item*nullable all of

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "ok": false,
  "item": {
    "id": "text",
    "name": "text"
  }
}

Restore Project

Restore project

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

Path parameters

projectId*string

Response

2004XX

Restored project

Body

application/json

ok*boolean

item*nullable all of

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "ok": false,
  "item": {
    "id": "text",
    "name": "text"
  }
}

Copy Project

Copy a project to a folder

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

Path parameters

projectId*string

Body

application/json

folderId*string

projectTitlestring

Response

2004XX

Successful Project Copied

Body

application/json

ok*boolean

item*nullable all of

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "ok": false,
  "item": {
    "id": "text",
    "name": "text"
  }
}

Create Project

Create a project in a folder

POSThttps://www.taskade.com/api/v1/projects

Body

application/json

folderId*string

contentType*enum

text/markdown

content*string

Response

2004XX

Successful Project creation

Body

application/json

ok*boolean

item*nullable all of

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "ok": false,
  "item": {
    "id": "text",
    "name": "text"
  }
}

Create From Template

Create a project from a custom template

POSThttps://www.taskade.com/api/v1/projects/from-template

Body

application/json

folderId*string

templateId*string

Response

2004XX

Successful Project creation from template

Body

application/json

ok*boolean

item*nullable all of

Request

JavaScriptCurlPython

const response = await fetch('https://www.taskade.com/api/v1/projects/from-template', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "folderId": "text",
      "templateId": "text"
    }),
});
const data = await response.json();

Response

2004XX

{
  "ok": false,
  "item": {
    "id": "text",
    "name": "text"
  }
}

Get Project Members

Get members of a project

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

Path parameters

projectId*string

Query parameters

Response

2004XX

Project members.

Body

application/json

ok*enum

true

items*array of nullable all of

Request

JavaScriptCurlPython

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

Response

2004XX

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

Get Project Fields

Get all fields for a project

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

Path parameters

projectId*string

Response

2004XX

Project fields

Body

application/json

ok*enum

true

items*array of Field (object)

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "ok": true,
  "items": [
    {
      "id": "text",
      "data": {
        "type": "boolean"
      }
    }
  ]
}

Get Share Link

Get share link for the project

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

Path parameters

projectId*string

Response

2004XX

Share link

Body

application/json

ok*enum

true

item*nullable all of

The share links of a project

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "ok": true,
  "item": {
    "checkUrl": "https://example.com",
    "editUrl": "https://example.com",
    "viewUrl": "https://example.com"
  }
}

Update Share Link

Enable share link in the project

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

Path parameters

projectId*string

Response

2004XX

Share link successfully created

Body

application/json

ok*enum

true

item*ProjectShare (object)

The share links of a project

Request

JavaScriptCurlPython

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

Response

2004XX

{
  "ok": true,
  "item": {
    "checkUrl": "https://example.com",
    "editUrl": "https://example.com",
    "viewUrl": "https://example.com"
  }
}

Get Project Blocks

Get all blocks for a project

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

Path parameters

projectId*string

Query parameters

Response

2004XX

Blocks

Body

application/json

ok*enum

true

items*array of Block (object)

Request

JavaScriptCurlPython

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

Response

2004XX

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

Get Project Tasks

Get all tasks for a project

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

Path parameters

projectId*string

Query parameters

Response

2004XX

Tasks

Body

application/json

ok*enum

true

items*array of Task (object)

Request

JavaScriptCurlPython

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

Response

2004XX

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