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

Query parameters

workspaceIdstring required
includeArchivedstring

Pass "true" to include archived projects in the list.

Pass "true" to include archived projects in the list.

Response

List of projects

idstring required
workspaceIdstring required
slugstring required

Short prefix used in task identifiers, e.g. KAN-12.

iconstring nullable required
namestring required
descriptionstring nullable required
createdAtstring date-time required
isPublicboolean nullable required

When true the project's board is readable without signing in, via /api/public-project/{id}.

archivedAtstring date-time nullable required

Non-null once archived; archived projects are hidden by default.

positionnumber required

Sidebar order, ascending.

lastTaskNumbernumber required

Highest task number issued in this project; the next task gets this plus one.

Changes