> ## Documentation Index
> Fetch the complete documentation index at: https://kaneo.app/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# List projects

> List a workspace's projects in sidebar order, each with rollup task statistics. Archived projects are excluded unless includeArchived is set.



## OpenAPI

````yaml /openapi.json get /project
openapi: 3.1.0
info:
  title: Kaneo API
  version: 1.0.0
  description: Kaneo Project Management API - Manage projects, tasks, labels, and more
servers:
  - url: https://cloud.kaneo.app/api
    description: Kaneo API Server
security:
  - bearerAuth: []
paths:
  /project:
    get:
      tags:
        - Projects
      summary: List projects
      description: >-
        List a workspace's projects in sidebar order, each with rollup task
        statistics. Archived projects are excluded unless includeArchived is
        set.
      operationId: listProjects
      parameters:
        - schema:
            type: string
          required: true
          name: workspaceId
          in: query
        - schema:
            type: string
            description: Pass "true" to include archived projects in the list.
          required: false
          description: Pass "true" to include archived projects in the list.
          name: includeArchived
          in: query
      responses:
        '200':
          description: List of projects
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ProjectListItem'
        '400':
          description: Workspace ID could not be determined
          content:
            text/plain:
              schema:
                type: string
        '401':
          description: Missing or invalid credentials
        '403':
          description: No access to the workspace
          content:
            text/plain:
              schema:
                type: string
components:
  schemas:
    ProjectListItem:
      allOf:
        - $ref: '#/components/schemas/Project'
        - type: object
          properties:
            statistics:
              $ref: '#/components/schemas/ProjectStatistics'
            archivedTasks:
              type: array
              items:
                $ref: '#/components/schemas/BoardTask'
              description: Always empty.
            plannedTasks:
              type: array
              items:
                $ref: '#/components/schemas/BoardTask'
              description: Always empty.
            columns:
              type: array
              items:
                $ref: '#/components/schemas/BoardColumn'
              description: Always empty.
          required:
            - statistics
            - archivedTasks
            - plannedTasks
            - columns
    Project:
      type: object
      properties:
        id:
          type: string
        workspaceId:
          type: string
        slug:
          type: string
          description: Short prefix used in task identifiers, e.g. KAN-12.
        icon:
          type:
            - string
            - 'null'
        name:
          type: string
        description:
          type:
            - string
            - 'null'
        createdAt:
          type: string
          format: date-time
        isPublic:
          type:
            - boolean
            - 'null'
          description: >-
            When true the project's board is readable without signing in, via
            /api/public-project/{id}.
        archivedAt:
          type:
            - string
            - 'null'
          format: date-time
          description: Non-null once archived; archived projects are hidden by default.
        position:
          type: number
          description: Sidebar order, ascending.
        lastTaskNumber:
          type: number
          description: >-
            Highest task number issued in this project; the next task gets this
            plus one.
      required:
        - id
        - workspaceId
        - slug
        - icon
        - name
        - description
        - createdAt
        - isPublic
        - archivedAt
        - position
        - lastTaskNumber
    ProjectStatistics:
      type: object
      properties:
        completionPercentage:
          type: number
        totalTasks:
          type: number
        dueDate:
          type:
            - string
            - 'null'
          format: date-time
          description: The soonest due date among the project's open tasks.
      required:
        - completionPercentage
        - totalTasks
        - dueDate
    BoardTask:
      type: object
      properties:
        id:
          type: string
        title:
          type: string
        number:
          type:
            - number
            - 'null'
        description:
          type:
            - string
            - 'null'
        status:
          type: string
        priority:
          type: string
          description: 'One of: no-priority, low, medium, high, urgent.'
        startDate:
          type:
            - string
            - 'null'
          format: date-time
        dueDate:
          type:
            - string
            - 'null'
          format: date-time
        position:
          type:
            - number
            - 'null'
        createdAt:
          type: string
          format: date-time
        userId:
          type:
            - string
            - 'null'
        assigneeName:
          type:
            - string
            - 'null'
        assigneeId:
          type:
            - string
            - 'null'
        assigneeImage:
          type:
            - string
            - 'null'
        projectId:
          type: string
        labels:
          type: array
          items:
            $ref: '#/components/schemas/TaskLabel'
        externalLinks:
          type: array
          items:
            $ref: '#/components/schemas/TaskExternalLink'
      required:
        - id
        - title
        - number
        - description
        - status
        - priority
        - startDate
        - dueDate
        - position
        - createdAt
        - userId
        - assigneeName
        - assigneeId
        - assigneeImage
        - projectId
        - labels
        - externalLinks
    BoardColumn:
      type: object
      properties:
        id:
          type: string
          description: The column slug, same as `slug`.
        slug:
          type: string
        name:
          type: string
        icon:
          type:
            - string
            - 'null'
        isFinal:
          type: boolean
        tasks:
          type: array
          items:
            $ref: '#/components/schemas/BoardTask'
      required:
        - id
        - slug
        - name
        - icon
        - isFinal
        - tasks
    TaskLabel:
      type: object
      properties:
        id:
          type: string
        name:
          type: string
        color:
          type: string
      required:
        - id
        - name
        - color
    TaskExternalLink:
      type: object
      properties:
        id:
          type: string
        taskId:
          type: string
        integrationId:
          type: string
        resourceType:
          type: string
        externalId:
          type: string
        url:
          type: string
        title:
          type:
            - string
            - 'null'
        metadata:
          type:
            - object
            - 'null'
          additionalProperties: {}
          description: >-
            Provider-specific payload, already parsed from the stored JSON
            string.
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
      required:
        - id
        - taskId
        - integrationId
        - resourceType
        - externalId
        - url
        - title
        - metadata
        - createdAt
        - updatedAt
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: API key or session token (Bearer)

````