Skip to main content
GET
List projects

Authorizations

Authorization
string
header
required

API key or session token (Bearer)

Query Parameters

workspaceId
string
required
includeArchived
string

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

Response

List of projects

id
string
required
workspaceId
string
required
slug
string
required

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

icon
string | null
required
name
string
required
description
string | null
required
createdAt
string<date-time>
required
isPublic
boolean | null
required

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

archivedAt
string<date-time> | null
required

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

position
number
required

Sidebar order, ascending.

lastTaskNumber
number
required

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

statistics
object
required
archivedTasks
object[]
required

Always empty.

plannedTasks
object[]
required

Always empty.

columns
object[]
required

Always empty.