Projects API

API endpoints for listing and retrieving projects and their tasks.

Pro Feature

Projects group related tasks within a board. The Projects API allows you to list and retrieve project information.

Get Project

Retrieve a specific project by ID.

Endpoint

GET /projects/:id

Parameters

Parameter Type Description
id string Project UUID

Required Scope

read

Response

{
  "project": {
    "id": "660e8400-e29b-41d4-a716-446655440000",
    "name": "Q1 Marketing Campaign",
    "description": "Spring campaign for product launch",
    "board_id": "550e8400-e29b-41d4-a716-446655440000",
    "position": "aaa",
    "num_tasks_open": 5,
    "num_tasks_in_progress": 3,
    "num_tasks_done": 12,
    "num_tasks_total": 20,
    "progress": 0.6,
    "created_at": "2024-01-15T10:35:00Z",
    "updated_at": "2024-01-20T14:45:00Z"
  }
}

Example

curl https://api.kanman.de/v1/projects/660e8400-e29b-41d4-a716-446655440000 \
  -H "Authorization: Bearer km_your_api_token"

Errors

Status Error Description
404 project_not_found Project doesn’t exist or you don’t have access

List Project Tasks

Retrieve all tasks within a specific project.

Endpoint

GET /projects/:id/tasks

Parameters

Parameter Type Description
id string Project UUID

Required Scope

read

Response

{
  "tasks": [
    {
      "id": "770e8400-e29b-41d4-a716-446655440000",
      "label": "Design landing page",
      "status": 2,
      "position": "aaa",
      "description": null,
      "created_at": "2024-01-15T10:40:00Z",
      "updated_at": "2024-01-18T16:30:00Z"
    },
    {
      "id": "770e8400-e29b-41d4-a716-446655440001",
      "label": "Write email copy",
      "status": 1,
      "position": "aab",
      "description": "Draft email sequence for campaign",
      "created_at": "2024-01-16T09:00:00Z",
      "updated_at": "2024-01-20T11:15:00Z"
    },
    {
      "id": "770e8400-e29b-41d4-a716-446655440002",
      "label": "Set up analytics",
      "status": 0,
      "position": "aac",
      "description": null,
      "created_at": "2024-01-17T14:00:00Z",
      "updated_at": "2024-01-17T14:00:00Z"
    }
  ]
}

Example

curl https://api.kanman.de/v1/projects/660e8400-e29b-41d4-a716-446655440000/tasks \
  -H "Authorization: Bearer km_your_api_token"

Project Object

Complete project object structure:

Field Type Description
id string Unique identifier (UUID)
name string Project name
description string Rich text description (nullable)
board_id string Parent board UUID
position string Order position (LexoRank)
num_tasks_open number Count of open tasks (status 0)
num_tasks_in_progress number Count of in-progress tasks (status 1)
num_tasks_done number Count of done tasks (status 2)
num_tasks_total number Total task count
progress number Completion ratio (0.0 to 1.0)
created_at string ISO 8601 timestamp
updated_at string ISO 8601 timestamp

Task Status Values

Value Status Description
0 Open Not started
1 In Progress Currently being worked on
2 Done Completed

Listing Projects

To list all projects, use the Board endpoint:

curl https://api.kanman.de/v1/boards/:boardId/projects \
  -H "Authorization: Bearer km_your_api_token"

See Boards API for details.

Notes

  • Projects API is currently read-only for list/get operations
  • Create/update operations available via Tasks API (tasks are created within projects)
  • Full project CRUD available in the web UI

Last updated: January 1, 0001

Try Kanman