TaskadeChangelogDocumentation

Projects

Summary of Endpoints

Get Project

get

Get project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Project
application/json
get
GET /api/v1/projects/{projectId} HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Complete Project

post

Mark the project as completed

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Completed project
application/json
post
POST /api/v1/projects/{projectId}/complete HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Restore Project

post

Restore project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Restored project
application/json
post
POST /api/v1/projects/{projectId}/restore HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Copy Project

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
post
POST /api/v1/projects/{projectId}/copy HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 41

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

Create Project

post

Create a project in a folder

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

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

Create From Template

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
post
POST /api/v1/projects/from-template HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 39

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

Get Project Members

get

Get members of a project

Authorizations
Path parameters
projectIdstringRequired
Query parameters
limitnumberOptionalDefault: 20
pagenumberOptionalDefault: 1
Responses
200
Project members.
application/json
get
GET /api/v1/projects/{projectId}/members HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get Project Fields

get

Get all fields for a project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Project fields
application/json
get
GET /api/v1/projects/{projectId}/fields HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get Share Link

Get share link for the project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Share link
application/json
get
GET /api/v1/projects/{projectId}/shareLink HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Update Share Link

Enable share link in the project

Authorizations
Path parameters
projectIdstringRequired
Responses
200
Share link successfully created
application/json
put
PUT /api/v1/projects/{projectId}/shareLink HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get Project Blocks

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
get
GET /api/v1/projects/{projectId}/blocks HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Get Project Tasks

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
get
GET /api/v1/projects/{projectId}/tasks HTTP/1.1
Host: www.taskade.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Accept: */*

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

Last updated