List projects
curl --request GET \
--url https://cloud.kaneo.app/api/project \
--header 'Authorization: Bearer <token>'import requests
url = "https://cloud.kaneo.app/api/project"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cloud.kaneo.app/api/project', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.kaneo.app/api/project",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cloud.kaneo.app/api/project"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cloud.kaneo.app/api/project")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.kaneo.app/api/project")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"workspaceId": "<string>",
"slug": "<string>",
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"isPublic": true,
"archivedAt": "2023-11-07T05:31:56Z",
"position": 123,
"lastTaskNumber": 123,
"statistics": {
"completionPercentage": 123,
"totalTasks": 123,
"dueDate": "2023-11-07T05:31:56Z"
},
"archivedTasks": [
{
"id": "<string>",
"title": "<string>",
"number": 123,
"description": "<string>",
"status": "<string>",
"priority": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"position": 123,
"createdAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"assigneeName": "<string>",
"assigneeId": "<string>",
"assigneeImage": "<string>",
"projectId": "<string>",
"labels": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"externalLinks": [
{
"id": "<string>",
"taskId": "<string>",
"integrationId": "<string>",
"resourceType": "<string>",
"externalId": "<string>",
"url": "<string>",
"title": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
],
"plannedTasks": [
{
"id": "<string>",
"title": "<string>",
"number": 123,
"description": "<string>",
"status": "<string>",
"priority": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"position": 123,
"createdAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"assigneeName": "<string>",
"assigneeId": "<string>",
"assigneeImage": "<string>",
"projectId": "<string>",
"labels": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"externalLinks": [
{
"id": "<string>",
"taskId": "<string>",
"integrationId": "<string>",
"resourceType": "<string>",
"externalId": "<string>",
"url": "<string>",
"title": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
],
"columns": [
{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"icon": "<string>",
"isFinal": true,
"tasks": [
{
"id": "<string>",
"title": "<string>",
"number": 123,
"description": "<string>",
"status": "<string>",
"priority": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"position": 123,
"createdAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"assigneeName": "<string>",
"assigneeId": "<string>",
"assigneeImage": "<string>",
"projectId": "<string>",
"labels": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"externalLinks": [
{
"id": "<string>",
"taskId": "<string>",
"integrationId": "<string>",
"resourceType": "<string>",
"externalId": "<string>",
"url": "<string>",
"title": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
}
]"<string>""<string>"Projects
List projects
List a workspace’s projects in sidebar order, each with rollup task statistics. Archived projects are excluded unless includeArchived is set.
GET
/
project
List projects
curl --request GET \
--url https://cloud.kaneo.app/api/project \
--header 'Authorization: Bearer <token>'import requests
url = "https://cloud.kaneo.app/api/project"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://cloud.kaneo.app/api/project', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://cloud.kaneo.app/api/project",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://cloud.kaneo.app/api/project"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://cloud.kaneo.app/api/project")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://cloud.kaneo.app/api/project")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body[
{
"id": "<string>",
"workspaceId": "<string>",
"slug": "<string>",
"icon": "<string>",
"name": "<string>",
"description": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"isPublic": true,
"archivedAt": "2023-11-07T05:31:56Z",
"position": 123,
"lastTaskNumber": 123,
"statistics": {
"completionPercentage": 123,
"totalTasks": 123,
"dueDate": "2023-11-07T05:31:56Z"
},
"archivedTasks": [
{
"id": "<string>",
"title": "<string>",
"number": 123,
"description": "<string>",
"status": "<string>",
"priority": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"position": 123,
"createdAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"assigneeName": "<string>",
"assigneeId": "<string>",
"assigneeImage": "<string>",
"projectId": "<string>",
"labels": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"externalLinks": [
{
"id": "<string>",
"taskId": "<string>",
"integrationId": "<string>",
"resourceType": "<string>",
"externalId": "<string>",
"url": "<string>",
"title": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
],
"plannedTasks": [
{
"id": "<string>",
"title": "<string>",
"number": 123,
"description": "<string>",
"status": "<string>",
"priority": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"position": 123,
"createdAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"assigneeName": "<string>",
"assigneeId": "<string>",
"assigneeImage": "<string>",
"projectId": "<string>",
"labels": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"externalLinks": [
{
"id": "<string>",
"taskId": "<string>",
"integrationId": "<string>",
"resourceType": "<string>",
"externalId": "<string>",
"url": "<string>",
"title": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
],
"columns": [
{
"id": "<string>",
"slug": "<string>",
"name": "<string>",
"icon": "<string>",
"isFinal": true,
"tasks": [
{
"id": "<string>",
"title": "<string>",
"number": 123,
"description": "<string>",
"status": "<string>",
"priority": "<string>",
"startDate": "2023-11-07T05:31:56Z",
"dueDate": "2023-11-07T05:31:56Z",
"position": 123,
"createdAt": "2023-11-07T05:31:56Z",
"userId": "<string>",
"assigneeName": "<string>",
"assigneeId": "<string>",
"assigneeImage": "<string>",
"projectId": "<string>",
"labels": [
{
"id": "<string>",
"name": "<string>",
"color": "<string>"
}
],
"externalLinks": [
{
"id": "<string>",
"taskId": "<string>",
"integrationId": "<string>",
"resourceType": "<string>",
"externalId": "<string>",
"url": "<string>",
"title": "<string>",
"metadata": {},
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}
]
}
]
}
]"<string>""<string>"Authorizations
API key or session token (Bearer)
Query Parameters
Pass "true" to include archived projects in the list.
Response
List of projects
Short prefix used in task identifiers, e.g. KAN-12.
When true the project's board is readable without signing in, via /api/public-project/{id}.
Non-null once archived; archived projects are hidden by default.
Sidebar order, ascending.
Highest task number issued in this project; the next task gets this plus one.
Show child attributes
Show child attributes
Always empty.
Show child attributes
Show child attributes
Always empty.
Show child attributes
Show child attributes
Always empty.
Show child attributes
Show child attributes
Was this page helpful?
⌘I